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": "bc2c7b32-c038-4e88-9c73-3a8f772e0584",
"jobs_id": "778a8127-660f-49cb-88d9-253ed202c250",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "68a61c96-caf4-4cf7-ad41-257771988055",
"_parent_id": "9975b701-2dd5-4913-8131-9ea53ed8ddb5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5d046fc0-b105-433f-9993-1a998dc01944",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4c54b81f-bd39-4c18-80bb-9702c301daab",
"_parent_id": "7ac9052d-667d-49ae-b9a6-aedb97980f80",
"root_parent_id": "d26877ed-7632-4aa6-a0f6-44aead5ca421",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d2f201a4-7e3a-4db1-9c86-f81181d52e5b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "85af83ad-ca78-4a3c-b231-085b2ffebc81",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b9090459-6457-4490-9f5d-a835b415a23d",
"_parent_code": "sample string 6",
"sales_organization_id": "5ba28c0d-2d45-4383-b5d0-6e19cd61c357",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+00:00"
},
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00"
},
"equipment_model_id": "5e94d619-7800-4c40-b277-71f5942d3a41",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc7801f4-6d06-47a6-98fc-5d57a8fb1303",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5c7a1ad5-c1a3-4fe1-9fea-dfc6db5a6844",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3e75f5b-eed2-4879-adf8-bdb1ae62470f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "02711d19-9fbf-47cf-8bd6-7a0cdd783779",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+00:00"
},
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00"
},
"equipment_family_id": "707449d5-9842-43be-8b5d-d36151189f69",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "85af83ad-ca78-4a3c-b231-085b2ffebc81",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b9090459-6457-4490-9f5d-a835b415a23d",
"_parent_code": "sample string 6",
"sales_organization_id": "5ba28c0d-2d45-4383-b5d0-6e19cd61c357",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+00:00"
},
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00"
},
"date_in_production_since": "2026-09-27T15:39:40.2152791+00:00",
"date_out_of_production_since": "2026-09-27T15:39:40.2152791+00:00",
"date_end_support": "2026-09-27T15:39:40.2152791+00:00",
"sales_organization_id": "72e07da3-7df3-455c-a0b4-3c774ff3d880",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+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-09-27T15:39:40.2152791+00:00"
},
"project_status_id": "45de2929-317c-4d1e-ac0b-e943d4866eb3",
"project_status_code": "sample string 10",
"project_status": {
"id": "39bcc1ec-ba7f-459c-9d9c-320e1be62c4f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a49a015c-8f89-4103-a181-c26d630a453d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00"
},
"company_id": "be998049-fc94-40f1-99bb-1a12ee97bf60",
"company_code": "sample string 12",
"db_address_id": "b357e96a-84d7-448f-9ed4-9f2a819fa665",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2f6da80e-6abc-4a2d-8ad8-3ab37674da49",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "082111a5-4009-466c-bf22-e6525395eeb8",
"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-09-27T15:39:40.2152791+00:00",
"date_create": "2026-09-27T15:39:40.2152791+00:00",
"date_update": "2026-09-27T15:39:40.2152791+00:00",
"updated_by_user_id": "26c37f5a-9e72-4c94-a019-b3d3673c1fc9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-27T15:39:40.2152791+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-09-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-27T15:39:40.2152791+00:00",
"date_last_job": "2026-09-27T15:39:40.2152791+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-27T15:39:40.2152791+00:00",
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00",
"is_mobile_installation": true
},
"job_type_id": "d83e2c66-c429-457d-bf6b-80b16dce1dbd",
"job_type_code": "sample string 7",
"job_type": {
"id": "15946e60-4b97-4cc6-ba11-c8d4aa885ca5",
"name": "sample string 2",
"sales_organization_id": "f44b5e6c-6656-4466-95c0-a91dc581e3f8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00",
"code": "sample string 7"
},
"job_priority_id": "eb722a5a-0477-4721-a653-0b7f7b7051ad",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "668c1f0a-25d1-482a-b726-d06743564de6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cd005fd6-9690-400e-879a-2f3f3522dab4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00"
},
"job_status_id": "a2a9f4d6-fe4b-4cb6-afcb-9f6f64560cf9",
"job_status_code": "sample string 11",
"db_address_id": "120a81c0-505a-4e2e-bc0e-2ba365ccca25",
"contact_id": "5a85436f-a692-4a09-9d8d-60e6999aa4ab",
"requested_by_company_id": "9a4f5328-a89c-4461-8a59-046405a31dae",
"requested_by_contact_id": "c0243ce0-1600-4c4e-b358-bb6b9edd827f",
"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-09-27T15:39:40.2152791+00:00",
"due_date": "2026-09-27T15:39:40.2152791+00:00",
"date_create": "2026-09-27T15:39:40.2152791+00:00",
"date_update": "2026-09-27T15:39:40.2152791+00:00",
"date_closed": "2026-09-27T15:39:40.2152791+00:00",
"suggested_user_id": "9e946067-90dd-4137-8963-4daf23fecbf7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1bb3eb8e-9976-4ea1-8699-090e4335cf53",
"db_language_id": "4d54fa7f-2cf1-439d-9fa1-7006a87b2d9f",
"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-09-27T15:39:40.2152791+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b2e8b30f-ba66-4242-a5e4-5b8b4bcea78a",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2900a931-c1b2-4c01-9ad2-2c9dc41b7035",
"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": "09637176-560a-45f8-9ba9-2f6363391b90",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "59509281-829e-4686-94f1-a1844b65c010"
},
"suggested_date_start": "2026-09-27T15:39:40.2152791+00:00",
"skill_id": "c2fa0956-ebff-4d87-bfd9-c2da6b3ba6d1",
"skill_code": "sample string 32",
"skill": {
"id": "81a25c6f-7409-4776-9f1e-3d68e56adcd8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "188691d5-c4ac-44d6-b6b3-26f858a79033",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b9efe5e-88c5-47a4-a8af-baffd6cd1501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89e63b12-cfb8-450e-88d0-62c7542a57c3",
"db_currency_id": "519ae833-7a79-49eb-8297-c6c31bab5737",
"db_language_id": "5e2914b6-b20d-46c2-ae88-249de3e0ecfb",
"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-09-27T15:39:40.2152791+00:00"
},
"modified_dateutc": "2026-09-27T15:39:40.2152791+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b785b898-0404-43f7-8adf-8d17df01e667",
"date_reported_by_company": "2026-09-27T15:39:40.2152791+00:00",
"id2": 36,
"company_id": "d22ef9c6-76de-44ae-b228-2decefcb46b7",
"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": "d2ecf9c9-c8f9-463a-905c-eae951283357",
"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-09-27T15:39:40.2152791+00:00"
},
"work_instruction_details_id": "22ad54b2-8835-4686-a400-47a32d26cf29",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dd1ebe2c-16fd-4340-ac16-21ee56747369",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a8ef74e6-c080-46e4-b678-9a6b8c88d331",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-27T15:39:40.2152791+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": "b7067036-ef3b-41aa-aef1-c42fb6e47d28",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-27T15:39:40.230902+00:00"
}