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": "4e475b44-2fb5-4744-b498-6855edd88f65",
"jobs_id": "0398e7ed-2d03-4add-98de-0d86bff2eea2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "153be587-4fe7-485f-86be-bfc0e2ffb142",
"_parent_id": "619f7fc9-fd70-4db2-b9a6-0c7fbf16ecb2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "660485b0-46a3-46e0-b14a-9eb252724038",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a2e49764-c67f-45c4-905b-6ae69dce1654",
"_parent_id": "bfd8de4f-42b5-486c-a54a-70313edf37b2",
"root_parent_id": "e15bbd4d-7e5b-452e-a25e-fae91d6aa147",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a1b2455d-a22d-498a-a7d7-5b81513470b3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "925a9254-5525-4125-8113-ebb0de774e0c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "21f75dc8-1ca8-4353-8a4d-cf7421b73802",
"_parent_code": "sample string 6",
"sales_organization_id": "8b1fc6d8-0514-4d5a-ba11-63a4c648dce4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+00:00"
},
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00"
},
"equipment_model_id": "9614bb4f-9671-47be-a1e7-7882c6b1bcbe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "057a1705-818e-477f-9b6b-6fe9b462ccb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c0079d7a-fe4c-47d7-8c7c-d9e9188f7990",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dcf4c944-0aa6-4239-ab9b-22d5b265b822",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8934e16b-5d36-4549-8b8e-0f26d0c12146",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+00:00"
},
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00"
},
"equipment_family_id": "4c0b29b4-4c93-4555-aaf7-66baa7fa460f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "925a9254-5525-4125-8113-ebb0de774e0c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "21f75dc8-1ca8-4353-8a4d-cf7421b73802",
"_parent_code": "sample string 6",
"sales_organization_id": "8b1fc6d8-0514-4d5a-ba11-63a4c648dce4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+00:00"
},
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00"
},
"date_in_production_since": "2026-07-25T06:30:58.7319886+00:00",
"date_out_of_production_since": "2026-07-25T06:30:58.7319886+00:00",
"date_end_support": "2026-07-25T06:30:58.7319886+00:00",
"sales_organization_id": "6b67254a-1959-46f5-90d3-843d5caa85cf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+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-25T06:30:58.7319886+00:00"
},
"project_status_id": "769fd9f6-e839-4c32-ac16-67436b67a375",
"project_status_code": "sample string 10",
"project_status": {
"id": "e4d7f3fb-4557-439c-88a0-81e404ac6e03",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9bd2b334-684f-435a-835f-99beb0f0c264",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00"
},
"company_id": "d6c38af0-771b-4928-aa75-cd826638369a",
"company_code": "sample string 12",
"db_address_id": "5f83f2be-2844-4deb-a5f6-67ff9e6d5b12",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ece7073f-1ecc-4e25-bcbb-9ca6bfb6cb5d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "02e3210c-7339-43e0-8bfa-e11ccb9f1b58",
"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-25T06:30:58.7319886+00:00",
"date_create": "2026-07-25T06:30:58.7319886+00:00",
"date_update": "2026-07-25T06:30:58.7319886+00:00",
"updated_by_user_id": "298fb991-1264-40b4-a023-b1766d1c22be",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-25T06:30:58.7319886+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-25T06:30:58.7319886+00:00",
"date_last_job": "2026-07-25T06:30:58.7319886+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-25T06:30:58.7319886+00:00",
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00",
"is_mobile_installation": true
},
"job_type_id": "82400cf1-7f14-4046-bcf1-291e12cb82aa",
"job_type_code": "sample string 7",
"job_type": {
"id": "68304342-2d2e-45e0-a877-ae51da790453",
"name": "sample string 2",
"sales_organization_id": "19db72f2-1619-441b-b6e8-4263aad26b5d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00",
"code": "sample string 7"
},
"job_priority_id": "3a701c28-cffe-4752-9dc1-0d105c556e18",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "eb3295ce-999d-44bc-9e47-af6f72c889d6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a4312db1-57d5-4d3e-988f-9e4486a0f62a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00"
},
"job_status_id": "6a3ca134-2608-4d91-a0c1-a9e80eb4ebb3",
"job_status_code": "sample string 11",
"db_address_id": "d57cecfe-197c-4d17-865b-d0ddb697d95a",
"contact_id": "7cc25def-f1d9-4fd3-b1a1-3317ef5a5ea5",
"requested_by_company_id": "eebb4255-65f3-4e10-a856-ff84da528063",
"requested_by_contact_id": "93ae9b23-be86-4d00-9550-d5ca579e7ca5",
"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-25T06:30:58.7319886+00:00",
"due_date": "2026-07-25T06:30:58.7319886+00:00",
"date_create": "2026-07-25T06:30:58.7319886+00:00",
"date_update": "2026-07-25T06:30:58.7319886+00:00",
"date_closed": "2026-07-25T06:30:58.7319886+00:00",
"suggested_user_id": "48872eca-0893-4c04-8c81-4db3d8d1db89",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "15134f03-c56e-4b38-a29c-2a5c7ee79eca",
"db_language_id": "84771eb4-6a58-4ec8-96c1-2a193dc6da45",
"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-25T06:30:58.7319886+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1bf4d16a-b581-4fb2-8229-bc3687f5d7ae",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f7e7fc6f-a45e-4882-bc24-4c8dc4380f69",
"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": "270a3237-95c5-4fbf-97f7-747b22a1850d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d30a27e6-f09b-4e0a-bb65-92baf151b756"
},
"suggested_date_start": "2026-07-25T06:30:58.7319886+00:00",
"skill_id": "50a77aa8-430e-4009-aa56-af0e0dfb240c",
"skill_code": "sample string 32",
"skill": {
"id": "d950a245-edff-42d4-af8a-778ca806b3af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c83a4a71-a302-4a96-8549-d1b807548cf2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "897496a1-c493-41f7-b5e9-c361a63edf32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49f33e99-fc61-4633-853f-45cee4dc0f55",
"db_currency_id": "40d3eaad-d0c1-4341-8166-aaa52a8da637",
"db_language_id": "cdfaf74c-956d-4784-b3bb-468fcede5e50",
"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-25T06:30:58.7319886+00:00"
},
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b4474271-b2d0-43f1-ad99-77e3c9771555",
"date_reported_by_company": "2026-07-25T06:30:58.7319886+00:00",
"id2": 36,
"company_id": "71374ef4-2545-45a3-857c-6d8b06b9505b",
"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": "77314384-8b3a-4f1a-8a9c-608ef6dd5788",
"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-25T06:30:58.7319886+00:00"
},
"work_instruction_details_id": "50d62f0c-e921-42df-83ae-cdb56ec7f488",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "02db2342-e4b6-4ab7-8a21-8875a9485b35",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "30f5b007-4ee0-4790-aa74-bcab5fc5393d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-25T06:30:58.7319886+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": "8d32ef62-811b-41a5-b9be-cb36b9eac812",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-25T06:30:58.7319886+00:00"
}