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": "c89a619f-b21d-4e6f-9b1d-16e2c4c77f43",
"jobs_id": "e7a9ced3-8dfc-45b9-87ec-bc3f95ed6180",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f935858b-7d15-45d1-af01-49163f030c65",
"_parent_id": "a9a474f3-29ba-4225-a822-b60cf0322c59",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "420ad46d-cc9b-449d-bf88-be2bc9cba5c6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "266e851f-3aa3-4282-9fd1-d77e2c313784",
"_parent_id": "8f2037d0-09f8-4716-915b-b1d662488043",
"root_parent_id": "dc1767dc-8fa5-40db-8ccb-0574e8335cb7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "998a11f3-77a1-4694-a7d4-ed34708a00f5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a425d404-7b5c-4889-9d0b-c68034593ad2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13482268-f4b2-43c7-9900-e01366a212fd",
"_parent_code": "sample string 6",
"sales_organization_id": "9024949d-61ac-4014-935b-55fc23c17f4b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+00:00"
},
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00"
},
"equipment_model_id": "93538e1b-dd1e-4afa-8016-b542c2b8f316",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a2d4598b-6217-410d-aa8f-f23c88c1f23b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0179c70e-61c2-4c33-93d6-405fb7ff7df1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c6cc58c2-f19e-42dd-bcfb-01c2ffbdeca4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1eceb773-c497-4673-9f35-9e7826d0caef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+00:00"
},
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00"
},
"equipment_family_id": "c794ef43-a572-4a56-92f2-2eb3e22ea306",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a425d404-7b5c-4889-9d0b-c68034593ad2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13482268-f4b2-43c7-9900-e01366a212fd",
"_parent_code": "sample string 6",
"sales_organization_id": "9024949d-61ac-4014-935b-55fc23c17f4b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+00:00"
},
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00"
},
"date_in_production_since": "2025-12-17T21:17:31.8859685+00:00",
"date_out_of_production_since": "2025-12-17T21:17:31.8859685+00:00",
"date_end_support": "2025-12-17T21:17:31.8859685+00:00",
"sales_organization_id": "2f5e14bf-f7ea-4393-b104-1181316c9f75",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+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-17T21:17:31.8859685+00:00"
},
"project_status_id": "18ff7af9-0098-4994-8f56-6df0988b6c01",
"project_status_code": "sample string 10",
"project_status": {
"id": "287c8345-d7d7-4fd1-9eae-4c1045cee4bc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8a4a2f48-30f2-48a8-9d6e-846c1c907eb5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00"
},
"company_id": "e735759f-eb61-42a7-a8d8-01aebe390c3b",
"company_code": "sample string 12",
"db_address_id": "9992845a-eff7-454f-83f2-e73b185dc396",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e45707a6-96b2-4d7b-a770-a9959f702d7e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "43c876bb-4721-40b7-91e5-ec08745660f7",
"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-17T21:17:31.8859685+00:00",
"date_create": "2025-12-17T21:17:31.8859685+00:00",
"date_update": "2025-12-17T21:17:31.8859685+00:00",
"updated_by_user_id": "9ab38a38-797c-4fce-a37a-768b161fd1a4",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-17T21:17:31.8859685+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-17T21:17:31.8859685+00:00",
"date_last_job": "2025-12-17T21:17:31.8859685+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-17T21:17:31.8859685+00:00",
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00",
"is_mobile_installation": true
},
"job_type_id": "5c16b8bf-e3a3-4d81-afb1-e4a49131c433",
"job_type_code": "sample string 7",
"job_type": {
"id": "e4a2ab86-4cdd-441a-9b0e-8606d43ff004",
"name": "sample string 2",
"sales_organization_id": "71c3aadc-1cdb-4fcd-841c-ddcc32c7d6b0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00",
"code": "sample string 7"
},
"job_priority_id": "74d5e17d-07c7-4909-9bf4-9b09ccf91614",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d9ace9ec-5b28-4c79-bb2c-5d9ea5eaef2e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "715df252-75df-4a4f-be3f-d1277ad8a1cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00"
},
"job_status_id": "8a05b6ee-8132-4779-a051-a8bc34c48c30",
"job_status_code": "sample string 11",
"db_address_id": "74fcf4ed-74be-4fb4-a79a-073f1d674e42",
"contact_id": "cc565364-499e-4d58-ba77-c9c224c2a59b",
"requested_by_company_id": "1e4f7ba6-363e-4226-b5a6-a8eec888d59f",
"requested_by_contact_id": "32a8b253-b55b-44e1-9caa-3d57b4cf45a0",
"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-17T21:17:31.8859685+00:00",
"due_date": "2025-12-17T21:17:31.8859685+00:00",
"date_create": "2025-12-17T21:17:31.8859685+00:00",
"date_update": "2025-12-17T21:17:31.8859685+00:00",
"date_closed": "2025-12-17T21:17:31.8859685+00:00",
"suggested_user_id": "9072c69c-e59f-40e9-9875-1cef980bd76d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1b6cd04e-9c40-418c-b21b-a28661567c02",
"db_language_id": "34bc5d8a-18ab-4661-be2a-6f94b80f79e4",
"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-17T21:17:31.8859685+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "df158801-b82d-4208-bf1f-da5e4d1b475b",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "068779dc-2174-4fea-93e5-f0e5457ecb68",
"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": "1252698c-393a-41b3-b487-1443d72634fb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "19fea551-fb56-4558-8b9b-bf308033fee7"
},
"suggested_date_start": "2025-12-17T21:17:31.8859685+00:00",
"skill_id": "493c9902-d94b-45f3-92d9-a56cbe89d011",
"skill_code": "sample string 32",
"skill": {
"id": "49864e81-674a-492d-913d-820d9dedfa8d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7c651561-a5a1-4cf7-8f87-0181dbc4dc2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1de24dd-66cf-417a-b075-8a7446e5478c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d9412e9-91a7-4a02-87b8-6f12c9352a1e",
"db_currency_id": "e8c1a195-b497-47dd-97aa-3693b209babc",
"db_language_id": "6172d17d-0995-47ce-a974-b6168639247e",
"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-17T21:17:31.8859685+00:00"
},
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "52dc8f07-028d-4bd7-a313-f248abc3c07e",
"date_reported_by_company": "2025-12-17T21:17:31.8859685+00:00",
"id2": 36,
"company_id": "18f12640-1ea5-4dd2-99b9-48147356c27c",
"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": "07f54959-a71a-49a5-955b-d4fe69d09cd8",
"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-17T21:17:31.8859685+00:00"
},
"work_instruction_details_id": "fb5f1a8a-f4fb-4d89-8cca-ae2575279aaa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "49adb55c-1269-422e-9932-2a20af512d7c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4d4a884d-5c25-4927-af06-d2685029d2e6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-17T21:17:31.8859685+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": "e250727d-580f-4d3a-ba3e-cb30892a877c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-17T21:17:31.8859685+00:00"
}