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": "176f59ed-6db3-45fa-b0c7-9fbc8820954a",
"jobs_id": "0cd55730-3705-4f03-a2eb-68c31b994306",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "05a050ff-73f6-4306-b432-e3ae660f446f",
"_parent_id": "053cf280-2af6-4397-b1c4-d5433308497f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "21356591-a91e-4b98-baa7-1478d4931412",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ceeef5aa-d839-4964-a86e-250fbedd9764",
"_parent_id": "c96e2ab9-f916-46fc-8e39-eb39265ad2c7",
"root_parent_id": "c46b5c55-29d7-49e6-bcd6-244b1a78a7d7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a9e7bd24-2859-4f1e-ac34-95b41b9b3bea",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4ae89e0d-ef4c-4969-a0bc-28b77fad8050",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b6714d41-bd9a-4b82-b1d4-6c62ec702514",
"_parent_code": "sample string 6",
"sales_organization_id": "c79c6c8d-feba-49e2-8b00-946b161a9f2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+00:00"
},
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00"
},
"equipment_model_id": "97266107-bc18-4508-9ebf-d84c9a7b4539",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a4e6b4e6-89ad-4b8b-beb8-24b41c594c23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d2f07412-8d25-4127-90c3-92c1d95004b0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "96979f53-28b0-4111-8ae8-ec94df546fa6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7c08d67e-3f19-4ac4-bd2f-5087b011e6cb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+00:00"
},
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00"
},
"equipment_family_id": "9ebaf3ee-81ea-458a-ab91-6deb4257d5d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4ae89e0d-ef4c-4969-a0bc-28b77fad8050",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b6714d41-bd9a-4b82-b1d4-6c62ec702514",
"_parent_code": "sample string 6",
"sales_organization_id": "c79c6c8d-feba-49e2-8b00-946b161a9f2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+00:00"
},
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00"
},
"date_in_production_since": "2026-11-09T09:11:50.9525617+00:00",
"date_out_of_production_since": "2026-11-09T09:11:50.9525617+00:00",
"date_end_support": "2026-11-09T09:11:50.9525617+00:00",
"sales_organization_id": "44694dfa-b065-4b6d-a85a-d7390904f51f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+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-11-09T09:11:50.9525617+00:00"
},
"project_status_id": "9bd9f04b-4441-4a18-b702-8320f2922d84",
"project_status_code": "sample string 10",
"project_status": {
"id": "fa1e3a10-13e8-4b20-ba4e-bdf8cce6c269",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c729fe9f-2add-42a4-9ecf-be31690c2ffb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00"
},
"company_id": "91a189b5-5aab-4163-b1fd-956ad1291f58",
"company_code": "sample string 12",
"db_address_id": "66ae2531-6c61-479a-a4f9-df4d7b67800a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3a3d4f90-6a92-4e24-a980-e7608d32b144",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4c03aaa9-9aba-41e9-9425-f8899b4562e7",
"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-11-09T09:11:50.9525617+00:00",
"date_create": "2026-11-09T09:11:50.9525617+00:00",
"date_update": "2026-11-09T09:11:50.9525617+00:00",
"updated_by_user_id": "1f088af1-5a3e-4b8e-9830-d1facd5b9bc7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-09T09:11:50.9525617+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-11-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-09T09:11:50.9525617+00:00",
"date_last_job": "2026-11-09T09:11:50.9525617+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-09T09:11:50.9525617+00:00",
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00",
"is_mobile_installation": true
},
"job_type_id": "12e8da35-def8-4adc-9fa8-83b7105db16a",
"job_type_code": "sample string 7",
"job_type": {
"id": "20a5ac86-e906-440a-91c5-13d2fe6bfb2f",
"name": "sample string 2",
"sales_organization_id": "efffcb1f-368b-45d9-809a-aa3914ee808e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00",
"code": "sample string 7"
},
"job_priority_id": "dce6b0ef-8c5d-4f80-b755-9b57c6393e19",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "52004313-f19f-45ce-a915-933e69c907fd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "db66b122-fddd-45e1-9a6d-276dcb3491d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00"
},
"job_status_id": "5f5e4cda-59ce-4190-8396-352fd2b54102",
"job_status_code": "sample string 11",
"db_address_id": "b283a829-bae8-491d-b4ea-704cedf1c0a0",
"contact_id": "953f3bb6-7cf7-4ca6-b3d8-6e4ce264ca9f",
"requested_by_company_id": "a852d426-3cbd-412f-9b30-1b3924372db2",
"requested_by_contact_id": "30d0994e-6db9-4fdc-bf75-d1de51e03f8d",
"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-11-09T09:11:50.9525617+00:00",
"due_date": "2026-11-09T09:11:50.9525617+00:00",
"date_create": "2026-11-09T09:11:50.9525617+00:00",
"date_update": "2026-11-09T09:11:50.9525617+00:00",
"date_closed": "2026-11-09T09:11:50.9525617+00:00",
"suggested_user_id": "20b9a72b-dcce-4673-86b5-c03aed273ebc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "69372f2a-f1f7-4912-b3ae-41448e2d081d",
"db_language_id": "7d36a344-5bfb-4e62-93c3-7b76afd3f978",
"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-11-09T09:11:50.9525617+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7127f1c3-3b71-4cc5-bafe-b094aeaed866",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "14a2de7c-018d-4d07-b431-2a43833eeeb6",
"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": "d304ce3d-1fc4-4b74-bd89-8dc96dbc981c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-09T09:11:50.9525617+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aa37f5c6-74c5-4f2f-9126-15b2b4c1ac6a"
},
"suggested_date_start": "2026-11-09T09:11:50.9525617+00:00",
"skill_id": "3745c223-bc23-49e9-a8e9-755fdaf8fa7d",
"skill_code": "sample string 32",
"skill": {
"id": "92646451-643d-4350-b749-25c6baef664e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dae80b27-ee89-4234-a823-ff13305033be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38667dd4-69bc-4dfe-a6f4-37f89f41f272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f89cc613-7096-4b76-ade5-3d5e7575b42d",
"db_currency_id": "fc352fa1-0530-476b-896c-19e2b4aa101b",
"db_language_id": "ad6c4718-315f-45e5-95fe-873ea6326d1a",
"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-11-09T09:11:50.9525617+00:00"
},
"modified_dateutc": "2026-11-09T09:11:50.9641057+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d3e68ca6-eac7-4eb7-bc1e-ef08385667fa",
"date_reported_by_company": "2026-11-09T09:11:50.9641057+00:00",
"id2": 36,
"company_id": "d548a029-6c5b-4875-8fbd-c5c83e3061d1",
"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": "c6e66348-615d-4414-a098-13d81abad8fe",
"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-11-09T09:11:50.9641057+00:00"
},
"work_instruction_details_id": "eaffeaf2-8ce7-4435-907a-c269e124bb32",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "89b401b5-ffec-4f9f-a0ea-45887ba1e3bc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "76316430-11ed-4e24-aead-16c142354b8c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-09T09:11:50.9641057+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": "95c5e472-0bc6-4f30-99ed-e7157e986755",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-09T09:11:50.9641057+00:00"
}