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": "986b4628-48b6-4fb2-9fbe-f71bc922ea70",
"jobs_id": "9fe48f1d-ba72-4070-a3eb-f571d4aa9826",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "528e1cdc-c99a-4e77-89a5-8bc7839056f9",
"_parent_id": "358e09a2-4e95-4a6d-ac43-bb8544efcddc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "44e69bd8-edaa-4154-823d-8dd1266de38e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d4a32a5e-5ddd-446a-bd82-02d4439eb819",
"_parent_id": "3a1c83e7-779d-43d2-a972-bcc94cd613e1",
"root_parent_id": "65e7ee11-6ae7-4fb5-86b0-90629ff1a1b9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "80b2a8b1-342c-428d-832d-e4a1dc0aaec4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9635423e-bfad-42ba-b0ab-0112abd28416",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94e71a2a-ed14-4445-8f87-c3da48ea72f2",
"_parent_code": "sample string 6",
"sales_organization_id": "7a432d33-d427-4c2f-b2fa-4d51cfef3bfc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+00:00"
},
"modified_dateutc": "2026-06-15T22:36:54.3651162+00:00"
},
"equipment_model_id": "e7948f2c-a464-4ebf-86b1-6e3790073bb9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d9aa479a-9c35-43c2-9593-c6fc111d3ee6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0c9a1011-88da-474b-9cc6-2b5474152fb0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d57a3abf-0670-4e62-a296-bfa49e3c5b8b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "708d04ec-9a88-4d64-a35a-46ea6132db48",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+00:00"
},
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00"
},
"equipment_family_id": "9908d18f-7a12-4df1-9223-eb79aa7df8ba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9635423e-bfad-42ba-b0ab-0112abd28416",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94e71a2a-ed14-4445-8f87-c3da48ea72f2",
"_parent_code": "sample string 6",
"sales_organization_id": "7a432d33-d427-4c2f-b2fa-4d51cfef3bfc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+00:00"
},
"modified_dateutc": "2026-06-15T22:36:54.3651162+00:00"
},
"date_in_production_since": "2026-06-15T22:36:54.380742+00:00",
"date_out_of_production_since": "2026-06-15T22:36:54.380742+00:00",
"date_end_support": "2026-06-15T22:36:54.380742+00:00",
"sales_organization_id": "0d4fcab5-0b61-483f-9cf2-377446418a1f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+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-15T22:36:54.380742+00:00"
},
"project_status_id": "b2014e6e-20f4-4a1e-b716-d6da91827813",
"project_status_code": "sample string 10",
"project_status": {
"id": "7083d855-2b80-4321-8cc3-2d823ea1350e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0882e496-2dcc-4ff8-aa2b-d6449f6aae0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00"
},
"company_id": "4854226a-88e4-4ba3-b78d-4f4073bc98de",
"company_code": "sample string 12",
"db_address_id": "b52f45c3-b876-41ce-9ce1-405b12b56d07",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "714997ba-b8f2-4ba5-983f-6d75670255fd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "51d0eb34-c4a1-4e69-940c-f25a0fb54b1d",
"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-15T22:36:54.380742+00:00",
"date_create": "2026-06-15T22:36:54.380742+00:00",
"date_update": "2026-06-15T22:36:54.380742+00:00",
"updated_by_user_id": "2438fc1c-7d01-4166-acdd-6b7853a3bd40",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-15T22:36:54.380742+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-15T22:36:54.380742+00:00",
"date_last_job": "2026-06-15T22:36:54.380742+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-15T22:36:54.380742+00:00",
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00",
"is_mobile_installation": true
},
"job_type_id": "8196256f-a248-4091-b115-4eb8303a6e2d",
"job_type_code": "sample string 7",
"job_type": {
"id": "d8d1e902-c434-4dc2-bd8f-789eda3206bb",
"name": "sample string 2",
"sales_organization_id": "9ce7bf72-c581-4f06-8ffd-f608393aa7d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00",
"code": "sample string 7"
},
"job_priority_id": "d50c385d-2f6c-4dde-9b7d-70a0091ad9b5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "529e65dc-3541-44ce-a5c3-2b10bb210594",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4c7027f8-2b98-4950-beff-26bfddc24c12",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00"
},
"job_status_id": "0541db4f-6110-4c3d-8e9c-77a7fc22e607",
"job_status_code": "sample string 11",
"db_address_id": "0074d1a7-cd29-455f-8d1c-7cafadb8f33c",
"contact_id": "a53830e1-8cae-4576-bf65-8db65eab9a63",
"requested_by_company_id": "f5ab1638-c6bd-407e-b8a7-e9186a22295d",
"requested_by_contact_id": "a9d3032d-e079-4856-a202-ab21b9a5c4fd",
"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-15T22:36:54.380742+00:00",
"due_date": "2026-06-15T22:36:54.380742+00:00",
"date_create": "2026-06-15T22:36:54.380742+00:00",
"date_update": "2026-06-15T22:36:54.380742+00:00",
"date_closed": "2026-06-15T22:36:54.380742+00:00",
"suggested_user_id": "95579734-7697-4678-bfd0-1993eb6147ae",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4207035f-1314-46ab-9211-4414716d2c78",
"db_language_id": "b8600ef5-8a5d-4f10-b5e3-40b6acf3cde2",
"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-15T22:36:54.380742+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aad15419-1739-42c5-aaff-e3d14f1086ea",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "02ae4ef2-fa5a-45cf-a6c9-b5c849005981",
"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": "def320d5-19b4-452e-adc8-ea1c80554183",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c10c99f1-8454-4386-895a-fa74fa18c4cd"
},
"suggested_date_start": "2026-06-15T22:36:54.380742+00:00",
"skill_id": "666f1087-3476-4ad6-9886-707b93664b67",
"skill_code": "sample string 32",
"skill": {
"id": "76714f6a-1d4e-46f7-a07f-16bbf93e13cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2f848c84-ee63-4c86-8610-94102938fa33",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11be449e-b860-4be3-99aa-ef13c359c615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "802be92d-ee2a-4b1f-9709-9d81bcb9d31a",
"db_currency_id": "df1d13a7-8c9b-4417-92f9-713d28df3695",
"db_language_id": "09ca7a4e-80b5-452d-a3ab-a490bcb392aa",
"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-15T22:36:54.3651162+00:00"
},
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3f6362b6-db57-4ff4-959b-a602941a1ac5",
"date_reported_by_company": "2026-06-15T22:36:54.380742+00:00",
"id2": 36,
"company_id": "55c285c5-bd08-493a-8877-d42ef1162906",
"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": "914ba759-7de5-4a5f-8a6a-53d4e27de2a7",
"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-15T22:36:54.380742+00:00"
},
"work_instruction_details_id": "d2ee03c9-d65e-4c3a-92f2-0069222d9fd9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fc0b2c70-896f-43ee-a5b6-0838804976f0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e1956fe6-1884-4e10-b17d-eb74f01c4004",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-15T22:36:54.380742+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": "35cc4cd0-9b04-4fb0-b8a2-8dd31e3af37c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-15T22:36:54.380742+00:00"
}