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": "a39e62af-be39-4f79-8e3e-7ac2ad90babf",
"jobs_id": "1f61d794-95fc-4760-af16-1648fbe4c88f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3a0027fe-9151-41b5-8656-9a1169e73482",
"_parent_id": "2b204975-9701-4eea-9a20-ffc179749e5c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7e73ecc8-fe90-4621-926c-4a9aaf30f378",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6d551b92-016e-4a2e-93a0-33918bc09d4d",
"_parent_id": "035c95f5-d03a-4712-a632-36535e58bdee",
"root_parent_id": "92674c6c-a93b-41ba-891a-4b6b1cf550cb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f7a66429-9b0a-46c2-9273-7d6fc2e6ecd7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "46fd2c72-d04c-49f2-b10d-9045e3712088",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "767949da-9cc1-47e3-80ae-38b4f65e82ba",
"_parent_code": "sample string 6",
"sales_organization_id": "95aa742f-1c59-4dca-9597-77bce7337350",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00"
},
"equipment_model_id": "e1a9c1dd-630e-4655-b17f-12c36f896e36",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "02d3b86a-23ac-4521-899e-9715f3185f8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "aeeced43-8824-4166-84ae-0a060a60317a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6685e55c-99f4-4fd0-aa51-b659901432ec",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1746c3dc-0618-449c-bebb-8eed4447a96c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00"
},
"equipment_family_id": "611bf6fb-882a-4bb7-b02d-fb98e27e7598",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "46fd2c72-d04c-49f2-b10d-9045e3712088",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "767949da-9cc1-47e3-80ae-38b4f65e82ba",
"_parent_code": "sample string 6",
"sales_organization_id": "95aa742f-1c59-4dca-9597-77bce7337350",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00"
},
"date_in_production_since": "2026-07-07T07:22:20.1649442+00:00",
"date_out_of_production_since": "2026-07-07T07:22:20.1649442+00:00",
"date_end_support": "2026-07-07T07:22:20.1649442+00:00",
"sales_organization_id": "bddfc7ec-3f29-4bce-992a-e01a5fff5e9a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+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": "2026-07-07T07:22:20.1649442+00:00"
},
"project_status_id": "05ffd2cd-ebe3-4f5c-8caa-9f94b02e695b",
"project_status_code": "sample string 10",
"project_status": {
"id": "49b6b133-feaf-4307-99f3-3c4ef2a73037",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cf6d57bc-a047-4dfc-9736-af1ef3455a0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00"
},
"company_id": "6576bdda-6c97-4cc6-a24d-f7ac8be185ba",
"company_code": "sample string 12",
"db_address_id": "ab469690-4120-4555-9a10-51fb18137ec5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "445c0725-44bb-49d4-9007-f56f120c7ce8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "266d0493-8088-4fb2-beea-a48500fd8a3e",
"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": "2026-07-07T07:22:20.1649442+00:00",
"date_create": "2026-07-07T07:22:20.1649442+00:00",
"date_update": "2026-07-07T07:22:20.1649442+00:00",
"updated_by_user_id": "991f4d59-7ab0-4aee-a93c-3a46ef204621",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-07T07:22:20.1649442+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": "2026-07-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-07T07:22:20.1649442+00:00",
"date_last_job": "2026-07-07T07:22:20.1649442+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-07T07:22:20.1649442+00:00",
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00",
"is_mobile_installation": true
},
"job_type_id": "a2b1ec4a-533b-4f33-bb47-da3528b4a1db",
"job_type_code": "sample string 7",
"job_type": {
"id": "6dbb6be8-5e6a-495f-b407-73a82b50b474",
"name": "sample string 2",
"sales_organization_id": "027da74f-bc4a-491a-bf24-e6127542704c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00",
"code": "sample string 7"
},
"job_priority_id": "8f5f7c9e-270b-4230-b161-48dd875e32bb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4e07d508-422f-49c8-a6e2-eb10eb71e698",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "588157a4-3b18-4047-bcd2-78d4a552bd40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00"
},
"job_status_id": "c070280b-154b-49f4-b87f-650b305d2612",
"job_status_code": "sample string 11",
"db_address_id": "a0598a16-3866-4aff-8993-9abf2c04ffdf",
"contact_id": "2dcee2d9-533a-4f76-b622-a4063973463a",
"requested_by_company_id": "47b5df62-a259-45f0-be72-3ed11c09e7d0",
"requested_by_contact_id": "a296ba66-0adb-467d-bfb6-84cb52f8e41a",
"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": "2026-07-07T07:22:20.1649442+00:00",
"due_date": "2026-07-07T07:22:20.1649442+00:00",
"date_create": "2026-07-07T07:22:20.1649442+00:00",
"date_update": "2026-07-07T07:22:20.1649442+00:00",
"date_closed": "2026-07-07T07:22:20.1649442+00:00",
"suggested_user_id": "36e75668-f817-40ca-a639-6131756839da",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c10b8b6c-a574-4d66-8cc6-8d086e5d9d3a",
"db_language_id": "ef166137-f403-426a-9183-998034d0bc24",
"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": "2026-07-07T07:22:20.1649442+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "acfb96a3-c2d4-4b95-bb87-edd576980864",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2a31d94b-2127-4b67-b3b2-cc64736f5a15",
"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": "828740d4-2f3d-4a70-a19b-6dc60dd57b72",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5e24f6db-6436-4fbf-95b3-eee265ae87bc"
},
"suggested_date_start": "2026-07-07T07:22:20.1649442+00:00",
"skill_id": "a54f5e51-e952-40de-85e9-fd81fa2814e8",
"skill_code": "sample string 32",
"skill": {
"id": "d9837097-d446-41a3-a1fc-34c59df09a96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e47d32b3-b3d2-47fa-b2f9-68b91a175ab0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf4201dd-346f-41b5-9ec8-396518ac297b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7a67608-fb10-42df-90e1-53b2e0e212f2",
"db_currency_id": "1db166a7-5103-48f7-a010-959afc2b4b48",
"db_language_id": "e2a4ba8d-af22-4939-84a7-ac3feae8c4ca",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f810414a-abba-4d9e-b158-17f5a1bf264a",
"date_reported_by_company": "2026-07-07T07:22:20.1649442+00:00",
"id2": 36,
"company_id": "23172074-e9c1-451d-98df-db3d68a3c436",
"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": "9e0ab3d7-2ba5-4d81-b845-464cbe1448df",
"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": "2026-07-07T07:22:20.1649442+00:00"
},
"work_instruction_details_id": "61ea92dc-852c-4a4e-8da8-f4de7200ceb0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "edcaea55-0bb0-49d3-b5b2-ab00d93aa9b3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fc4dd9d1-6a02-4f8b-9e05-238276ea1500",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-07T07:22:20.1649442+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": "63f420ec-94f4-4747-a6d4-ab27947d2985",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-07T07:22:20.1649442+00:00"
}