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": "daa4a477-eafc-45c3-9967-19b797ff8ac3",
"jobs_id": "7a73e4d7-0b8d-4b25-9677-19463d921ac9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "09778fb6-8f88-4b36-aeb0-e14cc73c8fc5",
"_parent_id": "b95b7596-bedf-42b4-884e-e2997bb2063b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2e08a3c5-d3d9-4f34-9d11-b5cfe7825b82",
"project_reference_back_office": "sample string 5",
"project": {
"id": "33a29444-8a7a-4169-8423-b019aeafe177",
"_parent_id": "12d5f305-22f4-4a2c-bf4a-d07a33cf5399",
"root_parent_id": "bd2f2d72-52ee-40fb-88e2-c9465621a3dc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d867aad7-c4c1-4192-a4e6-4726317dbf0a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "68f274e2-b028-49fe-a894-1e42fe869dcf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1e5ffb0-f805-4b9d-9c7b-d0002b28125e",
"_parent_code": "sample string 6",
"sales_organization_id": "42158af6-4cd6-4771-ad9a-1c216798ad57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+00:00"
},
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00"
},
"equipment_model_id": "28925117-8753-4f4d-b830-17a9a0a83dc6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0b9028b1-e9d1-4a2c-a1e2-13f95ecbe14c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2ac5cc19-c896-4dfa-84bb-de1cfc137313",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0b16d268-45db-4732-b6aa-36a40094ddd9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fd4c5e00-add0-4edd-a98b-4120f1b4c36b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+00:00"
},
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00"
},
"equipment_family_id": "c725d7c2-5049-450f-b488-e4722173370b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "68f274e2-b028-49fe-a894-1e42fe869dcf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1e5ffb0-f805-4b9d-9c7b-d0002b28125e",
"_parent_code": "sample string 6",
"sales_organization_id": "42158af6-4cd6-4771-ad9a-1c216798ad57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+00:00"
},
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00"
},
"date_in_production_since": "2026-09-02T15:09:45.1054635+00:00",
"date_out_of_production_since": "2026-09-02T15:09:45.1054635+00:00",
"date_end_support": "2026-09-02T15:09:45.1054635+00:00",
"sales_organization_id": "7c3fa5c7-e259-4788-a7d8-d4df913d258c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+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-09-02T15:09:45.1054635+00:00"
},
"project_status_id": "c3086654-2d60-4620-bcbe-bc59c18d0da1",
"project_status_code": "sample string 10",
"project_status": {
"id": "e2b8c57c-3c52-4483-bb08-66a181177aa3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "61b18855-3a00-4cb6-8aee-3b0f2d016a14",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00"
},
"company_id": "f4af94da-543d-4a2f-ab57-4fd20384871c",
"company_code": "sample string 12",
"db_address_id": "6a28a538-6f00-4d43-9c19-5747807e8931",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a9ec96c0-932a-479e-8176-27cffaa0cf68",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6af5718b-556f-41b9-9e7b-587c3d96e658",
"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-09-02T15:09:45.1054635+00:00",
"date_create": "2026-09-02T15:09:45.1054635+00:00",
"date_update": "2026-09-02T15:09:45.1054635+00:00",
"updated_by_user_id": "f2ad3078-485c-44e5-bb2e-60225126f8b6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-02T15:09:45.1054635+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-09-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-02T15:09:45.1054635+00:00",
"date_last_job": "2026-09-02T15:09:45.1054635+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-02T15:09:45.1054635+00:00",
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00",
"is_mobile_installation": true
},
"job_type_id": "10f7228a-6c7c-48fa-85eb-9c411aec4e2f",
"job_type_code": "sample string 7",
"job_type": {
"id": "3b26d1dc-89bb-4203-a089-c33d2cccae48",
"name": "sample string 2",
"sales_organization_id": "c1775067-8cc7-43c4-9632-6e28957491f2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00",
"code": "sample string 7"
},
"job_priority_id": "1a1c0e07-f693-4269-92fe-1477370dc0fb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "50b07454-4518-41dc-b864-5f293ecf3cb4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d351902a-7b21-45d3-bbf0-abe0bbfb7305",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00"
},
"job_status_id": "9d384531-6563-4b21-9715-414420cbc29b",
"job_status_code": "sample string 11",
"db_address_id": "3c092ff0-6f73-499b-807a-2cbb3582ee4c",
"contact_id": "3648dcf2-74d7-4d1f-a173-22c50aee10d2",
"requested_by_company_id": "66514a06-c16e-4771-b468-f11e907e7760",
"requested_by_contact_id": "bb10ed78-3908-4e38-a5dc-7c060281e978",
"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-09-02T15:09:45.1054635+00:00",
"due_date": "2026-09-02T15:09:45.1054635+00:00",
"date_create": "2026-09-02T15:09:45.1054635+00:00",
"date_update": "2026-09-02T15:09:45.1054635+00:00",
"date_closed": "2026-09-02T15:09:45.1054635+00:00",
"suggested_user_id": "27053ca0-fd0e-46e5-8488-cb92b4b02db8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "874c4e19-6849-4bed-88a6-6a62f015b51e",
"db_language_id": "033497a0-f984-44ca-86b3-9c87b42e10c8",
"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-09-02T15:09:45.1054635+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e56a1377-797a-4b1f-8856-590be359e5b4",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9911d2e6-2199-4cd3-bfac-e6b4cb2edb77",
"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": "e4917350-585c-475a-a09f-9ace0280e98f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "470245a0-82fa-4ca4-880e-39bd9b8fdb85"
},
"suggested_date_start": "2026-09-02T15:09:45.1054635+00:00",
"skill_id": "3503d59f-5aee-4af1-b3ff-a590eee912bb",
"skill_code": "sample string 32",
"skill": {
"id": "c2af1215-ed7e-4d1f-b4da-b0649e70312a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8206e82b-2fa3-4ba7-84eb-b37d921a5b12",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd604d8b-6765-475a-98ad-f59afa0bdd83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae2601e-36c6-46a8-a12f-6aa532bc8189",
"db_currency_id": "8c017c10-b408-4376-8546-655ecd441a79",
"db_language_id": "bf8b8282-0ca0-4cee-822b-7698e1e8bab3",
"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-09-02T15:09:45.1054635+00:00"
},
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b93cdd24-92c3-4cdb-a516-cc2ba902103d",
"date_reported_by_company": "2026-09-02T15:09:45.1054635+00:00",
"id2": 36,
"company_id": "903ea079-186e-4360-a64b-b0b245efde51",
"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": "f4cc1630-1d1d-41bb-8298-7a60f5037271",
"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-09-02T15:09:45.1054635+00:00"
},
"work_instruction_details_id": "7ca94a4e-9a8b-4b8c-a230-e5d5a56e9338",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8adfa1a6-df58-4c3c-973e-0eafc2e56062",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a603894f-722f-4292-96fb-116d70f282f7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-02T15:09:45.1054635+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": "327f0aa6-c923-4591-a4f5-2a98475c9ed3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-02T15:09:45.1054635+00:00"
}