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": "0bfc7222-61f6-4426-8936-2f79ad5a5e14",
"jobs_id": "4b3e2059-1410-4d75-8f0f-b441f2f0ec2b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "17575a16-24d2-4efb-a956-7ae78a87e2a9",
"_parent_id": "3f73fb8c-777e-4836-aab4-e61ced2c6a9d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "95cfccc5-5037-4604-9f8a-9b11e44241c7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6fc85847-3bdd-4225-958b-30335783d8d1",
"_parent_id": "fe3b9623-18ae-4205-92c8-587104929317",
"root_parent_id": "cc117bf6-0fe3-49e0-9130-a3d465b0b3ab",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c34db411-9f58-4a5b-b5be-5f7391661775",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6c699c24-93c9-4193-894f-0b4f90707459",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "851a6026-1b65-480a-8887-7db034151410",
"_parent_code": "sample string 6",
"sales_organization_id": "a0ac3f47-ce9a-4592-8d8c-ededf3e1a4b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+00:00"
},
"modified_dateutc": "2026-10-14T05:36:05.5221573+00:00"
},
"equipment_model_id": "20aa3d42-f4f9-4d7d-ba43-597b2599a088",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "aa921573-039b-484a-9694-57e71998ffbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4278ed3a-e224-46cd-a97b-f207dd4661b3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e07316b6-25e8-405b-b532-8a0c1b277835",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "240c5bff-773b-41e8-acf7-8b7d6aa46d9c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+00:00"
},
"modified_dateutc": "2026-10-14T05:36:05.5324466+00:00"
},
"equipment_family_id": "3a5f1b3d-804b-4b29-9261-5704f8a4311f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6c699c24-93c9-4193-894f-0b4f90707459",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "851a6026-1b65-480a-8887-7db034151410",
"_parent_code": "sample string 6",
"sales_organization_id": "a0ac3f47-ce9a-4592-8d8c-ededf3e1a4b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+00:00"
},
"modified_dateutc": "2026-10-14T05:36:05.5221573+00:00"
},
"date_in_production_since": "2026-10-14T05:36:05.5324466+00:00",
"date_out_of_production_since": "2026-10-14T05:36:05.5324466+00:00",
"date_end_support": "2026-10-14T05:36:05.5324466+00:00",
"sales_organization_id": "4862e560-bfe0-40b2-8ce9-bfe03818cf4e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+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-10-14T05:36:05.5324466+00:00"
},
"project_status_id": "bafc161e-c034-4912-a9d2-1f83ea48910a",
"project_status_code": "sample string 10",
"project_status": {
"id": "15ea90bc-844b-4252-a7e3-a62f6228ad09",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "277edd11-bce0-4d67-8187-d5d1597ebb9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T05:36:05.5324466+00:00"
},
"company_id": "8b98d775-680a-4d5a-b6b8-32dbfc9472fc",
"company_code": "sample string 12",
"db_address_id": "4cb725c4-8a3c-4c64-80f1-b71857dedebb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "43e7e5ef-1268-4ca8-8828-6bcd619b2256",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "df4ac2d3-2314-4456-b079-28e47813d0bc",
"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-10-14T05:36:05.5324466+00:00",
"date_create": "2026-10-14T05:36:05.5324466+00:00",
"date_update": "2026-10-14T05:36:05.5324466+00:00",
"updated_by_user_id": "19978b46-585a-4739-ac1b-40c875926afa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-14T05:36:05.5324466+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-10-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-14T05:36:05.5324466+00:00",
"date_last_job": "2026-10-14T05:36:05.5324466+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-14T05:36:05.5324466+00:00",
"modified_dateutc": "2026-10-14T05:36:05.5324466+00:00",
"is_mobile_installation": true
},
"job_type_id": "8bc94685-e64d-4c56-a5e7-0e1f140e2be6",
"job_type_code": "sample string 7",
"job_type": {
"id": "1c71b15c-e446-4ed1-9ce4-cb5ed4e499bf",
"name": "sample string 2",
"sales_organization_id": "8e1a7394-a8f7-4b66-bc52-c3719b50bd25",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-14T05:36:05.5324466+00:00",
"code": "sample string 7"
},
"job_priority_id": "38a69ec5-3d40-436a-9962-f9854b5b85d9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1a57e125-9f25-4291-bc0b-1a634754f3e0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e067ffb5-df53-4600-ad7f-f12c7932467c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T05:36:05.5519877+00:00"
},
"job_status_id": "c89c95f4-df47-4350-8eac-864576fab37c",
"job_status_code": "sample string 11",
"db_address_id": "2fe985ce-218b-4c95-aaa7-fb458546b114",
"contact_id": "9d320fd4-5eed-4fe2-95df-49c192af2911",
"requested_by_company_id": "eb4da11c-c8a4-4dc5-82e2-ea8bc34e56d0",
"requested_by_contact_id": "eb766672-4ba6-473a-b56e-7965123bdb58",
"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-10-14T05:36:05.5519877+00:00",
"due_date": "2026-10-14T05:36:05.5519877+00:00",
"date_create": "2026-10-14T05:36:05.5519877+00:00",
"date_update": "2026-10-14T05:36:05.5519877+00:00",
"date_closed": "2026-10-14T05:36:05.5519877+00:00",
"suggested_user_id": "2d79a03e-89c7-47b2-8ff0-0a896fa66720",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "607dc2b9-e586-47de-bb61-28f42d234243",
"db_language_id": "6fcf9472-3d84-4367-bebe-33cd6a90b024",
"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-10-14T05:36:05.5519877+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "210aa3ee-b24b-40ec-8025-bfa68a77ed50",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fdf09189-2873-436b-a0ad-ecf85018f8c1",
"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": "e46ae919-04a7-48d7-bda2-869666fecf61",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-14T05:36:05.5519877+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ac69011b-d881-40e6-9eb8-d1d17d1a83ec"
},
"suggested_date_start": "2026-10-14T05:36:05.5519877+00:00",
"skill_id": "32eec48d-cdf2-4363-83ec-ecd798b71901",
"skill_code": "sample string 32",
"skill": {
"id": "c7e1d9fb-772e-4032-b74e-973724650c1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bc140acc-185b-42fe-b048-0762a165923b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f5a5ba3-9edf-43dd-87a9-b3e272abe9e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30301766-de58-4d82-b0e1-1eb377f7ae63",
"db_currency_id": "05297942-c565-47df-bcb3-caa5a9b6e8f4",
"db_language_id": "a0f8e455-800f-4bcc-a69e-3323eee02f1d",
"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-10-14T05:36:05.5221573+00:00"
},
"modified_dateutc": "2026-10-14T05:36:05.5519877+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3f2206d3-9850-469a-bc20-88749f327489",
"date_reported_by_company": "2026-10-14T05:36:05.5519877+00:00",
"id2": 36,
"company_id": "8bbe15c7-6af7-45a4-8326-c652f8966aec",
"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": "362240b2-ee7c-491c-8f3c-6588ce5bfecf",
"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-10-14T05:36:05.5519877+00:00"
},
"work_instruction_details_id": "56e2f072-5ce7-4e49-b9ce-bbdf1492170a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "311d6c6b-4352-4aab-ae7f-26446b8ba813",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9772afb4-433c-49aa-88a8-d7b4b8811a39",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-14T05:36:05.5636979+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": "27a1c9af-a534-45d5-856f-2ca527b4b561",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-14T05:36:05.5636979+00:00"
}