Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "828282ba-1197-4f2f-920d-5e0e599f8813",
"jobs_id": "8de14b5a-ddda-4987-a4e3-8310d3be8b6d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "89afb2d3-b920-4ed5-b490-f9c3c9a0718a",
"_parent_id": "253c60ff-266a-40fb-b1b0-84d88238272c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "56951cbf-e7ec-48df-bbf7-eb27604fb6a0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a4d0e4bf-7591-45f0-a981-1b506335baa2",
"_parent_id": "47da8706-bb3c-4791-b2b7-862e0e80657b",
"root_parent_id": "6676bbfc-931e-4adb-ad9c-9f367272cdc7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e048e15-4604-4328-95fb-f2e8f2023d94",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1e795a18-0fbf-402d-a29e-7552175d5c97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1a449fc-aa40-4642-a44f-4e478686a4d0",
"_parent_code": "sample string 6",
"sales_organization_id": "aa2d7fc3-4f2e-4b2c-b168-cffa70552f65",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00"
},
"equipment_model_id": "988982f3-1a8c-4682-a5ec-4060021a1410",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a2a16d6c-8106-46dd-8037-b93e09ba5dd3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1213fdb0-1b36-49e8-85ca-9dbd77e6dbde",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d6227879-6895-47b7-ac54-410a9b8740f2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cebebf29-7797-4b23-851f-f9a256528b7a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00"
},
"equipment_family_id": "73643ca5-d583-4c2f-8f6a-795e677d1d49",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1e795a18-0fbf-402d-a29e-7552175d5c97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1a449fc-aa40-4642-a44f-4e478686a4d0",
"_parent_code": "sample string 6",
"sales_organization_id": "aa2d7fc3-4f2e-4b2c-b168-cffa70552f65",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00"
},
"date_in_production_since": "2025-03-28T11:24:39.5134389+00:00",
"date_out_of_production_since": "2025-03-28T11:24:39.5134389+00:00",
"date_end_support": "2025-03-28T11:24:39.5134389+00:00",
"sales_organization_id": "d7ca1716-f8e7-4e66-af1d-ce8d801ae7ca",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00"
},
"project_status_id": "2df61ab4-28bd-4b5e-ba03-e9ee7542c523",
"project_status_code": "sample string 10",
"project_status": {
"id": "6d689f9c-8500-4d3e-84da-51086ce8f9dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fec1be93-3785-4379-a2b4-503b9d738254",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00"
},
"company_id": "2e4a24e2-71da-431c-aee2-163f7b3600cb",
"company_code": "sample string 12",
"db_address_id": "efe0ea31-23f3-4133-afe5-d6d408c53897",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "049586b6-7667-49dc-b901-6b71892a785a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d7d7fc9-f923-4a6d-86c1-a5ced7fbbde3",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2025-03-28T11:24:39.5134389+00:00",
"date_create": "2025-03-28T11:24:39.5134389+00:00",
"date_update": "2025-03-28T11:24:39.5134389+00:00",
"updated_by_user_id": "d69ddc10-e54b-439d-a116-8b2d3b4acc80",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-28T11:24:39.5134389+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2025-03-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-28T11:24:39.5134389+00:00",
"date_last_job": "2025-03-28T11:24:39.5134389+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-28T11:24:39.5134389+00:00",
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00",
"is_mobile_installation": true
},
"job_type_id": "b907060c-e3bd-464d-89c8-c059e371697a",
"job_type_code": "sample string 7",
"job_type": {
"id": "77c91d69-d0db-4fb2-aed4-6cab43ba694d",
"name": "sample string 2",
"sales_organization_id": "b2e3c7f8-9b37-4b88-a4b2-aec31c0e75e2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00",
"code": "sample string 7"
},
"job_priority_id": "fde3652f-9c78-4285-8b3f-6be662ab3f9e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f4b5ad8-777e-4074-8c20-d5a09b4f3632",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0579b730-8d97-4a9c-ac9a-dadb37bbe96b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T11:24:39.5134389+00:00"
},
"job_status_id": "4d14ee86-6db4-427c-bc79-50f877300287",
"job_status_code": "sample string 11",
"db_address_id": "be71292c-4e83-422c-8211-a6fbc402cfcb",
"contact_id": "cc72d322-5a8f-455b-b3ec-ebd87c62adc0",
"requested_by_company_id": "9021475a-7e35-43aa-805b-92dda448d111",
"requested_by_contact_id": "9c6a919a-4d16-43d8-b648-d1a2dac88e1f",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2025-03-28T11:24:39.5134389+00:00",
"due_date": "2025-03-28T11:24:39.5134389+00:00",
"date_create": "2025-03-28T11:24:39.5134389+00:00",
"date_update": "2025-03-28T11:24:39.5290658+00:00",
"date_closed": "2025-03-28T11:24:39.5290658+00:00",
"suggested_user_id": "02768186-6494-45a3-bd38-a93fafaa73c3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "66b227c2-3882-460e-9080-24d69e3efd54",
"db_language_id": "488bab0d-0d4b-4fe4-a795-7e729df05c41",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2025-03-28T11:24:39.5290658+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a4721a7a-4406-4428-99d5-d9745e5dd259",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "46d87bf5-7c11-4284-8f2e-f312852e0f6f",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "238ce7b1-6b5a-4de3-b618-fb0acb5b7ddc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-28T11:24:39.5290658+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "844405d9-3729-45de-a3bb-b15945253789"
},
"suggested_date_start": "2025-03-28T11:24:39.5290658+00:00",
"skill_id": "ed46d467-37d8-4fc0-9a48-20ea12edacfc",
"skill_code": "sample string 32",
"skill": {
"id": "9c1e4063-8a89-498a-a48f-b6fa3e4d0db5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6f4da9a3-1371-4609-9f61-16713c78b468",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e585084-dd63-47e2-a32f-012384c51761",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16397e12-f672-4d82-81cd-357b483c199b",
"db_currency_id": "96ea6b36-5b90-4032-9296-458b6a451432",
"db_language_id": "8796faf7-e8fb-4a9d-aa21-b6334e9e85e3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-03-28T11:24:39.4978125+00:00"
},
"modified_dateutc": "2025-03-28T11:24:39.5290658+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "940aeae1-d9ae-416f-ae8e-c1f3d5340878",
"date_reported_by_company": "2025-03-28T11:24:39.5290658+00:00",
"id2": 36,
"company_id": "c4ded615-acd8-48ee-91e0-c915c70822fb",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "dd50eee3-1a39-493f-87dd-d3222df00ef4",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2025-03-28T11:24:39.5290658+00:00"
},
"work_instruction_details_id": "0592ced1-7fb7-48f4-bc64-81e140a0cf25",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "88580ed3-7df7-4f3a-bb91-84cb6d470135",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "85be2f4f-5e57-4c69-9bda-16bee9f843a8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-28T11:24:39.5290658+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "83f7d3d0-adf1-4571-9cc0-60dc6c06ae4c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-28T11:24:39.5290658+00:00"
}