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": "705502d4-ce99-4bea-a0e6-1902a20f7383",
"jobs_id": "16f5915f-200f-4125-83fb-07d86d48c5d9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "addbe787-e206-42b5-ba6d-e8d0fed7ebbd",
"_parent_id": "8bbfb81a-d249-4050-aad2-cb272f47a4fe",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b911b2ae-dfd4-45dd-a729-36634b5e3afa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "26f41eaa-3b90-45a2-ad6b-9cd47acaf890",
"_parent_id": "3ce9e6c2-7397-4c79-954c-d73c55778b2f",
"root_parent_id": "58cf4756-9ae7-4059-8a2c-3b4c718fdea3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2d42496d-c0c5-473c-8122-0837766f6b1a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "57c3361c-54ba-435b-b184-b4f8fc247545",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ee83470-2b99-47d6-831e-06dc9c50c505",
"_parent_code": "sample string 6",
"sales_organization_id": "8cf19163-3b2a-4e93-be13-e43680f12d7a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+00:00"
},
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00"
},
"equipment_model_id": "12332b4f-a502-4ce4-a9ca-6dcaa0ea06c4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bcd4fa88-64da-4085-a9e9-187b5c13a0aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2e25cc6c-2017-4db5-9e58-faa031ce6a81",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ee37bd33-692a-4e67-986b-a853f0e4a93f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ad1be1a6-13d1-4007-953b-7b0949437640",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+00:00"
},
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00"
},
"equipment_family_id": "ce8eb794-32d4-47fe-87df-b41cc31182ba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "57c3361c-54ba-435b-b184-b4f8fc247545",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ee83470-2b99-47d6-831e-06dc9c50c505",
"_parent_code": "sample string 6",
"sales_organization_id": "8cf19163-3b2a-4e93-be13-e43680f12d7a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+00:00"
},
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00"
},
"date_in_production_since": "2025-12-22T19:51:56.6703666+00:00",
"date_out_of_production_since": "2025-12-22T19:51:56.6703666+00:00",
"date_end_support": "2025-12-22T19:51:56.6703666+00:00",
"sales_organization_id": "c52c825c-bb54-470b-8703-95b9d42dc95c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+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-12-22T19:51:56.6703666+00:00"
},
"project_status_id": "4a6191a8-e19f-4611-8a15-e92e09fd8bbc",
"project_status_code": "sample string 10",
"project_status": {
"id": "029f24ea-7470-45cb-aedc-1e0a69eb0fe5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "62da8212-bad6-40bd-9ddd-644bdac253f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00"
},
"company_id": "76fcc9d4-ba9d-4743-9f1e-7ca6185bb19b",
"company_code": "sample string 12",
"db_address_id": "f0811848-d048-46fb-b6ab-ea5a46bb9521",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5018715c-43aa-4672-b53a-852e75f5142d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "caea8183-ac38-4df7-a8ea-9eece947d960",
"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-12-22T19:51:56.6703666+00:00",
"date_create": "2025-12-22T19:51:56.6703666+00:00",
"date_update": "2025-12-22T19:51:56.6703666+00:00",
"updated_by_user_id": "3cf7e8d8-d43b-45ce-b01b-56b06c903629",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-22T19:51:56.6703666+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-12-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-22T19:51:56.6703666+00:00",
"date_last_job": "2025-12-22T19:51:56.6703666+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-22T19:51:56.6703666+00:00",
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00",
"is_mobile_installation": true
},
"job_type_id": "dbe10a3b-67d6-40cd-80d8-5b7c7a55ecd3",
"job_type_code": "sample string 7",
"job_type": {
"id": "264132f9-0698-46f9-8c5c-370cd8e89362",
"name": "sample string 2",
"sales_organization_id": "a2b04e52-ac39-4869-bcf3-7b8b21a505d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00",
"code": "sample string 7"
},
"job_priority_id": "55d4e941-aaba-47d4-aa86-6bfab80bd2fa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "76f747bf-7145-4ee8-aff4-9b4676910eb3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cdcf61b5-e4f8-47f2-b475-4b491929a74c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00"
},
"job_status_id": "45fa5783-3045-4a7f-a423-ce79fbceda5d",
"job_status_code": "sample string 11",
"db_address_id": "936fefdf-9f26-4cac-b059-74c2540b239b",
"contact_id": "43b69106-2d4c-40ab-8ddc-4fb21b359b1e",
"requested_by_company_id": "19b5c320-5530-4df7-b501-b979647239dc",
"requested_by_contact_id": "226db28a-1d5c-42ef-ab67-b3db2b7a2d97",
"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-12-22T19:51:56.6703666+00:00",
"due_date": "2025-12-22T19:51:56.6703666+00:00",
"date_create": "2025-12-22T19:51:56.6703666+00:00",
"date_update": "2025-12-22T19:51:56.6703666+00:00",
"date_closed": "2025-12-22T19:51:56.6703666+00:00",
"suggested_user_id": "2fed8250-77a0-4e2f-97c2-d831759ef584",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "be8da066-d596-4c32-b8d2-0db745e8a24e",
"db_language_id": "fc4334c7-e8d9-467a-a830-ef3544d1bf10",
"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-12-22T19:51:56.6703666+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fa135b60-44df-4be8-bc84-235d87d3de72",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a47117ba-ec75-4d47-aa09-9d82e6d82e2f",
"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": "92808ba1-946d-4eb4-bd31-755403d085fe",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ffe665e3-681c-4d18-8be5-63a7d8bb3563"
},
"suggested_date_start": "2025-12-22T19:51:56.6703666+00:00",
"skill_id": "6c4870e3-05f4-4d93-babb-bdcc2a49a4b9",
"skill_code": "sample string 32",
"skill": {
"id": "39b86486-e0d3-4057-9c8d-82a603769594",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f04d081c-151d-46da-b272-3ee7a362297e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "755e6ea7-333b-400b-ad85-a4dd8045bae0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a008866-3c1e-45d0-9975-2a3330799e8b",
"db_currency_id": "7476e3ac-ade8-4981-a9fb-36a9e8d3599d",
"db_language_id": "b1e98d7a-040b-45e1-95c7-13cc9e3877c8",
"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-12-22T19:51:56.6703666+00:00"
},
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "964fc895-2e68-4e56-a088-320e965cb438",
"date_reported_by_company": "2025-12-22T19:51:56.6703666+00:00",
"id2": 36,
"company_id": "8623775a-2c82-49bc-802f-8df28a46334a",
"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": "970bf293-8bc1-4ee0-b671-409a76f8ee3b",
"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-12-22T19:51:56.6703666+00:00"
},
"work_instruction_details_id": "c6d790fd-c1bb-4f6e-bbb2-e60a95d7027e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0287783a-40a5-4887-8138-08753887a013",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c556e943-2efc-46ee-a060-3435d95cd378",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-22T19:51:56.6703666+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": "c969040e-6acc-460a-a2e8-6c2311d116b4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-22T19:51:56.6703666+00:00"
}