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": "5c643c14-cc51-4eed-a3d3-1524f03999ab",
"jobs_id": "4328ec88-f37e-4b12-9b55-30c434af1ae7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "194d1537-095d-4f24-8d8c-9761b32d6daa",
"_parent_id": "0f9dbe04-890c-4bb6-8288-e99d4be0c29f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "818200b2-da0b-4d13-be87-2ebf13f7f2d5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e8dbdbe7-3d8e-4cff-9c50-843f9e9b3bf0",
"_parent_id": "7fc98599-5106-4324-bbb3-cfeca93e63b4",
"root_parent_id": "e5c05d64-33bd-43d8-adb3-dd9f86c1cd99",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0e83780a-825b-4ba6-b54a-5495bc20351b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b0a9f683-30ba-4d61-880d-b8e2cbd686a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c83bdc99-1ba3-439a-ae5c-c7079a114594",
"_parent_code": "sample string 6",
"sales_organization_id": "b22f0db6-b5e7-492a-9204-779e214ea374",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+00:00"
},
"modified_dateutc": "2026-07-11T08:00:32.9923048+00:00"
},
"equipment_model_id": "b13b91de-713f-4f9e-b634-a13d032178dd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "564a5e2d-d4e4-44d2-abb6-54592c01c055",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "971f34a4-047e-47e4-8053-62986aeb3aa6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4dccf115-25eb-4a78-bde2-dac2c7da8875",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f7720035-0109-424c-a3a7-4de89af045fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+00:00"
},
"modified_dateutc": "2026-07-11T08:00:32.9923048+00:00"
},
"equipment_family_id": "33b750e5-4173-4c5d-8e04-87a7099f0b3f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b0a9f683-30ba-4d61-880d-b8e2cbd686a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c83bdc99-1ba3-439a-ae5c-c7079a114594",
"_parent_code": "sample string 6",
"sales_organization_id": "b22f0db6-b5e7-492a-9204-779e214ea374",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+00:00"
},
"modified_dateutc": "2026-07-11T08:00:32.9923048+00:00"
},
"date_in_production_since": "2026-07-11T08:00:32.9923048+00:00",
"date_out_of_production_since": "2026-07-11T08:00:32.9923048+00:00",
"date_end_support": "2026-07-11T08:00:32.9923048+00:00",
"sales_organization_id": "20520f43-ea90-40c6-851b-f8fdc4db7138",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+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-07-11T08:00:32.9923048+00:00"
},
"project_status_id": "38a2dce4-5273-4ed3-b0e3-1bc6b022593b",
"project_status_code": "sample string 10",
"project_status": {
"id": "6fbabb95-fa37-4a1a-8bc3-698bc83ae649",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "264ccdff-f312-428d-a35f-c30867d9fffa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T08:00:32.9923048+00:00"
},
"company_id": "a375157b-a498-433f-9879-d44211d048ca",
"company_code": "sample string 12",
"db_address_id": "7c132afc-95e2-4a78-8bc5-082841e5a837",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ba525927-b299-4987-988e-fc073080ae6c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "29c612d0-5122-4df6-baa7-a132d74d8539",
"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-07-11T08:00:33.007928+00:00",
"date_create": "2026-07-11T08:00:33.007928+00:00",
"date_update": "2026-07-11T08:00:33.007928+00:00",
"updated_by_user_id": "0ecc8af7-5cb0-42b3-852c-9d898e3d15aa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T08:00:33.007928+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-07-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T08:00:33.007928+00:00",
"date_last_job": "2026-07-11T08:00:33.007928+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T08:00:33.007928+00:00",
"modified_dateutc": "2026-07-11T08:00:33.007928+00:00",
"is_mobile_installation": true
},
"job_type_id": "0fb4fea7-a827-4a60-9d59-5fa97c562238",
"job_type_code": "sample string 7",
"job_type": {
"id": "df437de2-8bfe-4cd2-9003-27236ea06d4f",
"name": "sample string 2",
"sales_organization_id": "1a039313-dea0-47b7-9cca-38464b160cd9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T08:00:33.007928+00:00",
"code": "sample string 7"
},
"job_priority_id": "89ddfd78-901d-4559-955e-9fe3824ef335",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9245070c-e486-49a8-8801-5158efcff6c0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "007395e3-7f16-4c7e-be80-9ef4b127ea6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T08:00:33.007928+00:00"
},
"job_status_id": "8f8c172e-61ef-4f1e-93e4-9129750eab04",
"job_status_code": "sample string 11",
"db_address_id": "db6f368c-860b-4bd5-8b89-906a635c2820",
"contact_id": "62d2c23b-cabc-4fd0-8b22-5bdbcc09ac34",
"requested_by_company_id": "ebe923d4-c60b-4e07-a91c-ecc15c76fbef",
"requested_by_contact_id": "64eaa227-5451-43b1-9645-d627043ed091",
"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-07-11T08:00:33.007928+00:00",
"due_date": "2026-07-11T08:00:33.007928+00:00",
"date_create": "2026-07-11T08:00:33.007928+00:00",
"date_update": "2026-07-11T08:00:33.007928+00:00",
"date_closed": "2026-07-11T08:00:33.007928+00:00",
"suggested_user_id": "874a97ea-86a0-47fa-96aa-94866d23f8c2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b62927d7-c79f-453f-9ea0-196ef7eed125",
"db_language_id": "ed0631c8-13ef-4261-b0ca-2314525dd038",
"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-07-11T08:00:33.007928+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f08f2c6c-9f3e-4e42-bc9b-cd843fd0c4f6",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bc35b771-a618-40ea-beb7-6e1c9e19fcd7",
"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": "57ca2643-b320-4057-8513-6ee22f30e2db",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T08:00:33.007928+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "24d44f5a-9b80-4efd-adc5-47557cd38b33"
},
"suggested_date_start": "2026-07-11T08:00:33.007928+00:00",
"skill_id": "5090bac7-2517-4e04-b070-d4014b231840",
"skill_code": "sample string 32",
"skill": {
"id": "bfd919bc-4af2-40e7-aac7-0f1641d18366",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f4b5be7a-297e-4d56-af25-bb5e27a3ec2a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74f18948-58df-4fa2-80cb-665208b82a40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3ab3a0f-733c-4df7-a001-f493e455f8d6",
"db_currency_id": "e25bea26-1972-43a1-90bc-8a8846dd2eec",
"db_language_id": "3d6fbab2-c2ec-4074-bb0d-0631f07d6b12",
"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-07-11T08:00:32.9923048+00:00"
},
"modified_dateutc": "2026-07-11T08:00:33.007928+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "44bfd2c0-1ee6-4b6f-bb0a-84980cb6280a",
"date_reported_by_company": "2026-07-11T08:00:33.007928+00:00",
"id2": 36,
"company_id": "b92e7e07-0b02-4703-b475-1eb0316cffaf",
"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": "6cfac521-aef2-41a5-a653-5ea8f80c4d8e",
"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-07-11T08:00:33.007928+00:00"
},
"work_instruction_details_id": "03f86d74-a3bf-4823-97b3-12c97448c255",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4d65d350-0d62-4fb1-9925-8b99e44055dc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8c81b721-a9ce-4b39-80ab-19d04918fc57",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T08:00:33.007928+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": "1aecec71-132a-45fe-9b9c-035dcbbdbb80",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T08:00:33.007928+00:00"
}