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": "f994587f-05d2-4867-80e1-a8d194aead49",
"jobs_id": "81a40b55-b18f-49ba-b31c-4cd37725a937",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dbf64009-c887-4c71-9cf8-772fedb34d72",
"_parent_id": "2ddcf2a7-f74c-4bd4-a1f0-96e5bf9b7ce2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "84103722-e488-49a9-ba27-f648ce59a554",
"project_reference_back_office": "sample string 5",
"project": {
"id": "75495743-2a9a-4a66-8f4e-5017cf181e60",
"_parent_id": "c40b866e-aeb2-4441-b2c5-05731d3b0379",
"root_parent_id": "bd617c67-e937-4b9d-87aa-9e499aefb35b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "75ce5628-2dc8-4142-be14-f08e5a2b91e9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f48c8171-854b-4319-9c8c-7c6c94a0be56",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "47fa2f8b-0cc4-4c0b-a49f-3ad425900075",
"_parent_code": "sample string 6",
"sales_organization_id": "518e8105-0c32-461e-88ca-832685ebbd1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+00:00"
},
"modified_dateutc": "2025-11-04T08:37:41.7010398+00:00"
},
"equipment_model_id": "71eac73a-82a1-4a15-ad3e-6bdb765b2bb2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "202bcd85-19be-4a06-8b9f-10a192a59bdd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1a07f765-7411-49e3-8f50-0f6d2175fdea",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dc7e2055-1eef-46a1-992b-2f6bef645772",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "975cc779-06d3-4b50-9ae7-bd39268ad41c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+00:00"
},
"modified_dateutc": "2025-11-04T08:37:41.7010398+00:00"
},
"equipment_family_id": "15466bd4-ccc6-4dfa-b637-ab59cf9425ea",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f48c8171-854b-4319-9c8c-7c6c94a0be56",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "47fa2f8b-0cc4-4c0b-a49f-3ad425900075",
"_parent_code": "sample string 6",
"sales_organization_id": "518e8105-0c32-461e-88ca-832685ebbd1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+00:00"
},
"modified_dateutc": "2025-11-04T08:37:41.7010398+00:00"
},
"date_in_production_since": "2025-11-04T08:37:41.7166653+00:00",
"date_out_of_production_since": "2025-11-04T08:37:41.7166653+00:00",
"date_end_support": "2025-11-04T08:37:41.7166653+00:00",
"sales_organization_id": "1ac041a4-eb74-408e-acfe-22ea54df22c5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+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": "2025-11-04T08:37:41.7166653+00:00"
},
"project_status_id": "6ec586d7-2978-45d6-9fb0-a0f2c67d2174",
"project_status_code": "sample string 10",
"project_status": {
"id": "8d49503e-e2e5-486e-a630-7aaa1bb328e7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2e94522c-5494-4be9-9c26-1bd516215d3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T08:37:41.7166653+00:00"
},
"company_id": "034a672a-3114-4870-8e1c-29b1914937ed",
"company_code": "sample string 12",
"db_address_id": "955d3b0e-8782-4eaa-834d-2a58e5a97db1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c0dbb3c5-e680-44d9-8b23-4f48af0297bb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5adb55aa-a579-4f2c-a75a-a84787c8ce48",
"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": "2025-11-04T08:37:41.7166653+00:00",
"date_create": "2025-11-04T08:37:41.7166653+00:00",
"date_update": "2025-11-04T08:37:41.7166653+00:00",
"updated_by_user_id": "99c540af-d12c-4d2d-a499-d413e19339b5",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-04T08:37:41.7166653+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": "2025-11-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-04T08:37:41.7166653+00:00",
"date_last_job": "2025-11-04T08:37:41.7166653+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-04T08:37:41.7166653+00:00",
"modified_dateutc": "2025-11-04T08:37:41.7166653+00:00",
"is_mobile_installation": true
},
"job_type_id": "08b948aa-3116-4dc6-971d-ecad8557f4df",
"job_type_code": "sample string 7",
"job_type": {
"id": "3ff6e920-e2b4-40f1-b350-118aa81f852d",
"name": "sample string 2",
"sales_organization_id": "a0d6b17f-405c-4cbe-bddf-facc7cde4f7e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-04T08:37:41.7166653+00:00",
"code": "sample string 7"
},
"job_priority_id": "47e5414f-3e08-4d46-ae41-ba35223e20da",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a7d918d8-9d11-46e8-a64f-5e7437f03c4c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "33b4705f-9ce6-4c19-85ff-c38bc2cd6cfa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T08:37:41.7322892+00:00"
},
"job_status_id": "79544858-00ec-4d38-87c1-eb27b66b3e19",
"job_status_code": "sample string 11",
"db_address_id": "4ca303eb-a6b2-47f0-985f-3fdb24601fbb",
"contact_id": "833208b8-4e7a-422f-aad5-10b774c7ace3",
"requested_by_company_id": "c8bb3c14-7d8e-4d27-a7c6-3e2a1d98b574",
"requested_by_contact_id": "be81894e-c9b0-4193-8d69-8fa4862a8359",
"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": "2025-11-04T08:37:41.7322892+00:00",
"due_date": "2025-11-04T08:37:41.7322892+00:00",
"date_create": "2025-11-04T08:37:41.7322892+00:00",
"date_update": "2025-11-04T08:37:41.7322892+00:00",
"date_closed": "2025-11-04T08:37:41.7322892+00:00",
"suggested_user_id": "02fc4bf8-198d-44fa-9fa3-79aa6650f912",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "77ce42df-e8d4-4e0b-b04b-5ffd6cc7177f",
"db_language_id": "9b963a19-2857-48fa-8daf-fe27b1ff4f88",
"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": "2025-11-04T08:37:41.7322892+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "160a73c3-e2f5-42fb-80aa-1f8b4cea1a26",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a3ff8f16-29d2-486f-8c34-ba2dcf0c6171",
"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": "bc28f4be-5c4f-4147-9f0d-92e72cf05a1b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-04T08:37:41.7322892+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9fc1daf9-7836-4041-8ad6-15e97d1cef2b"
},
"suggested_date_start": "2025-11-04T08:37:41.7322892+00:00",
"skill_id": "98c58be7-9633-4a29-bd8c-aad47c7caf53",
"skill_code": "sample string 32",
"skill": {
"id": "e4143d0e-4828-43d5-b3f6-f1826b469f50",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9b899cff-3460-4c5e-9388-6f3b6bdc0d44",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41df719c-d537-43e1-beba-8ae4067124d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c46303fc-c1ab-4298-832f-308f70989dbb",
"db_currency_id": "5dc06c7b-bc4b-4ca6-8c60-593e3800b2f2",
"db_language_id": "b9698731-3042-4dd2-9ef5-b4e3724596a1",
"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": "2025-11-04T08:37:41.7010398+00:00"
},
"modified_dateutc": "2025-11-04T08:37:41.7322892+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "099299da-9641-4083-b3ec-b3fbde637d72",
"date_reported_by_company": "2025-11-04T08:37:41.7322892+00:00",
"id2": 36,
"company_id": "f8b6160b-1fce-4aac-8d43-940a56166f34",
"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": "348617bd-c757-49bc-9ec9-d51e3c0aa1d0",
"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": "2025-11-04T08:37:41.7322892+00:00"
},
"work_instruction_details_id": "915aaabf-88d5-4838-ba5a-3e0ae8dc7a70",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0b4ca393-9e0b-4ecc-9dcc-96535b00373a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2fc7c77d-5afb-4e01-a5a1-59725e9cfa5b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-04T08:37:41.7322892+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": "c2c83df1-f9e6-4667-bc13-5317fd1ac243",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-04T08:37:41.7322892+00:00"
}