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": "d4c4d61f-a828-4efa-b944-1c07553e07fb",
"jobs_id": "d083932b-1cea-4d8e-b923-9ae2338fa3f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "99a99bac-b15c-4c94-be79-02dd0318df83",
"_parent_id": "1788aab7-3ae9-4452-9e0a-fdabd0d33c50",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6f7f4cbf-7ce3-4059-ad91-8cec3a5be64f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cf1357a4-004d-4287-9378-f51c71c96068",
"_parent_id": "1d9dc47f-2004-4000-a4aa-c130d4835b0e",
"root_parent_id": "5abfd3a6-921b-4424-8d45-ebcadc581af0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e545c255-2db7-434f-8220-1ff14c529c93",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "376e45d7-c991-48ce-a310-000c251ac4d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cd71076-c5dc-4a38-b8e4-8c9421979fd6",
"_parent_code": "sample string 6",
"sales_organization_id": "c0c74a58-556f-4246-bf32-b832f7991590",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+00:00"
},
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00"
},
"equipment_model_id": "9985217f-f70a-4d43-898f-458b14294e54",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "54fc10a9-675e-4d80-b7b1-49b7caa91389",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e34c4992-8478-498b-8ef7-2df17e355b29",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f6d92e3e-1ed8-4f86-904b-6f15522da1b2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dac66e5a-3f8b-403b-875e-289262d49eb9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+00:00"
},
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00"
},
"equipment_family_id": "f4cc3e6f-6804-49db-bfae-e9c2933b87b7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "376e45d7-c991-48ce-a310-000c251ac4d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cd71076-c5dc-4a38-b8e4-8c9421979fd6",
"_parent_code": "sample string 6",
"sales_organization_id": "c0c74a58-556f-4246-bf32-b832f7991590",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+00:00"
},
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00"
},
"date_in_production_since": "2026-02-04T15:28:01.8795154+00:00",
"date_out_of_production_since": "2026-02-04T15:28:01.8795154+00:00",
"date_end_support": "2026-02-04T15:28:01.8795154+00:00",
"sales_organization_id": "d8ee0f64-64cc-430b-a4e2-3d7175e64f51",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+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-02-04T15:28:01.8795154+00:00"
},
"project_status_id": "e692ab2d-6f2a-43e9-a05f-c08db4e1866f",
"project_status_code": "sample string 10",
"project_status": {
"id": "6b76e899-1681-4221-818a-cdba7ffeab85",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ecda7562-4ac7-44a7-b747-937594267791",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00"
},
"company_id": "1c30c2fd-168a-484b-ac3c-e52e6c74e64f",
"company_code": "sample string 12",
"db_address_id": "6cf445ef-0b7d-421b-8905-f9363c5f84bc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a21e95ee-a282-4729-b6c4-d989fd5a0833",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e72a3ad4-c6e9-4273-8f65-d7770dcbbce3",
"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-02-04T15:28:01.8795154+00:00",
"date_create": "2026-02-04T15:28:01.8795154+00:00",
"date_update": "2026-02-04T15:28:01.8795154+00:00",
"updated_by_user_id": "6e054dee-0c85-4fd0-8d57-c05cb12988b1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-04T15:28:01.8795154+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-02-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-04T15:28:01.8795154+00:00",
"date_last_job": "2026-02-04T15:28:01.8795154+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-04T15:28:01.8795154+00:00",
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00",
"is_mobile_installation": true
},
"job_type_id": "59708f6f-2292-4bca-b8d2-b707053018fb",
"job_type_code": "sample string 7",
"job_type": {
"id": "9d51c012-edda-47bf-bc1f-96a2fabf195c",
"name": "sample string 2",
"sales_organization_id": "3d293d9a-d7ff-4771-91c0-5b56060703a9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00",
"code": "sample string 7"
},
"job_priority_id": "ee3db086-6242-4094-a242-22f6b262f1f8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ec0cce98-a83b-4460-b821-cf677973e87b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "533d880f-a1cc-4c9b-b80b-05a6ff591c62",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00"
},
"job_status_id": "22ddbff8-7eac-48c4-9787-608db799b6d3",
"job_status_code": "sample string 11",
"db_address_id": "cb252fd4-881b-4094-83e4-39ea776fadf8",
"contact_id": "8afb957b-ae05-42fe-ad6e-03977ff7937e",
"requested_by_company_id": "c7dacec8-8c69-412d-ab4f-b37257692039",
"requested_by_contact_id": "49e1d490-1819-4408-98b9-1c2ea40513dd",
"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-02-04T15:28:01.8795154+00:00",
"due_date": "2026-02-04T15:28:01.8795154+00:00",
"date_create": "2026-02-04T15:28:01.8795154+00:00",
"date_update": "2026-02-04T15:28:01.8795154+00:00",
"date_closed": "2026-02-04T15:28:01.8795154+00:00",
"suggested_user_id": "7f0e5a77-931c-4fcb-93f7-16b69649d369",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5eb69f28-c413-4a0a-b115-ac32ff596a19",
"db_language_id": "5619d2ef-23ea-465b-b3e8-f7843b308447",
"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-02-04T15:28:01.8795154+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4387dd46-7030-4a57-bad6-d0d9cb3fd0b2",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "37c82ba8-1db3-43f7-b2b9-aeca10a4c498",
"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": "01923799-32ad-4bc2-8a0e-faa66b1f2ed2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f6e63374-f6ac-477a-9bf5-d7af0f9057f0"
},
"suggested_date_start": "2026-02-04T15:28:01.8795154+00:00",
"skill_id": "2d1aef6d-452a-45da-9a29-f55e5af64868",
"skill_code": "sample string 32",
"skill": {
"id": "cf93d4c0-c2f0-44d3-a0e9-b3e4cb85707f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3f8e7e3a-086f-4a8f-9fb2-aca0e20eb20a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec9d726d-4735-431b-8049-f5bf57a82592",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61d8beda-62ec-4425-997e-8b89cfd53f0f",
"db_currency_id": "9c42ef15-337b-448b-94ad-6ae6487c99d4",
"db_language_id": "dcd68d6e-ce46-4312-a732-01cf5930c151",
"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-02-04T15:28:01.8795154+00:00"
},
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "419edf9b-4fc2-40b2-9884-a94c0b6f04b9",
"date_reported_by_company": "2026-02-04T15:28:01.8795154+00:00",
"id2": 36,
"company_id": "c5b774c4-d5e1-4ee6-b474-c1f87523fd84",
"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": "f74b4ce3-7364-480e-87f9-f3e4d0026e85",
"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-02-04T15:28:01.8795154+00:00"
},
"work_instruction_details_id": "65f2f7b6-b216-4692-947a-08f81bb494e5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d55fd3b2-4c55-4c0b-aa08-8590305f4140",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "29ec55cc-fa02-40af-89a0-a404554a68ec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-04T15:28:01.8795154+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": "7a09d7e9-6956-4497-848f-35f7c4de34ac",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-04T15:28:01.8795154+00:00"
}