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": "231845a2-1662-423e-ba09-d6806cc8d598",
"jobs_id": "3abcc681-6814-4d5c-bcb7-c6a4129cb5b3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a2226808-02b4-4ce1-8af5-d3de326af6af",
"_parent_id": "d1bc2d9e-3da6-43ad-b684-2d2b9de4cd2d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "760ca627-d709-40fe-9bf8-be19285eafe3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f8ad56ae-9d74-4e40-946d-ce5f4f5620e0",
"_parent_id": "4f8209ad-bde0-4372-8595-089145cfc3fd",
"root_parent_id": "046c4f95-1050-465e-a330-34c2d5a96783",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c16e1132-28be-42e6-8b07-0d1d6f45b744",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "33b8b799-a8ba-45e4-b725-ed41f80546ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "87ea8b60-7df9-47a2-911b-dd58d28ccafd",
"_parent_code": "sample string 6",
"sales_organization_id": "ec185f2c-c7f7-4bf8-b945-272b94aef525",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+00:00"
},
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00"
},
"equipment_model_id": "54f920cd-8f7f-4dcc-8e8d-78ce8dbd188e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d6a056c0-0cb5-4493-94d7-b266215a7c52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "353ce46c-5b4d-4e14-b6d2-47c64cbeeca2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4118d74e-372f-472e-890d-add95e02fa17",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "378017ad-7ac3-4b9f-90d2-e7559ee8ed47",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+00:00"
},
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00"
},
"equipment_family_id": "df88ad97-a4ab-4925-8781-0f340399b290",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "33b8b799-a8ba-45e4-b725-ed41f80546ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "87ea8b60-7df9-47a2-911b-dd58d28ccafd",
"_parent_code": "sample string 6",
"sales_organization_id": "ec185f2c-c7f7-4bf8-b945-272b94aef525",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+00:00"
},
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00"
},
"date_in_production_since": "2026-06-27T04:34:56.2749482+00:00",
"date_out_of_production_since": "2026-06-27T04:34:56.2749482+00:00",
"date_end_support": "2026-06-27T04:34:56.2749482+00:00",
"sales_organization_id": "157091cf-c5fe-4b35-951e-780d0730da94",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+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-27T04:34:56.2749482+00:00"
},
"project_status_id": "7266a290-7333-4c04-abf0-e91516949ce2",
"project_status_code": "sample string 10",
"project_status": {
"id": "65f3ea58-131f-4db6-bae4-7bd80a0cb54f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ef76a555-70ab-4d1d-bc7c-60265853b5b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00"
},
"company_id": "9d19747e-42a4-477f-b968-4f9c8b8e893b",
"company_code": "sample string 12",
"db_address_id": "0bf26219-99d3-417b-b6a3-ce9f6d5df65f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "18f96ccb-82d0-4cdc-9abb-ead1542c7d39",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7d13b33d-763d-4b1f-b70b-83826c723361",
"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-27T04:34:56.2749482+00:00",
"date_create": "2026-06-27T04:34:56.2749482+00:00",
"date_update": "2026-06-27T04:34:56.2749482+00:00",
"updated_by_user_id": "49c44e43-e55b-4c86-b5d6-7d5f1684b2b1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-27T04:34:56.2749482+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-27T04:34:56.2749482+00:00",
"date_last_job": "2026-06-27T04:34:56.2749482+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-27T04:34:56.2749482+00:00",
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00",
"is_mobile_installation": true
},
"job_type_id": "e8799c85-1921-4591-bb79-ec2d6cbc3312",
"job_type_code": "sample string 7",
"job_type": {
"id": "4df860e5-ec1e-4998-8e4e-e226a97efb13",
"name": "sample string 2",
"sales_organization_id": "dfa37966-85bf-4d23-ac38-82355ec24f2f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00",
"code": "sample string 7"
},
"job_priority_id": "377c4ff6-07e6-41af-bfe2-f3b14bca5fde",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "01cd1e0e-1c7f-45ce-8f32-39bbdc39a68e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d158b7b-6356-4160-b65d-6b665d793eaf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00"
},
"job_status_id": "09681e6c-4004-4dd5-a6db-6b0bb252b3d6",
"job_status_code": "sample string 11",
"db_address_id": "2508eec7-8951-4b55-8f4b-7a7fefb3f61d",
"contact_id": "b2674b0b-a6f7-4b46-aa0a-7f9b98cefef1",
"requested_by_company_id": "8f7c02b7-af1d-4243-a7a2-ecc281853c97",
"requested_by_contact_id": "56417961-32a4-4af7-9c6a-aa13e491c17a",
"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-27T04:34:56.2749482+00:00",
"due_date": "2026-06-27T04:34:56.2749482+00:00",
"date_create": "2026-06-27T04:34:56.2749482+00:00",
"date_update": "2026-06-27T04:34:56.2749482+00:00",
"date_closed": "2026-06-27T04:34:56.2749482+00:00",
"suggested_user_id": "c07feecc-738b-44e0-b218-de044fda9da9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "971230cb-91fd-4214-b8e9-06c862a7498f",
"db_language_id": "1800ff47-0702-4d9a-8b80-d4675f06bec8",
"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-27T04:34:56.2749482+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ad911f11-473d-423a-bb0e-88c1cf21542b",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ef9e6c98-1b1b-4756-8d07-96feee0bbee0",
"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": "0aa40464-bdf8-4725-b225-aafa296cd3a7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "146ce6eb-ee80-48a7-a879-c04f0cb97521"
},
"suggested_date_start": "2026-06-27T04:34:56.2749482+00:00",
"skill_id": "c221ea5b-ca48-4dd6-90d1-d64841e8110b",
"skill_code": "sample string 32",
"skill": {
"id": "13089f02-194f-470b-bbf7-d4de04065bd9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "988896e2-0afd-4b9c-91ed-05378b3e6736",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1205a87-61f4-478f-94f1-a694fa0f28a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00b38eed-9803-42c8-8487-d5b7bf3064d1",
"db_currency_id": "f3a93cc8-8ed8-4fed-aee7-ca1062902806",
"db_language_id": "a5e3da5e-ec05-4770-80ed-b2ec6bd5bb79",
"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-27T04:34:56.2749482+00:00"
},
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0aeb3d6f-9f6d-45fe-93ad-5fcfff04a5ed",
"date_reported_by_company": "2026-06-27T04:34:56.2749482+00:00",
"id2": 36,
"company_id": "418cb181-8553-47b3-9a02-b9bf15e61b57",
"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": "f051c0eb-9cab-4e3d-b4c5-423dff899401",
"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-27T04:34:56.2749482+00:00"
},
"work_instruction_details_id": "e61e9d98-6d62-4f93-99ec-9f05f035fdd7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "42b207c0-5ffe-4793-a35d-8321c2112dd3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f4d99630-fc8e-48ce-bc6d-595c8ef5c3d2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-27T04:34:56.2749482+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": "0008b898-1a67-4f87-8018-2042a7479ef6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-27T04:34:56.2749482+00:00"
}