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": "5ce2f4c6-f65c-4bb7-b90d-a558bfdc48f7",
"jobs_id": "90f7e940-01e8-4b95-b286-61bf2d42460d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "66cdd7c1-dda9-479c-8cdd-d84cb02aa947",
"_parent_id": "08a7fc4f-aee6-40de-b1d5-a31236ae9053",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "21ac4332-faeb-484d-b033-fc74830e4098",
"project_reference_back_office": "sample string 5",
"project": {
"id": "022a8d54-ab64-4b58-9edb-e5b3f21241e9",
"_parent_id": "0a8310de-50e6-4c7c-ac23-ed567e995317",
"root_parent_id": "b944c635-c882-4f9c-a493-f10b46bd6ef7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f8565260-8f0e-49d9-b008-aa1bdbe1fdcf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3bb691df-374a-4ac6-adee-3e9c6c60cb8c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67173fc2-cbe3-4a82-b379-488e431ca2ed",
"_parent_code": "sample string 6",
"sales_organization_id": "9c506335-0522-4576-8923-4fd44ced0d38",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+00:00"
},
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00"
},
"equipment_model_id": "3c6449a7-f29d-46c6-8aa9-fe3461a59486",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "83e0ee28-bff9-4d06-b9ca-e2f5c4c5a653",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9b565736-d4ea-4cb2-a699-c5970b38e919",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "26b83b6c-e7b0-4bb7-ab36-00f5d424cc3f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d5a66944-f3f7-4446-8bca-44779fbcdf40",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+00:00"
},
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00"
},
"equipment_family_id": "533d3535-5a87-43c2-b57c-b8299b6e2b65",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3bb691df-374a-4ac6-adee-3e9c6c60cb8c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67173fc2-cbe3-4a82-b379-488e431ca2ed",
"_parent_code": "sample string 6",
"sales_organization_id": "9c506335-0522-4576-8923-4fd44ced0d38",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+00:00"
},
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00"
},
"date_in_production_since": "2026-09-05T18:24:55.1501945+00:00",
"date_out_of_production_since": "2026-09-05T18:24:55.1501945+00:00",
"date_end_support": "2026-09-05T18:24:55.1501945+00:00",
"sales_organization_id": "e5eaf574-3ef0-49ab-86af-c503ce50ae3e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+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-09-05T18:24:55.1501945+00:00"
},
"project_status_id": "685d644f-6ffb-4c13-9a06-c3096c2c361f",
"project_status_code": "sample string 10",
"project_status": {
"id": "01d52e76-d852-494d-8b60-3036e892ceec",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b3d4f814-d2fe-4c98-a0f3-d81efcc1a632",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00"
},
"company_id": "0c82cbc6-152f-4d9b-a9e4-78cf6de35273",
"company_code": "sample string 12",
"db_address_id": "b2176810-0573-4618-b8fe-2789285fb5f4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9c395393-c62a-4373-9d3f-ad40359e23c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "49281255-9521-403e-9986-0a15f885ae65",
"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-09-05T18:24:55.1501945+00:00",
"date_create": "2026-09-05T18:24:55.1501945+00:00",
"date_update": "2026-09-05T18:24:55.1501945+00:00",
"updated_by_user_id": "c60dc1ac-ff16-4593-93fe-97a22c7b1e62",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-05T18:24:55.1501945+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-09-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-05T18:24:55.1501945+00:00",
"date_last_job": "2026-09-05T18:24:55.1501945+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-05T18:24:55.1501945+00:00",
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00",
"is_mobile_installation": true
},
"job_type_id": "536abd9f-2378-4ff8-bb9e-1917e288e029",
"job_type_code": "sample string 7",
"job_type": {
"id": "b34b6b27-ccf5-49af-98e3-1bc8ff83dcd5",
"name": "sample string 2",
"sales_organization_id": "c64fa049-ba42-42cb-8669-65b442f874cd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00",
"code": "sample string 7"
},
"job_priority_id": "23d3b6f1-db34-40d9-a71f-705ec62cc4b6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b8213292-4556-4756-8374-f9bf9d5bbcb4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2e779757-bea2-44d4-afd8-2281d829a9a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00"
},
"job_status_id": "ed222574-6a54-4264-9544-ccfdd4ef6e66",
"job_status_code": "sample string 11",
"db_address_id": "b439b152-6ff5-4428-968f-1a0dd26d0190",
"contact_id": "ea0c0557-50c2-4b07-8f98-1610f836ed0b",
"requested_by_company_id": "00708819-0a4f-4240-b809-31eb4ea40d6e",
"requested_by_contact_id": "ef74c606-8367-4e25-b056-351aacb56bde",
"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-09-05T18:24:55.1501945+00:00",
"due_date": "2026-09-05T18:24:55.1501945+00:00",
"date_create": "2026-09-05T18:24:55.1501945+00:00",
"date_update": "2026-09-05T18:24:55.1501945+00:00",
"date_closed": "2026-09-05T18:24:55.1501945+00:00",
"suggested_user_id": "759aae0b-af2f-436f-95b8-7537ce41774f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d3bc43e1-97de-448f-8e0b-259fe186fe5f",
"db_language_id": "ef6ea91b-36ac-4ac0-892c-c807d818eb9b",
"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-09-05T18:24:55.1501945+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4957ee34-b279-432a-83db-57844bf01343",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e06e3d4a-7dd8-4d39-ae71-f10da8cbae19",
"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": "21cba548-5b52-4d28-9907-7a66e86fccbb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a38d1497-29b7-444b-a09e-46526a520dc2"
},
"suggested_date_start": "2026-09-05T18:24:55.1501945+00:00",
"skill_id": "e900a8a7-d6a4-4a80-ac64-351b48c95a34",
"skill_code": "sample string 32",
"skill": {
"id": "3e463fe9-845d-4171-b25b-3145574c1236",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e6135a4b-7cf4-42f3-95cb-9167c66d41e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cec25187-5372-4611-9f3b-169783da17bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0282c5-124d-4051-9eb0-050b25e8ee91",
"db_currency_id": "9d6960c7-8935-440d-8be0-75e71fa5d977",
"db_language_id": "6fa524f3-256b-421e-b9f0-f896a44f3f7a",
"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-09-05T18:24:55.1501945+00:00"
},
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "edf1f3ac-1ac8-458c-b7d8-74c3aea09b09",
"date_reported_by_company": "2026-09-05T18:24:55.1501945+00:00",
"id2": 36,
"company_id": "814b4341-a2f4-44a2-8dd2-74eb662b2f69",
"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": "0258426d-774e-4a8a-8964-35b5beb1db88",
"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-09-05T18:24:55.1501945+00:00"
},
"work_instruction_details_id": "dd013d59-8ff9-4a01-b925-0aaba2a89c67",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d639f8f5-95b1-488a-ae34-0a3d850f7e02",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d5069f8b-f084-419e-8ab2-b8c61cb865da",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-05T18:24:55.1501945+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": "1da5c794-39e0-42ec-9a59-cf2b5c269556",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-05T18:24:55.1501945+00:00"
}