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": "61743253-5e1b-4457-9df0-607d63a66a34",
"jobs_id": "44dc2b44-c69c-45f3-ba06-187ccf4769ca",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "891e752a-25ed-4085-b3ef-d1ca4fc860f9",
"_parent_id": "8f25882c-0564-4b89-8e14-293155970c97",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "37b572ec-d205-43e3-8b6a-6487d0d088f8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7b295752-bf32-4a25-8898-d4d3123bdbfe",
"_parent_id": "c9fc90cd-3dfe-4c74-ae05-bfc3c0b84983",
"root_parent_id": "37e0c99c-70aa-40e8-b240-b47535cddd2a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "85617873-df94-47d1-b46b-a60d67e2af2a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "33130d90-3377-43d7-b842-9a8838d8d186",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0e84f665-9e79-4a13-9639-839b29683713",
"_parent_code": "sample string 6",
"sales_organization_id": "8c8554b1-26d7-4249-b229-55b9c9ec9080",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+00:00"
},
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00"
},
"equipment_model_id": "1d36ab4a-0ebc-4af2-a36b-ae8d63dc96d7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b02643e8-9f25-4618-8626-7139bc855972",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "507aee97-548a-4916-8bfc-963601f9f477",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3b386876-1296-4400-bf71-3f468136fc4c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7f373170-4530-42bb-a148-f3cabe55457a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+00:00"
},
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00"
},
"equipment_family_id": "2e0b6813-5af6-430b-910c-0b854daa17af",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "33130d90-3377-43d7-b842-9a8838d8d186",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0e84f665-9e79-4a13-9639-839b29683713",
"_parent_code": "sample string 6",
"sales_organization_id": "8c8554b1-26d7-4249-b229-55b9c9ec9080",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+00:00"
},
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00"
},
"date_in_production_since": "2026-04-17T05:51:40.7126345+00:00",
"date_out_of_production_since": "2026-04-17T05:51:40.7126345+00:00",
"date_end_support": "2026-04-17T05:51:40.7126345+00:00",
"sales_organization_id": "c02991ab-faca-4bc5-a02d-007901fabfa4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+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-04-17T05:51:40.7126345+00:00"
},
"project_status_id": "43ddffbf-2927-45cf-8ac4-804679351bc2",
"project_status_code": "sample string 10",
"project_status": {
"id": "141c48b0-d404-4d05-a31a-1ebc770944ce",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4aa127a4-570c-428a-9c9f-a990b2b98a31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00"
},
"company_id": "b1c44ae0-8b8c-42f8-974b-71dacb2984ce",
"company_code": "sample string 12",
"db_address_id": "798534a7-636b-4b15-86ed-f7c37c11165e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7f40d9e3-9c4f-4136-8c5a-9969e52c1cfc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c20748d2-8aef-4e81-a3a8-1310689a7d52",
"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-04-17T05:51:40.7126345+00:00",
"date_create": "2026-04-17T05:51:40.7126345+00:00",
"date_update": "2026-04-17T05:51:40.7126345+00:00",
"updated_by_user_id": "02cec00d-ed15-46c5-a0d0-e5fdd2a4b0fc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-17T05:51:40.7126345+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-04-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-17T05:51:40.7126345+00:00",
"date_last_job": "2026-04-17T05:51:40.7126345+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-17T05:51:40.7126345+00:00",
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00",
"is_mobile_installation": true
},
"job_type_id": "c08bdb64-8ae9-4ead-af72-eaf3b60c8f07",
"job_type_code": "sample string 7",
"job_type": {
"id": "4c392258-79b2-4a0b-a97d-308d202d0ffd",
"name": "sample string 2",
"sales_organization_id": "a718b93e-f3eb-4d7a-b35e-2c72de9aadab",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00",
"code": "sample string 7"
},
"job_priority_id": "81609665-eccd-446d-b66f-8397494840f9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "38fe7331-f300-4670-9bfe-312e5ac5d179",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "52ba3db0-37d2-44c6-816c-efdf9d40ea7c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00"
},
"job_status_id": "90a90084-5ad8-4d19-ada4-e8e0bde6881d",
"job_status_code": "sample string 11",
"db_address_id": "b33662b7-781f-451d-a255-184c332c99c9",
"contact_id": "9a164b78-39cd-4177-8591-4ee9a70cbbbf",
"requested_by_company_id": "ebe88862-dddc-4381-947b-8af4e4181c94",
"requested_by_contact_id": "8c3a1fa1-c75a-4ab8-9028-0f60da9f1584",
"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-04-17T05:51:40.7126345+00:00",
"due_date": "2026-04-17T05:51:40.7126345+00:00",
"date_create": "2026-04-17T05:51:40.7126345+00:00",
"date_update": "2026-04-17T05:51:40.7126345+00:00",
"date_closed": "2026-04-17T05:51:40.7126345+00:00",
"suggested_user_id": "c7045bd6-e486-40ab-8daa-550ce7f48d49",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5480545b-43b9-47b4-8cd8-3c40c5daaaf5",
"db_language_id": "c85665ef-ccf6-4484-adfb-8a3330137f38",
"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-04-17T05:51:40.7126345+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "84ac6a53-87a7-445f-9d53-67b9e665eca9",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2958c515-6d7a-4193-9a7c-e2e200cad767",
"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": "6b7956f7-c195-42cd-bf4d-3623a0332a90",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0e31a498-aa13-421b-930c-c1b3c275edfa"
},
"suggested_date_start": "2026-04-17T05:51:40.7126345+00:00",
"skill_id": "85a6ac02-a2c2-42e1-a4e8-57f59d6a511b",
"skill_code": "sample string 32",
"skill": {
"id": "7bf8b1ff-2086-4ad7-932b-04b9a4bbb354",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "76c75037-db0f-467a-a292-84a6abafeb23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46ad9286-1112-4d00-844d-e165e3b8b455",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de97ac8-1c89-401b-a870-e8c159afc11c",
"db_currency_id": "cdb1df7c-c84e-4916-8707-13aa61802ecb",
"db_language_id": "5b3cf7ce-95af-4b3a-bd70-7bb7d93ca1df",
"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-04-17T05:51:40.7126345+00:00"
},
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f289485d-f1ec-4b1e-94f3-9d39fcd75804",
"date_reported_by_company": "2026-04-17T05:51:40.7126345+00:00",
"id2": 36,
"company_id": "99d64c1d-7bcb-47ba-807a-96fff711fff3",
"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": "89385d08-3914-43de-8420-7500f51dc31f",
"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-04-17T05:51:40.7126345+00:00"
},
"work_instruction_details_id": "200337ef-54e3-458f-8f3f-6d3441fd7564",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "55e7206b-4aec-43cd-8c5a-6c179e4027c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "90d81660-c2db-4ba7-a91c-adf63c5bbe86",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-17T05:51:40.7126345+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": "c2d1ebea-1d7a-4217-b9a5-5186cff69937",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-17T05:51:40.7126345+00:00"
}