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": "f1e5fa0a-144f-48bd-81df-5b0f5c13afac",
"jobs_id": "34f86a12-31ac-45fb-82be-2f8134e77025",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ddb21038-caad-43dd-82c1-bb1b6eeeb7e8",
"_parent_id": "96f0b25a-f769-4257-ab1f-0b6b7a391f20",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4d7df1c8-5cc4-4086-89b4-0851ab01f369",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d3d23b1c-a10b-455f-ac2d-9bc9dc2a4a82",
"_parent_id": "751420c6-f71b-44f1-a28b-fdc7110a8bd8",
"root_parent_id": "abd8bf24-39d6-4168-b9cb-fd807f75b7e0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "793071b7-57fb-46f1-8eeb-5854dbc71010",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0ebeda3e-c673-4a2a-8dad-a163b599669f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3f201d0-f0a9-4690-ab74-313f167b474e",
"_parent_code": "sample string 6",
"sales_organization_id": "0419b7ce-c6d8-4485-a56b-70c2868a5367",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+00:00"
},
"modified_dateutc": "2026-10-10T13:57:34.9445874+00:00"
},
"equipment_model_id": "a23d3253-82e1-4240-b550-18f6ed576040",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8516d236-b3fa-4e6d-889b-eea7fe23d1a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "63e9d4b9-bb5b-4113-9cb5-07a757cbb870",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "429d214a-1b1b-42a7-a112-215619c890a5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8eb5f613-c372-4ab8-bfc9-d65c20b78aa2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+00:00"
},
"modified_dateutc": "2026-10-10T13:57:34.9445874+00:00"
},
"equipment_family_id": "5ff1d429-77d6-495e-95be-93a0b9cf2a80",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0ebeda3e-c673-4a2a-8dad-a163b599669f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3f201d0-f0a9-4690-ab74-313f167b474e",
"_parent_code": "sample string 6",
"sales_organization_id": "0419b7ce-c6d8-4485-a56b-70c2868a5367",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+00:00"
},
"modified_dateutc": "2026-10-10T13:57:34.9445874+00:00"
},
"date_in_production_since": "2026-10-10T13:57:34.9445874+00:00",
"date_out_of_production_since": "2026-10-10T13:57:34.9445874+00:00",
"date_end_support": "2026-10-10T13:57:34.9445874+00:00",
"sales_organization_id": "7057c61b-610d-41ae-bdfc-fc09104d96e7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+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-10T13:57:34.9609219+00:00"
},
"project_status_id": "a75e2f22-3f4b-4b3e-ad7f-6a08aaebe542",
"project_status_code": "sample string 10",
"project_status": {
"id": "c778a71e-cdf8-406c-96f8-b8e2e3e4e204",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0fc3dafc-1d80-42e3-9c18-fd7bbf46feec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T13:57:34.9609219+00:00"
},
"company_id": "35289579-83e6-410d-bfa0-b49a6b273f22",
"company_code": "sample string 12",
"db_address_id": "7bcc2bb5-5f07-47cb-9063-89a42da21fc2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7ff69bf2-c32a-4e37-bd5e-5ed2a79e9473",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f13fbec2-e447-4841-8f3e-808525a81911",
"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-10T13:57:34.9609219+00:00",
"date_create": "2026-10-10T13:57:34.9609219+00:00",
"date_update": "2026-10-10T13:57:34.9609219+00:00",
"updated_by_user_id": "c4143fdd-aea8-4039-9722-239ef5ae4a43",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-10T13:57:34.9609219+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-10T13:57:34.9609219+00:00",
"date_last_job": "2026-10-10T13:57:34.9609219+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-10T13:57:34.9609219+00:00",
"modified_dateutc": "2026-10-10T13:57:34.9609219+00:00",
"is_mobile_installation": true
},
"job_type_id": "5c39d1bd-3c99-49b1-b258-56592cc649ab",
"job_type_code": "sample string 7",
"job_type": {
"id": "e9761778-21ed-499a-98eb-d901fd54a5f1",
"name": "sample string 2",
"sales_organization_id": "f598eac0-1e50-4e93-82a1-9cdf8b1648ce",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-10T13:57:34.9609219+00:00",
"code": "sample string 7"
},
"job_priority_id": "9cbc375d-dccd-4988-b8e9-11d312c91abb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7130ec2b-6f6c-4cc1-bf8a-4f41a8fa9aa9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b6dccc9b-b7cf-4e89-abb9-dcf44c446c78",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T13:57:34.9609219+00:00"
},
"job_status_id": "242eebc4-d803-4e57-a98f-ed87eac0c837",
"job_status_code": "sample string 11",
"db_address_id": "d9ad82da-0850-4883-ad96-ccdac42e16c2",
"contact_id": "9f99bac6-018a-461d-8d0f-dd494b76c2e4",
"requested_by_company_id": "e53da29d-23c5-4427-8b10-b2f0a088db65",
"requested_by_contact_id": "ff8ebc18-e2f4-4850-a678-22ca56d8c6fe",
"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-10T13:57:34.9609219+00:00",
"due_date": "2026-10-10T13:57:34.9609219+00:00",
"date_create": "2026-10-10T13:57:34.9609219+00:00",
"date_update": "2026-10-10T13:57:34.9609219+00:00",
"date_closed": "2026-10-10T13:57:34.9609219+00:00",
"suggested_user_id": "23294f23-3e77-4369-b98f-c9117850cb5b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "597641b4-6cba-466d-9106-9904c667ffe1",
"db_language_id": "70380f43-1a00-4c02-a075-163fd10fa2cc",
"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-10T13:57:34.9609219+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "843ec6e6-b3ad-46e9-ae91-5ba19e62e70e",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e63b03d6-b71a-43f6-8e67-e7341838d5e9",
"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": "a50f4866-1d41-4efd-b30f-f05a50bd25bc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-10T13:57:34.9796253+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fc9a14eb-bb57-47f5-a745-997bd848ad3d"
},
"suggested_date_start": "2026-10-10T13:57:34.9796253+00:00",
"skill_id": "dba63688-0957-4bc8-a31b-2de1f64d2cb9",
"skill_code": "sample string 32",
"skill": {
"id": "5e3d1933-cd02-4dc1-88b8-6a3022d98c26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "304b285b-18d1-44e2-bdb6-ca133f00b179",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47449faa-4680-4604-a11b-0879c2721181",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6a0a9f7e-a938-4f6b-aab5-474567784caf",
"db_currency_id": "1ec57e55-03e6-4d82-af10-6ebc7ae02478",
"db_language_id": "a5bbb962-3721-466b-b930-f8015b995e22",
"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-10T13:57:34.9445874+00:00"
},
"modified_dateutc": "2026-10-10T13:57:34.9796253+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c310c12e-793d-47ff-a0e6-ee350bbbac92",
"date_reported_by_company": "2026-10-10T13:57:34.9796253+00:00",
"id2": 36,
"company_id": "6bdeb0e0-c109-497e-9a7e-9ce9c7e05a45",
"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": "e628d38d-9554-4112-8797-3c442dee71e2",
"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-10T13:57:34.9796253+00:00"
},
"work_instruction_details_id": "ebb40c15-cf78-4776-8d06-5f842ac551a6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "778f5550-33c6-40d5-9aa8-3e1462e02076",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ad52fe06-ca4c-490d-a12e-7cdb0c204063",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-10T13:57:34.9796253+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": "23181311-cc9b-4170-9152-b44b1074954a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-10T13:57:34.9796253+00:00"
}