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": "1e24c209-ef89-4ac8-b930-bf8a23fa3e42",
"jobs_id": "eab8de05-1816-446f-a5ba-309752fe07d0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4a52f009-9e6a-475b-b9fd-0ac13772ed10",
"_parent_id": "bb44f258-abe7-488f-9d68-eefd89dbbfb2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3274258b-7334-4f7a-b39c-e785ad65d723",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3602bde7-9d9d-461b-9097-edc353f5e84c",
"_parent_id": "f9e40e49-1bbd-433e-b076-e63dc3640033",
"root_parent_id": "1fbef682-e723-4378-a5dc-273fb749cc1c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d292b9c0-6c64-4379-b91f-ccd7c9aa1bfe",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3ca62a88-a28e-4330-b7ab-19189bfbec80",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abf19a90-2d68-4c80-939d-832abafaa17d",
"_parent_code": "sample string 6",
"sales_organization_id": "faa1871f-b700-47dd-bc60-e3c113500ac0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+00:00"
},
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00"
},
"equipment_model_id": "de84dcc3-84e1-4887-86fe-ed3b9facffd1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ec5dec5c-5815-4bd0-9dbb-1359d997a0a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "59be479b-6abb-4a5c-9a6f-6979bbed5b05",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "321f7997-3ed6-4d1e-b2fd-70d6332def6d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1f36644d-4e4e-4684-bc9c-0cfdd655922c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+00:00"
},
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00"
},
"equipment_family_id": "42c9ea5f-551b-4792-a7f3-116c104cb2ce",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3ca62a88-a28e-4330-b7ab-19189bfbec80",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abf19a90-2d68-4c80-939d-832abafaa17d",
"_parent_code": "sample string 6",
"sales_organization_id": "faa1871f-b700-47dd-bc60-e3c113500ac0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+00:00"
},
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00"
},
"date_in_production_since": "2025-10-26T18:39:26.9447189+00:00",
"date_out_of_production_since": "2025-10-26T18:39:26.9447189+00:00",
"date_end_support": "2025-10-26T18:39:26.9447189+00:00",
"sales_organization_id": "8363919c-4731-4e11-8612-51d1fe30b057",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+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-10-26T18:39:26.9447189+00:00"
},
"project_status_id": "b3831755-41f8-46b5-84aa-d6a1f19b61b6",
"project_status_code": "sample string 10",
"project_status": {
"id": "c4e46fe4-e235-4df6-a8c3-83c0dcab738a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "951afe59-7754-432f-9877-1badf874793d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00"
},
"company_id": "0ad25616-f8a9-4aa2-a31e-2f353cfbd38e",
"company_code": "sample string 12",
"db_address_id": "83b3b1c3-2a08-42f8-8ef2-b983c0461e98",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8803c6ae-e734-4842-9eca-3466918b75b3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f81441c3-0993-46fb-b8b2-e9b8d156a707",
"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-10-26T18:39:26.9447189+00:00",
"date_create": "2025-10-26T18:39:26.9447189+00:00",
"date_update": "2025-10-26T18:39:26.9447189+00:00",
"updated_by_user_id": "8a4bd7cb-00dd-4df8-ab4e-e983630db46c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-26T18:39:26.9447189+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-10-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-26T18:39:26.9447189+00:00",
"date_last_job": "2025-10-26T18:39:26.9447189+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-26T18:39:26.9447189+00:00",
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00",
"is_mobile_installation": true
},
"job_type_id": "59ee145f-07a0-47ba-90dd-8a871b4cdb4a",
"job_type_code": "sample string 7",
"job_type": {
"id": "bbc7c959-1929-41c4-8eea-687dcc8214a6",
"name": "sample string 2",
"sales_organization_id": "a245226c-9e7a-4cef-8853-bca8e0dc0f2c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00",
"code": "sample string 7"
},
"job_priority_id": "80909a8c-4bce-403e-8cfa-5ec3606a576c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8cc33a96-b05e-4129-8a0f-524229f55dd7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d45abbb7-e62f-47fd-a7b4-f9acc92a5688",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00"
},
"job_status_id": "e2fb266c-d8da-4518-a490-2d0510f3f952",
"job_status_code": "sample string 11",
"db_address_id": "a3c13d23-ca47-4474-8f89-6607d1db42d8",
"contact_id": "5f2f0acb-a46f-423b-b328-daa73246a134",
"requested_by_company_id": "6bd02e78-0f55-4316-a11f-a4d76b69e56d",
"requested_by_contact_id": "63141c63-3834-42ea-be85-9dc9e9c6f17d",
"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-10-26T18:39:26.9447189+00:00",
"due_date": "2025-10-26T18:39:26.9447189+00:00",
"date_create": "2025-10-26T18:39:26.9447189+00:00",
"date_update": "2025-10-26T18:39:26.9447189+00:00",
"date_closed": "2025-10-26T18:39:26.9447189+00:00",
"suggested_user_id": "8da3b7f3-fc86-44f6-bd9a-82276827eb0b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "428f1495-4831-4674-9f3d-810d952056f2",
"db_language_id": "018513f3-095c-4975-b0a6-d506bc755252",
"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-10-26T18:39:26.9447189+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ba07dfee-ce49-4c28-a253-5d1b54871aec",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "babcddcd-8b17-4149-ac9e-5db469a24427",
"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": "b4548081-8fd3-4318-a69f-bb1d24fcbcf7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "474999b3-57c4-4ab2-a8a9-20648156a31d"
},
"suggested_date_start": "2025-10-26T18:39:26.9447189+00:00",
"skill_id": "c1165b28-90df-4e96-9e39-abb554ba0aa9",
"skill_code": "sample string 32",
"skill": {
"id": "c5dfc9da-0245-4634-9b04-2794c4a8ab9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0d41e131-d88b-4b3b-922d-eb95bffa024a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c4e8a05f-d37c-4f0d-9c64-6e2ac20de02f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "372493b4-a61f-44fc-9d6a-e39a6f812bb7",
"db_currency_id": "26833de8-0bf3-4a39-b448-f699a3131a2f",
"db_language_id": "d46fe03f-7ae2-44d7-b4ba-d17c38823d77",
"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-10-26T18:39:26.9447189+00:00"
},
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "04c559d9-04d7-4d42-a44e-ac9bd3ac235a",
"date_reported_by_company": "2025-10-26T18:39:26.9447189+00:00",
"id2": 36,
"company_id": "c3bb9bce-105c-4e1c-95ee-92994e06d49f",
"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": "53456d4c-0c73-41b6-9f78-f36764f97384",
"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-10-26T18:39:26.9447189+00:00"
},
"work_instruction_details_id": "20188d32-aa42-4a5d-a864-b56b0875819f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dc86f09f-9197-496f-a0a9-9a1b3abd38ac",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "04a81793-67c2-4495-9f12-c5261714e059",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-26T18:39:26.9447189+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": "cab8db7e-bf11-4f42-bc61-55de9eac69ce",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-26T18:39:26.9447189+00:00"
}