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": "39edfe56-aee3-4890-82e6-632be1e1bd4c",
"jobs_id": "61041c2d-f249-4db9-b5be-7016deb2ed65",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "333c00ba-047e-436b-a23b-9dc2c62463b6",
"_parent_id": "ffa0f712-c229-4be8-928e-2dde38daf0b3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8310d03e-8364-42a0-9716-e6f2833a2e40",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5bcdb2f0-698b-4a66-a9ec-e91468a41c26",
"_parent_id": "51f3a22f-f007-41b2-ae1b-4b962b33dda7",
"root_parent_id": "a3636864-c2ab-4257-8bb2-75536164cdba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a24af759-aece-48c8-9aa8-eceb6e750a02",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c806e65f-67de-4742-9124-6622e8c52c38",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e2e5a3a-0901-4185-a07a-684518412a78",
"_parent_code": "sample string 6",
"sales_organization_id": "f06b92b2-69bf-48ba-9da7-fdbd0a0a29f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+00:00"
},
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00"
},
"equipment_model_id": "4e7e188b-82cd-4a8d-bc16-bc4c5f6645fc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8c541d2b-a742-49f9-9b72-a5aaf67b3d8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5a31efdb-80f2-4ab5-bd0a-e643104c1852",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f0013f20-3e51-4a44-9839-bcf2cba58737",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "228dd6fc-cf2d-426f-ac10-c1423c1a4f0d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+00:00"
},
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00"
},
"equipment_family_id": "409c9912-ca6d-4838-8306-9c841e740cf2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c806e65f-67de-4742-9124-6622e8c52c38",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e2e5a3a-0901-4185-a07a-684518412a78",
"_parent_code": "sample string 6",
"sales_organization_id": "f06b92b2-69bf-48ba-9da7-fdbd0a0a29f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+00:00"
},
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00"
},
"date_in_production_since": "2026-06-25T16:47:10.6512087+00:00",
"date_out_of_production_since": "2026-06-25T16:47:10.6512087+00:00",
"date_end_support": "2026-06-25T16:47:10.6512087+00:00",
"sales_organization_id": "9fd23a14-af3d-4dcf-8fd2-d05b408c3289",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+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-06-25T16:47:10.6512087+00:00"
},
"project_status_id": "9ea04a3b-3ee0-43d0-916d-ab2755a7df90",
"project_status_code": "sample string 10",
"project_status": {
"id": "ac912c7e-74be-4956-88f5-a45569cb56aa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "76ca8d2e-5f81-4d37-a9df-5a97c2e1517f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00"
},
"company_id": "7a948080-a4a2-41af-aae2-02b05dadb2e8",
"company_code": "sample string 12",
"db_address_id": "318b0606-d98e-4c76-9c13-65618c0db19f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ae8e2301-956b-418f-b922-1e70e0239238",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8c93bf29-d15e-4ebb-97d2-0d8948bfd0fe",
"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-06-25T16:47:10.6512087+00:00",
"date_create": "2026-06-25T16:47:10.6512087+00:00",
"date_update": "2026-06-25T16:47:10.6512087+00:00",
"updated_by_user_id": "fbcdcc14-6cf4-4eda-b815-b27bf02e617f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-25T16:47:10.6512087+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-06-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-25T16:47:10.6512087+00:00",
"date_last_job": "2026-06-25T16:47:10.6512087+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-25T16:47:10.6512087+00:00",
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00",
"is_mobile_installation": true
},
"job_type_id": "8ddf8d7e-7f43-4c7e-b358-39ebe99216cf",
"job_type_code": "sample string 7",
"job_type": {
"id": "2b6c6ffd-8846-4deb-9407-13ae99d8debf",
"name": "sample string 2",
"sales_organization_id": "320eebca-5a00-4c18-a94e-8d14cf21588f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00",
"code": "sample string 7"
},
"job_priority_id": "9062f5b2-d875-4cb2-8993-71f258c7da5e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2dbc33fb-b645-4585-a590-3039c90bed5e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c42578c3-7c2f-46b9-a75c-7e36408b13bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00"
},
"job_status_id": "fdd7bb58-4155-4a1d-93b7-a034fad3e378",
"job_status_code": "sample string 11",
"db_address_id": "3886c900-12fe-4695-904e-979d7aea34f7",
"contact_id": "7ccf9b69-ef99-499f-bc26-cca1ec13270c",
"requested_by_company_id": "5a2ac741-6611-40e9-a28c-dd376641f05a",
"requested_by_contact_id": "4c979647-4115-4d6e-a14d-89be621bea63",
"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-06-25T16:47:10.6512087+00:00",
"due_date": "2026-06-25T16:47:10.6512087+00:00",
"date_create": "2026-06-25T16:47:10.6512087+00:00",
"date_update": "2026-06-25T16:47:10.6512087+00:00",
"date_closed": "2026-06-25T16:47:10.6512087+00:00",
"suggested_user_id": "b0f83662-6653-470a-8ca1-e62da056976e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8110ba1b-6f0e-40c7-9de3-a51eb0d504b9",
"db_language_id": "f9429a88-1600-4529-9445-aef94a18e8bc",
"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-06-25T16:47:10.6512087+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc6b4e80-f82c-445b-accc-ed3d3ae7ee90",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d01e9b94-f93d-4376-b695-ab21432a47ca",
"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": "a144303e-b553-4431-95bd-1bc1f257b617",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ca2996f7-9d30-44b8-83f4-0276ca7d64a0"
},
"suggested_date_start": "2026-06-25T16:47:10.6512087+00:00",
"skill_id": "85b90cfb-d618-4e67-bea1-d9feb69acd32",
"skill_code": "sample string 32",
"skill": {
"id": "ceef53ff-ad69-4a8c-ae82-33685cd713c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "95aae8cd-b353-4c3d-a538-4244904f32bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac67b6e2-f25e-42f7-b1ac-dc8f65a2d68e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b390cca9-938a-48a4-9c5a-9d43fbbd2727",
"db_currency_id": "514ae20e-fbd4-4cfb-add2-a2724d5a02f8",
"db_language_id": "a919ff1b-2318-433f-bc0d-183f75571004",
"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-06-25T16:47:10.6512087+00:00"
},
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "075865bc-e95b-4401-bc9e-daea944bfc7c",
"date_reported_by_company": "2026-06-25T16:47:10.6512087+00:00",
"id2": 36,
"company_id": "eea381f2-c734-4a36-aea3-f15ef1ece024",
"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": "b0352ef4-b2b4-4f6a-8ca7-cbe5e1e6700d",
"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-06-25T16:47:10.6512087+00:00"
},
"work_instruction_details_id": "b815b895-c1ac-4fd3-ae7d-e7a5c07f5399",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "64dffe67-3a5a-4bfb-90dc-9168b5d37512",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e727cc4b-175c-482f-b040-bd3ff614d287",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-25T16:47:10.6512087+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": "311405f7-2d22-4bf4-9689-7c8dcc09ae8d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-25T16:47:10.6512087+00:00"
}