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": "fe967bec-a7c5-4668-9d37-afd16fa8e05b",
"jobs_id": "2be66c6e-505d-4391-9d36-741d0553c023",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cf0c37c2-12f6-4975-92d9-e5b105e1174a",
"_parent_id": "dd3207e0-c0ad-409c-adc3-5d7eb5415ce0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c5193e82-a4bc-4042-93d8-953e0c746220",
"project_reference_back_office": "sample string 5",
"project": {
"id": "34e29ed6-6a3a-45ce-a2e3-7d16264920f6",
"_parent_id": "cccc4a21-7cc1-4842-9563-c2453007940c",
"root_parent_id": "990d5de5-bebf-473e-a495-5537a5872056",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f97cd464-b855-47c1-b350-50f1fa026bfa",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d4f2eb4b-9d75-4390-bbe2-550bc6e6a9f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d907c67a-21ad-43e0-b5b8-58cecfacb8cc",
"_parent_code": "sample string 6",
"sales_organization_id": "efe60b0c-eeab-489b-ba79-6d75e2a6238a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+00:00"
},
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00"
},
"equipment_model_id": "fef8c5a2-c03f-4d23-a00f-4f8b707d5786",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a3da007-09ec-4934-a08a-9b699f927942",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7ca3bb81-672c-4dbb-85a2-a7c4cd9b62fb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "55700aa1-9821-4652-9dd5-a2caeab3ebb8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cf6f4ae7-e4e3-4120-afa2-19634164c1bd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+00:00"
},
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00"
},
"equipment_family_id": "33383bd9-d173-4ed8-8062-05c7191057cf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d4f2eb4b-9d75-4390-bbe2-550bc6e6a9f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d907c67a-21ad-43e0-b5b8-58cecfacb8cc",
"_parent_code": "sample string 6",
"sales_organization_id": "efe60b0c-eeab-489b-ba79-6d75e2a6238a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+00:00"
},
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00"
},
"date_in_production_since": "2026-02-18T11:21:02.2397404+00:00",
"date_out_of_production_since": "2026-02-18T11:21:02.2397404+00:00",
"date_end_support": "2026-02-18T11:21:02.2397404+00:00",
"sales_organization_id": "8125cdcf-daff-4474-afb5-74891ce122bb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+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-02-18T11:21:02.2397404+00:00"
},
"project_status_id": "ed24b57a-96a2-493b-af0f-e0c1b3a75de4",
"project_status_code": "sample string 10",
"project_status": {
"id": "2b6ff161-c9ae-479d-83fc-ffe84f14a135",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9f2ea3b0-1a9f-46a6-85a0-6e0cb9c2afac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00"
},
"company_id": "5043acbb-67d5-4efd-8d13-1e376e53bd44",
"company_code": "sample string 12",
"db_address_id": "9e34b33a-6b35-454a-b559-4b0fe08c3d36",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fd9e9572-2aaa-4602-a2a9-1cd7e520fac7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bb7495f0-0416-448e-a1ec-70871c873dcc",
"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-02-18T11:21:02.2397404+00:00",
"date_create": "2026-02-18T11:21:02.2397404+00:00",
"date_update": "2026-02-18T11:21:02.2397404+00:00",
"updated_by_user_id": "a86b738f-6c60-46a3-9bb5-ce4469b2053f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-18T11:21:02.2397404+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-02-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-18T11:21:02.2397404+00:00",
"date_last_job": "2026-02-18T11:21:02.2397404+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-18T11:21:02.2397404+00:00",
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00",
"is_mobile_installation": true
},
"job_type_id": "2efb0a16-6175-47a5-ac6d-dc1af6d7336b",
"job_type_code": "sample string 7",
"job_type": {
"id": "2e9735f3-1b12-4108-8bd2-d34b36acdcf3",
"name": "sample string 2",
"sales_organization_id": "757dea83-aa60-4dea-b2d3-249e3e6e53a5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00",
"code": "sample string 7"
},
"job_priority_id": "c6e63269-d043-4657-9d59-be2a81accfa6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1c494134-e553-4631-9b79-107c11125275",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "037466f3-a58f-4369-a181-ce3e609f5eb6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00"
},
"job_status_id": "289823a0-2ab6-4404-9091-890875afc009",
"job_status_code": "sample string 11",
"db_address_id": "6130187a-3918-43b8-90ea-1fd810e7be35",
"contact_id": "ab18e8d6-4a86-49e8-86b8-51d432ed7948",
"requested_by_company_id": "c1e1880b-5d4b-4b5c-b32f-3d0c0f465491",
"requested_by_contact_id": "ac959c4a-c3b1-4e82-a6c7-c11363228df5",
"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-02-18T11:21:02.2397404+00:00",
"due_date": "2026-02-18T11:21:02.2397404+00:00",
"date_create": "2026-02-18T11:21:02.2397404+00:00",
"date_update": "2026-02-18T11:21:02.2397404+00:00",
"date_closed": "2026-02-18T11:21:02.2397404+00:00",
"suggested_user_id": "4cc2d995-b20c-418a-b861-405dc253a4a5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e42bef13-0760-4d07-87e4-1fa6ed24eb0f",
"db_language_id": "04f50b9d-6439-49ac-b878-dce2b409086b",
"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-02-18T11:21:02.2397404+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "78f70e7b-4195-4db1-9f6b-87731b266df8",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5e43ab3a-237f-4a38-a92b-aac91bcf1be8",
"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": "db76c18f-e3aa-42e2-97a0-a6edf0851910",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f74d38dc-7ee0-4156-b20d-7a21e4182c33"
},
"suggested_date_start": "2026-02-18T11:21:02.2397404+00:00",
"skill_id": "d199d2fd-d23a-43be-86c4-93a9004ef8e0",
"skill_code": "sample string 32",
"skill": {
"id": "ace9ca80-f2fa-430b-9035-253764345d60",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7c7e7ccb-a448-448b-8fa6-a9a4a25475a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dee89afb-2b40-4be9-9111-12d783f1df1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ada5f28-9113-448c-b7ec-f467df9deddc",
"db_currency_id": "151fc631-7dda-484a-b396-04df6524308c",
"db_language_id": "17f56a17-d41a-4d05-98cd-3328f5ccc72c",
"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-02-18T11:21:02.2397404+00:00"
},
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0ef8dd61-d219-4beb-8863-3e9377b2ac93",
"date_reported_by_company": "2026-02-18T11:21:02.2397404+00:00",
"id2": 36,
"company_id": "a55d6291-f121-4d50-b528-26ade9cb1534",
"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": "ee07847b-bf48-43ad-bbc8-a40a68877a14",
"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-02-18T11:21:02.2397404+00:00"
},
"work_instruction_details_id": "b95b5e40-185c-4da1-9138-97df66fc0e95",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "95d0b980-7d7a-4de8-8d28-c91a54d36b28",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "35a41a62-4650-45c2-8b6f-6bd5d8e94f96",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-18T11:21:02.2397404+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": "0ba6f085-03b4-43bf-9648-663d660a2c3f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-18T11:21:02.2397404+00:00"
}