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": "11773759-0b8b-4c66-ab2f-621547b991c6",
"jobs_id": "0619e8c5-018f-4094-85c1-26e1d7cdca7f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "08f9151f-98cf-43bd-9309-2b5f22a376d7",
"_parent_id": "f84a6917-33b8-42c1-ae7c-c30e776937c2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0d10af3f-405e-451a-bff2-21e7d7706651",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d81e2b05-cdf1-4631-b9b8-6a92029914d1",
"_parent_id": "402841cf-4c3a-4676-b993-f0b9a4590fce",
"root_parent_id": "38f58b9e-dd8f-4938-a358-50b20d8402ae",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fdfc80eb-33f4-44c7-9dd5-804e4276f70b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dad94feb-eb53-411a-bdb1-fd4d4cd2af1b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "730435d3-e2c9-490e-9a5b-6ccd2ecf567a",
"_parent_code": "sample string 6",
"sales_organization_id": "3080631b-c702-46f3-9f3a-a3816f5b70e6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+00:00"
},
"modified_dateutc": "2026-03-09T05:44:59.7886967+00:00"
},
"equipment_model_id": "eebd758b-4c6c-4de0-968f-6526e3942005",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "38ec4923-768f-4627-8153-bdaf1b9ff566",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "59f7eac1-51eb-4460-8078-1634032def56",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9e1295a9-6414-4750-9a80-81d7ff95337f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2080cfb2-66d9-4289-8e9c-6e70f74f623e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+00:00"
},
"modified_dateutc": "2026-03-09T05:44:59.7886967+00:00"
},
"equipment_family_id": "44572fea-7acf-4723-bd75-95b4c3d0ac2d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dad94feb-eb53-411a-bdb1-fd4d4cd2af1b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "730435d3-e2c9-490e-9a5b-6ccd2ecf567a",
"_parent_code": "sample string 6",
"sales_organization_id": "3080631b-c702-46f3-9f3a-a3816f5b70e6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+00:00"
},
"modified_dateutc": "2026-03-09T05:44:59.7886967+00:00"
},
"date_in_production_since": "2026-03-09T05:44:59.7886967+00:00",
"date_out_of_production_since": "2026-03-09T05:44:59.7886967+00:00",
"date_end_support": "2026-03-09T05:44:59.7886967+00:00",
"sales_organization_id": "6bb46e9f-db9d-40ec-87f0-21120fa9349f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+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-03-09T05:44:59.7886967+00:00"
},
"project_status_id": "20917865-4ab7-4080-936d-c97377599ef4",
"project_status_code": "sample string 10",
"project_status": {
"id": "b800e12f-aa6d-4863-ab71-bc550308da58",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2a9f23c7-7466-4882-be7b-73e8b5c7940c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-09T05:44:59.7886967+00:00"
},
"company_id": "9f0161c7-2332-44a1-9623-2cfa0d9becef",
"company_code": "sample string 12",
"db_address_id": "170301b8-7b59-4818-b6fa-23a05274b2fa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9dc95654-baa7-4efc-8384-8a61569249c0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1df164a7-910a-434c-ae72-37c521dad88f",
"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-03-09T05:44:59.7886967+00:00",
"date_create": "2026-03-09T05:44:59.7886967+00:00",
"date_update": "2026-03-09T05:44:59.7886967+00:00",
"updated_by_user_id": "ac784f57-9a4e-4ce9-8f32-62c04320bda2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-09T05:44:59.7886967+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-03-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-09T05:44:59.7886967+00:00",
"date_last_job": "2026-03-09T05:44:59.7886967+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-09T05:44:59.7886967+00:00",
"modified_dateutc": "2026-03-09T05:44:59.7886967+00:00",
"is_mobile_installation": true
},
"job_type_id": "ff5545a2-6888-4c53-a290-c7767512ba29",
"job_type_code": "sample string 7",
"job_type": {
"id": "d7862551-ccf5-4251-b43c-6a9797d44c5c",
"name": "sample string 2",
"sales_organization_id": "74aa0865-2bf1-4488-8b08-1a4d46dc4c8e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-09T05:44:59.7886967+00:00",
"code": "sample string 7"
},
"job_priority_id": "401aee91-0caa-4482-abf0-da0362d259cc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c27e03bb-0dc8-482d-984e-f7f53ca2949f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c433fd07-1baa-4ec3-8d33-e7d237ad00e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-09T05:44:59.804322+00:00"
},
"job_status_id": "f1692130-6caf-4bb0-8f95-7449f4e44fc4",
"job_status_code": "sample string 11",
"db_address_id": "cd48d9f3-7205-4369-8c2b-f30f4cd56d89",
"contact_id": "4ba30cf0-019c-4b87-939e-927e8432f5f0",
"requested_by_company_id": "8887dc7d-de53-4a20-9699-aaa0c062b5b3",
"requested_by_contact_id": "2e31cdce-1110-4019-83c0-0ec9bc60c08c",
"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-03-09T05:44:59.804322+00:00",
"due_date": "2026-03-09T05:44:59.804322+00:00",
"date_create": "2026-03-09T05:44:59.804322+00:00",
"date_update": "2026-03-09T05:44:59.804322+00:00",
"date_closed": "2026-03-09T05:44:59.804322+00:00",
"suggested_user_id": "746026fc-3a72-4d04-bfcc-37823b85f230",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "643933dc-4446-4ef4-b4a1-4881a48a6a32",
"db_language_id": "174417d7-5c0f-453f-9e27-3baa3fb6960b",
"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-03-09T05:44:59.804322+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "108f1612-a9c2-48dd-bede-b6459e36e78d",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3d16734c-560a-4a0e-a67c-dfa05236442b",
"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": "6d3f8ed1-3964-46f0-833c-e4a76b1d1aed",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-09T05:44:59.804322+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1892a7fb-0f14-4338-821f-2465620083b2"
},
"suggested_date_start": "2026-03-09T05:44:59.804322+00:00",
"skill_id": "45787f3b-baae-4664-9af0-789059035d0c",
"skill_code": "sample string 32",
"skill": {
"id": "861720e2-a21a-4cf8-a830-257389f2cef3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3a2e5d2f-7832-4c78-b86e-afca3ac87dc8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c35e5a37-189b-44b3-b79b-4d6874ca64f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e016ce31-eeef-4bb9-b237-5b08275ddbf0",
"db_currency_id": "2114985e-6711-48fd-ac2f-114f4dd3f3d3",
"db_language_id": "9cbb73a0-666e-4955-ad13-58fd5c0c8abb",
"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-03-09T05:44:59.7886967+00:00"
},
"modified_dateutc": "2026-03-09T05:44:59.804322+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7a639efa-a8e7-4bdb-adaa-b0edc4d64160",
"date_reported_by_company": "2026-03-09T05:44:59.804322+00:00",
"id2": 36,
"company_id": "6446b406-8174-4b57-83fe-4a1c42ee946e",
"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": "d2b13b64-908b-449b-ae88-c1358c219037",
"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-03-09T05:44:59.804322+00:00"
},
"work_instruction_details_id": "85d06c24-4f0e-4d4d-bd85-f2821812af21",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c692172c-a511-4f13-ac43-33678063c7b4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0b2c90fc-21a8-4a15-961e-2ee4d043ace4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-09T05:44:59.804322+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": "79464aec-6578-43ae-9b66-8dcecb2c95e9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-09T05:44:59.804322+00:00"
}