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": "d0b5bc57-f63b-42a1-b38e-e8f9f417b6e7",
"jobs_id": "8a5d5c75-1b24-460d-9dca-5ef45cd2dc3c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fae5004d-8139-465a-83ab-cef295133a71",
"_parent_id": "aac0ef96-0e56-45db-98b9-0c63361fe844",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "104858fa-fe92-434f-b110-61fb90891566",
"project_reference_back_office": "sample string 5",
"project": {
"id": "45cb2ba8-4b57-4162-bc33-c7ede4f12dc9",
"_parent_id": "b8847cb1-3e98-4f9a-8317-a64b53767d64",
"root_parent_id": "f07fe092-c11c-45ae-a9ec-03e2f47a1de4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c0ff8e6b-2e12-4b92-9d92-725ae5770486",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3429138f-bb54-4738-8614-37329c99cac4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a454025b-afe1-40f4-a626-d0c55dcd7c61",
"_parent_code": "sample string 6",
"sales_organization_id": "ff96a46e-7d19-4fe1-a526-099e881a9e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+00:00"
},
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00"
},
"equipment_model_id": "7f59c7d5-c139-41d4-b8e5-65691d0a5592",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c3c9a60-1e2e-4be7-b543-45d6c673de46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dfb0b98a-4cbb-4084-a96b-66083698f862",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "97f2070a-d713-469e-8322-0d468992cf33",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e39dcaba-f061-448e-95e4-eeaeb99bc40c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+00:00"
},
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00"
},
"equipment_family_id": "c4bac66a-285d-4892-8830-297cd0d35de9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3429138f-bb54-4738-8614-37329c99cac4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a454025b-afe1-40f4-a626-d0c55dcd7c61",
"_parent_code": "sample string 6",
"sales_organization_id": "ff96a46e-7d19-4fe1-a526-099e881a9e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+00:00"
},
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00"
},
"date_in_production_since": "2025-12-26T08:23:08.2470196+00:00",
"date_out_of_production_since": "2025-12-26T08:23:08.2470196+00:00",
"date_end_support": "2025-12-26T08:23:08.2470196+00:00",
"sales_organization_id": "594ab83d-138a-4e48-b6a4-cb7efcbf8ca3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+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-12-26T08:23:08.2470196+00:00"
},
"project_status_id": "f6f08755-a0e0-4d27-816a-033213688ec0",
"project_status_code": "sample string 10",
"project_status": {
"id": "d77e7e47-0de9-4e3b-bc20-dde0bd015de7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7f83735c-2725-44b1-8d1f-1f34658aba3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00"
},
"company_id": "2cdf2342-a4a0-4f26-ab2e-7ee5c7419fb8",
"company_code": "sample string 12",
"db_address_id": "571cc598-20e7-449e-9fde-bd6c009af772",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5e3353e3-e199-4c20-a69c-e3e0716aaea0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4cfb7b0b-ff3c-436c-bb32-64b44d08165e",
"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-12-26T08:23:08.2470196+00:00",
"date_create": "2025-12-26T08:23:08.2470196+00:00",
"date_update": "2025-12-26T08:23:08.2470196+00:00",
"updated_by_user_id": "230eb0de-c056-401a-aad5-75b29864d290",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-26T08:23:08.2470196+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-12-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-26T08:23:08.2470196+00:00",
"date_last_job": "2025-12-26T08:23:08.2470196+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-26T08:23:08.2470196+00:00",
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00",
"is_mobile_installation": true
},
"job_type_id": "accdecbb-b63d-463d-801c-cbb42694238e",
"job_type_code": "sample string 7",
"job_type": {
"id": "e3620a45-86c9-4e8a-98f2-52cc94bcdc04",
"name": "sample string 2",
"sales_organization_id": "4d319bac-96f0-437f-b30e-81e4373ee529",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00",
"code": "sample string 7"
},
"job_priority_id": "e28f2a16-6ecf-4791-824b-a7ee57e0def0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2ff362b6-97ab-4ea8-80d1-229d1579577d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "23bffe30-7cae-4d59-bdbf-3397bf974690",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00"
},
"job_status_id": "4591c95a-8549-47f0-bf21-37eb5c02a051",
"job_status_code": "sample string 11",
"db_address_id": "73284a6b-3a6f-4bb3-8e18-43bbe633fd21",
"contact_id": "4d29e858-cd8e-41eb-85af-7db0857c373a",
"requested_by_company_id": "a2160793-4ea7-4e0e-8e0e-3ef0306bb070",
"requested_by_contact_id": "75b50dbc-4740-4cd5-8622-52da228d8358",
"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-12-26T08:23:08.2470196+00:00",
"due_date": "2025-12-26T08:23:08.2470196+00:00",
"date_create": "2025-12-26T08:23:08.2470196+00:00",
"date_update": "2025-12-26T08:23:08.2470196+00:00",
"date_closed": "2025-12-26T08:23:08.2470196+00:00",
"suggested_user_id": "1d053ead-8689-4997-8a87-d1d5e562486c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "457d79f7-6e79-4c8e-8515-db313bb35569",
"db_language_id": "41ede68f-d399-4807-846b-dadf389e9ae6",
"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-12-26T08:23:08.2470196+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "203a9d50-69b7-4586-aa28-25d7bbc5ebad",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a82ca9bf-6a6c-474b-a53a-04a0c14ede2b",
"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": "23a08f10-ee81-4554-8a7c-fe4ff60d6945",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c47eec28-a00f-4119-bd7f-a33b7c508feb"
},
"suggested_date_start": "2025-12-26T08:23:08.2470196+00:00",
"skill_id": "9aa38371-aa49-4f7a-be8d-6e6c7256d1b7",
"skill_code": "sample string 32",
"skill": {
"id": "7a78e7af-4de2-4f80-a781-032e2b25870a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ec397fb4-060c-4707-84e5-fc84566b6ddb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a822640-2217-4197-8ce7-a7a096edd22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c13823-e3a3-4aa9-9ab0-06942210abb4",
"db_currency_id": "deef3bc0-9429-4006-add9-d0b53418a050",
"db_language_id": "3f7aa9b9-2dbd-4da2-ab97-7023706b016c",
"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-12-26T08:23:08.2470196+00:00"
},
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ec9ff594-1b88-474c-b29d-a0c5d7d72fc2",
"date_reported_by_company": "2025-12-26T08:23:08.2470196+00:00",
"id2": 36,
"company_id": "e3c896d4-38fb-481b-9183-874447409040",
"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": "2fdefe25-17be-4234-b44b-2ddb5c4e029c",
"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-12-26T08:23:08.2470196+00:00"
},
"work_instruction_details_id": "ef2b9615-ad88-4b75-a522-a565d319a7b6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "735a4cc7-b9d8-4660-9f66-3c424ae1e737",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3ca5522f-b80e-4ecc-8f31-d9e560a06cf6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-26T08:23:08.2470196+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": "9f0d7289-8de7-46cd-adfa-1d14c8e9cd4b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-26T08:23:08.2470196+00:00"
}