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": "2df57e21-099c-4939-b2b3-25dc4238b076",
"jobs_id": "944b67be-6a8a-4182-b8ec-863602e17487",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9bccb688-a557-4f76-8e61-74a84670bd25",
"_parent_id": "4e306625-6845-48fe-9a88-92f998f79584",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "41394b7d-43be-4a15-8a49-a9deeb802abd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f24d37e0-8175-4a12-a2fa-c6ba7917bd3c",
"_parent_id": "03d6bf18-509a-43a3-92ef-4c775c397ffc",
"root_parent_id": "770d5195-6868-4202-833e-a615b9352264",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0b987ffe-bca7-44f8-a71a-12867d79c471",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5ca04417-49a5-4a8c-b7d6-c9152450c82f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cac6b9cc-b57e-45e9-8bb0-407b66f26298",
"_parent_code": "sample string 6",
"sales_organization_id": "99c3220c-94cb-44e5-8c9c-09bcc50d1b02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+00:00"
},
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00"
},
"equipment_model_id": "5ad6c938-67ec-4a5d-8307-fc8bade4ff65",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f7ae0bc1-b6eb-4cfe-96bf-8d16ce206dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "626d5104-6f0f-43f6-b83d-3d8d6d181b3d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "be2fdd4d-942f-4edf-9e4c-e3f9439a5481",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "243231b7-035e-4b3a-8127-e5d1c6c55d67",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+00:00"
},
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00"
},
"equipment_family_id": "6e62712e-c881-45ef-b070-4ff55a8a3241",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5ca04417-49a5-4a8c-b7d6-c9152450c82f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cac6b9cc-b57e-45e9-8bb0-407b66f26298",
"_parent_code": "sample string 6",
"sales_organization_id": "99c3220c-94cb-44e5-8c9c-09bcc50d1b02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+00:00"
},
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00"
},
"date_in_production_since": "2026-07-01T06:32:13.2263266+00:00",
"date_out_of_production_since": "2026-07-01T06:32:13.2263266+00:00",
"date_end_support": "2026-07-01T06:32:13.2263266+00:00",
"sales_organization_id": "fd0189f9-3506-4dc2-8a7d-0b3c2b9b0e17",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+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-01T06:32:13.2263266+00:00"
},
"project_status_id": "f98c2795-11d3-4405-bfb3-3f1f3c196c57",
"project_status_code": "sample string 10",
"project_status": {
"id": "80334231-3617-4f07-98b1-d45950e40321",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f16a3d81-df92-4281-a15d-07430f0b3d48",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00"
},
"company_id": "f63f8f1b-9ed1-49bd-a18c-7e0c8f9df1df",
"company_code": "sample string 12",
"db_address_id": "5e5937a6-b696-461b-95ca-4945f03bca71",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f672b52-b58e-4102-aa4d-7016e2051fb1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2f7ecc26-ae4f-4fd8-b5a5-6b4c656a3d2d",
"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-01T06:32:13.2263266+00:00",
"date_create": "2026-07-01T06:32:13.2263266+00:00",
"date_update": "2026-07-01T06:32:13.2263266+00:00",
"updated_by_user_id": "96bda60e-05dd-48e0-9efb-220095e27708",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-01T06:32:13.2263266+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-01T06:32:13.2263266+00:00",
"date_last_job": "2026-07-01T06:32:13.2263266+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-01T06:32:13.2263266+00:00",
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00",
"is_mobile_installation": true
},
"job_type_id": "cf9e0bee-7203-4f45-b96f-ab4137cc7f2d",
"job_type_code": "sample string 7",
"job_type": {
"id": "62107cf0-e19e-4d8a-8adf-bfa3ae1bb8ec",
"name": "sample string 2",
"sales_organization_id": "51682370-4af8-49d4-bb22-8ba3de5d87e3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00",
"code": "sample string 7"
},
"job_priority_id": "c764f413-971c-4205-84f3-ab2b166e9504",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "60abb10e-b6bb-494d-9fcc-293af7fb02c5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cee5f478-8adc-4b1b-b1d0-f7c9d8e1d5e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00"
},
"job_status_id": "6b78ea88-8082-4cd2-b692-4506dcac6d55",
"job_status_code": "sample string 11",
"db_address_id": "1505e108-84eb-4703-ae01-5ffd56891d21",
"contact_id": "cb1e7b15-459e-4f62-89e0-d21295f50aa7",
"requested_by_company_id": "65a3a31f-97f9-4ff6-a701-b48ce3206600",
"requested_by_contact_id": "0df2d915-0eaf-4b95-bf39-855029b91105",
"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-01T06:32:13.2263266+00:00",
"due_date": "2026-07-01T06:32:13.2263266+00:00",
"date_create": "2026-07-01T06:32:13.2263266+00:00",
"date_update": "2026-07-01T06:32:13.2263266+00:00",
"date_closed": "2026-07-01T06:32:13.2263266+00:00",
"suggested_user_id": "36d9cde4-c909-4df0-afdb-c324db5392b6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8076e3ce-754f-440e-9750-c757062a4d99",
"db_language_id": "3c875bc8-ae59-44f0-be61-e76303b9480f",
"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-01T06:32:13.2263266+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "abe759f7-1ac8-4866-bc23-e9dd6820a93c",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "32693e4c-1439-492a-b068-2ae083f685cc",
"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": "6735fb7d-7050-4c95-85ef-4be5ed7456b7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a2aa15e1-85bb-4a85-b3a3-d92d49d7915a"
},
"suggested_date_start": "2026-07-01T06:32:13.2263266+00:00",
"skill_id": "0b425b1b-893c-4ea3-abef-25f661beba4b",
"skill_code": "sample string 32",
"skill": {
"id": "e01e8230-f818-448c-99d1-4f788bda818c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "463e09c7-7468-413f-8989-067699df033d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "998172c1-5542-46b9-96a9-7d66fced6a24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3af66dc8-a967-4f0a-abb9-d38656a4dde6",
"db_currency_id": "0c7e4fa5-d626-45dc-8beb-7b76f7ccd553",
"db_language_id": "407e1fe8-4c0c-4b9b-afc3-ae37373db2a6",
"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-01T06:32:13.2263266+00:00"
},
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "728fef9b-684f-4524-93ba-0da34ca540a7",
"date_reported_by_company": "2026-07-01T06:32:13.2263266+00:00",
"id2": 36,
"company_id": "c804f921-011b-4822-901b-e5cc88fa5880",
"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": "a8b21b01-e08d-4eaf-b3d0-0e1e03954a73",
"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-01T06:32:13.2263266+00:00"
},
"work_instruction_details_id": "f0ddd5c6-8d9d-4a0a-bd46-c4266ce92238",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b62cd1d6-c696-4077-b5d2-557d844d080e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "22e8a592-0429-4f76-b3de-d239c5659ce8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-01T06:32:13.2263266+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": "8f3d1170-40fb-4661-b3f2-5b5fce81d6e0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-01T06:32:13.2263266+00:00"
}