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": "2174f2dd-f804-4205-a15b-ef3966d23bcc",
"jobs_id": "b1055428-37af-4193-a49d-584f3d404ad7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "faa5a34c-1614-447f-9337-479b94280dd8",
"_parent_id": "6e3e4fb6-daac-47bf-b81b-db9942916580",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2f79912b-45f5-4d00-8ae1-72ab458bd108",
"project_reference_back_office": "sample string 5",
"project": {
"id": "146f6ed8-d18f-42ce-bc6d-64e12887738f",
"_parent_id": "e5cf4083-7244-4d9f-a68a-1a4eeea68f1d",
"root_parent_id": "be8e432f-1e9f-412f-b2e7-8489d16bd747",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e69c771d-4fdd-4408-98e8-8f7234d15d22",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2fe9b4ee-435a-47dc-9d17-4d60bc81b2aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ec2cbdd-23ca-41b5-a5c8-33801c8b241c",
"_parent_code": "sample string 6",
"sales_organization_id": "53fca471-1441-472a-a66f-6d295ad65611",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00"
},
"equipment_model_id": "a14e5f72-4db9-490e-81a8-01e6ebe9f35c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "431beedd-3b80-4fd6-a58a-441e1742fa9a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0beab1ca-1f8e-43fa-926a-a7139f9a027e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "56445e01-b070-4867-94d4-3a084ca2ae82",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8548861f-856e-4b03-8e82-6708b4be7008",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00"
},
"equipment_family_id": "f6a541aa-bb3d-4851-90e3-763718dc9585",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2fe9b4ee-435a-47dc-9d17-4d60bc81b2aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ec2cbdd-23ca-41b5-a5c8-33801c8b241c",
"_parent_code": "sample string 6",
"sales_organization_id": "53fca471-1441-472a-a66f-6d295ad65611",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00"
},
"date_in_production_since": "2026-06-02T03:50:10.2055316+00:00",
"date_out_of_production_since": "2026-06-02T03:50:10.2055316+00:00",
"date_end_support": "2026-06-02T03:50:10.2055316+00:00",
"sales_organization_id": "7689ce13-7b9e-477b-a774-dded4a207b0e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+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-06-02T03:50:10.2055316+00:00"
},
"project_status_id": "2ce241ab-5ec0-4e70-b576-d78a7fbfba0b",
"project_status_code": "sample string 10",
"project_status": {
"id": "a778ad7d-3785-42ba-8e13-df948c73f825",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "625c6fbc-3f48-48af-afe1-539eb76a97e0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00"
},
"company_id": "68387bec-b4ca-44fc-8a55-ae8e8190ff55",
"company_code": "sample string 12",
"db_address_id": "1ec1f4d8-d4ce-44ff-89ec-25426955b136",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "80db6891-5961-468b-b8a2-3e234a1230eb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1b63f2fc-aaee-4b3d-a914-9cf2897246be",
"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-06-02T03:50:10.2055316+00:00",
"date_create": "2026-06-02T03:50:10.2055316+00:00",
"date_update": "2026-06-02T03:50:10.2055316+00:00",
"updated_by_user_id": "98cd9e2e-339a-4288-b66e-95508f8a3b73",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T03:50:10.2055316+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-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T03:50:10.2055316+00:00",
"date_last_job": "2026-06-02T03:50:10.2055316+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T03:50:10.2055316+00:00",
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00",
"is_mobile_installation": true
},
"job_type_id": "1c509e09-dec5-49d5-9128-aa52a95ab7bb",
"job_type_code": "sample string 7",
"job_type": {
"id": "96de58fc-253c-487f-acb3-a2be1c87d903",
"name": "sample string 2",
"sales_organization_id": "57e54ad8-67c9-4f64-ace3-6e0ed2465294",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00",
"code": "sample string 7"
},
"job_priority_id": "9d29cc9f-2b95-41cc-b5e8-186165807ae0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b7ce302a-8fbf-42ad-a53c-c50f2c831ad6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4d85831f-22d6-499e-9ff1-e11bf187b707",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00"
},
"job_status_id": "ac6ed503-2e4d-4d7f-82f8-0745af389683",
"job_status_code": "sample string 11",
"db_address_id": "34a88322-71cc-4179-8b7e-6e9266f0c137",
"contact_id": "ab5007ea-47fe-4526-afbe-4f8d5f924da4",
"requested_by_company_id": "e04b8b62-fc92-4c9e-b6cf-59c029e3b83c",
"requested_by_contact_id": "f114b768-e990-41e3-afc4-f57f2c7ecc64",
"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-06-02T03:50:10.2055316+00:00",
"due_date": "2026-06-02T03:50:10.2055316+00:00",
"date_create": "2026-06-02T03:50:10.2055316+00:00",
"date_update": "2026-06-02T03:50:10.2055316+00:00",
"date_closed": "2026-06-02T03:50:10.2055316+00:00",
"suggested_user_id": "e0af0b63-d30c-4a9a-a309-736a8be1fefc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3e0881c5-358c-4f78-a87e-b3d0857501e1",
"db_language_id": "b6cc01b6-28a2-4131-a2c0-8efd9047dcc2",
"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-06-02T03:50:10.2055316+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b15fa6f3-6b55-42ed-bbca-362234ffebcc",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "98b40abc-111f-4f1d-8cdc-d5e77d92b669",
"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": "3c24b010-2514-46ae-a244-e0b52e3024a2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ba01a5d6-2176-42b6-8489-edde66072bbe"
},
"suggested_date_start": "2026-06-02T03:50:10.2055316+00:00",
"skill_id": "ac822782-d334-416a-8174-8bd112386c73",
"skill_code": "sample string 32",
"skill": {
"id": "17924ebd-9a12-4226-9a8b-e2a1c69d498a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f3208254-c0f5-4e06-acfc-c05fc8cd6790",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13856f68-7fd4-4f00-a17e-70b74bacc257",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc9c0e07-d8d2-4f30-ae0c-81b9ce614293",
"db_currency_id": "cd82d509-f61c-4723-bf56-d684f51966c8",
"db_language_id": "40da1abb-3fda-4c01-b020-649e5d782b2a",
"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-06-02T03:50:10.2055316+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4b854a30-504f-41df-8ac6-66afd9e1e5dd",
"date_reported_by_company": "2026-06-02T03:50:10.2055316+00:00",
"id2": 36,
"company_id": "58807177-68d5-4443-a96d-0f9756730543",
"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": "69e5624f-d496-4086-893a-d1f3b48c8e34",
"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-06-02T03:50:10.2055316+00:00"
},
"work_instruction_details_id": "5eab721d-3367-4e5e-a4a2-db24fd9cd957",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dfc47a65-c12d-4a0d-af6d-31aadbd0f60e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f00db063-435b-4067-86ad-9472dea19597",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T03:50:10.2055316+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": "8b84b50e-0e0b-4869-a20b-8c9de19c8d0c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T03:50:10.2055316+00:00"
}