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": "71777558-3190-422f-9de2-8c501131f220",
"jobs_id": "5df73f2b-15a1-43be-8116-040ef23c3f32",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "71c14138-c278-489f-b000-664d0860c679",
"_parent_id": "3911f934-7ba5-4b0d-aa15-2ce3042ef6c5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4c33638-cdd8-46ab-92c7-b714961c546d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4b17fdbf-2a5b-4706-b680-65ddd0dc5bae",
"_parent_id": "70622074-cffe-4e17-81e8-7241ad872119",
"root_parent_id": "c3e3afe1-0ed2-46d6-b0ff-3e3e3767d811",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "14ab5b1b-9c54-4bb4-8606-9d93377c8280",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e9696ebe-24ce-47b1-adce-ae99d5f8d68f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c688bcc8-2303-47f8-9c50-7963ae298d50",
"_parent_code": "sample string 6",
"sales_organization_id": "9df337c1-54a2-4208-a382-064ac0a7f36a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+00:00"
},
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00"
},
"equipment_model_id": "ec3f0d0b-c9e1-4a18-962b-b28f140d08d7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6ffa9733-ee17-4ab1-9285-19d1013a6f8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5b4ac24c-19d7-4374-9f1b-9c730eb6da1f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d9061beb-c5be-4e75-8db7-8280806f54e4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "36b96df1-40e1-47ff-92d1-8ddbe9368435",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+00:00"
},
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00"
},
"equipment_family_id": "a6b2bfa1-4a54-44f6-a3c5-5a1e556d66a3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e9696ebe-24ce-47b1-adce-ae99d5f8d68f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c688bcc8-2303-47f8-9c50-7963ae298d50",
"_parent_code": "sample string 6",
"sales_organization_id": "9df337c1-54a2-4208-a382-064ac0a7f36a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+00:00"
},
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00"
},
"date_in_production_since": "2025-11-17T21:57:43.079045+00:00",
"date_out_of_production_since": "2025-11-17T21:57:43.079045+00:00",
"date_end_support": "2025-11-17T21:57:43.079045+00:00",
"sales_organization_id": "486cf315-b231-4510-bd04-aa091187ea02",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+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-11-17T21:57:43.079045+00:00"
},
"project_status_id": "bc2d44ac-debc-4f8f-8f6b-54d734e0de2b",
"project_status_code": "sample string 10",
"project_status": {
"id": "c6b9c765-1618-480d-9997-d4c5108b0faf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "112a55a4-c447-475e-a701-adf3237dc304",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00"
},
"company_id": "100ba147-1c59-44b3-aef8-332d05c5d455",
"company_code": "sample string 12",
"db_address_id": "b1662558-38a0-4ed1-b1bf-d894e6cf3a67",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4caeb402-98f6-4f7f-bbcc-5341b225f465",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eb68ebfe-b68a-48b8-8b23-de3a932eb71d",
"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-11-17T21:57:43.079045+00:00",
"date_create": "2025-11-17T21:57:43.079045+00:00",
"date_update": "2025-11-17T21:57:43.079045+00:00",
"updated_by_user_id": "fd7b122c-bbd8-4c73-bc85-c2256051419e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-17T21:57:43.079045+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-11-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-17T21:57:43.079045+00:00",
"date_last_job": "2025-11-17T21:57:43.079045+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-17T21:57:43.079045+00:00",
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00",
"is_mobile_installation": true
},
"job_type_id": "e69c6009-52db-4a29-93ec-2bf1786584b7",
"job_type_code": "sample string 7",
"job_type": {
"id": "fc8f9761-9bfa-421d-8a6a-97520285f041",
"name": "sample string 2",
"sales_organization_id": "325b0aa1-b4aa-4bf2-b620-b2ad70f519bb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00",
"code": "sample string 7"
},
"job_priority_id": "48b71887-1997-4912-bbb5-16e7ae26417e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b2a231c3-d728-48e3-988f-6c86a083cb9f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a3a9111f-a918-445e-9343-56ceb877a444",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00"
},
"job_status_id": "bcf415b7-e6b9-4d52-9d82-69588cede3fe",
"job_status_code": "sample string 11",
"db_address_id": "cc8d42a4-c738-4f23-8e10-f727439849e9",
"contact_id": "12777a1c-578d-4594-af74-a0383adda614",
"requested_by_company_id": "5dd08c1b-2b60-4ee8-9f09-ac6685e815cf",
"requested_by_contact_id": "59b6f12a-754c-409e-bc20-b4f1abca290e",
"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-11-17T21:57:43.079045+00:00",
"due_date": "2025-11-17T21:57:43.079045+00:00",
"date_create": "2025-11-17T21:57:43.079045+00:00",
"date_update": "2025-11-17T21:57:43.079045+00:00",
"date_closed": "2025-11-17T21:57:43.079045+00:00",
"suggested_user_id": "f120f877-566d-4d1d-b0f5-cc44b38568ec",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d2ff6377-1b5f-4b51-8894-e656d0550d27",
"db_language_id": "5aa1dd34-a809-4697-90aa-54be165fd9fe",
"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-11-17T21:57:43.079045+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b0d7c59b-8048-47a5-815e-ba487460827e",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6dea62e6-111c-4ae4-884f-b992b77c3af3",
"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": "fcbf1a2d-509f-499d-969b-68b3b9b2d4c6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ab799a37-1bbe-4273-8f8a-b599dfe7ec27"
},
"suggested_date_start": "2025-11-17T21:57:43.079045+00:00",
"skill_id": "26390479-21b7-42c4-8edc-fef95515ba53",
"skill_code": "sample string 32",
"skill": {
"id": "6ca0890a-d01b-4ace-8746-2ecfc9da231d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "377c47bc-dd1d-43b5-b17e-5f7c895e09c9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d30ec780-a8a4-41a5-9209-6f728f80f63d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383b44b4-e00b-4e12-89be-4b8dc70cdd12",
"db_currency_id": "cfad9a7d-88df-4898-af1a-a4cb93ad0fa9",
"db_language_id": "73362feb-232c-4ff4-bb9e-9ca0cf37d865",
"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-11-17T21:57:43.079045+00:00"
},
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8c262b06-0f92-45ed-b657-523be4d52c4b",
"date_reported_by_company": "2025-11-17T21:57:43.079045+00:00",
"id2": 36,
"company_id": "d385a662-a894-4a8c-9905-dde2a3c0d672",
"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": "d84f9e73-310d-4d6a-b034-dcd0b782b669",
"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-11-17T21:57:43.079045+00:00"
},
"work_instruction_details_id": "1f02898f-5353-441b-ad4d-5288fa56da5d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "69468e00-b0b4-4a39-a022-592b9f666552",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b476af87-875f-4761-b284-deff1819376a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-17T21:57:43.079045+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": "aa42905f-a067-4372-8a01-44a83fd085d9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-17T21:57:43.079045+00:00"
}