Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "250680e4-862f-432e-819f-4e47071692f1",
"jobs_id": "61d4a24b-9afd-4154-8c68-d127d6d49a6f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c87a87b-3b6c-4863-8403-436b753987b8",
"_parent_id": "277c1750-5bc0-497d-89bb-7c550b8dde63",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e9bde949-978a-41e3-9666-0ccd51260b57",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4475acbb-52b6-4ac5-9d16-70fec8fcf994",
"_parent_id": "ff084e8b-3cda-44f4-bb25-0aeb6b689835",
"root_parent_id": "206fe64a-4cd9-4c1a-aa87-9b1e5becf6ec",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "22405268-35e1-48ec-a565-51b39efc9f59",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b41919d1-9753-4664-9ef3-9b1e729e3877",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17965fca-91ef-4732-b1d7-92e310c28fc0",
"_parent_code": "sample string 6",
"sales_organization_id": "71fe4ff5-75eb-4a27-a365-72bc670cc88e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+00:00"
},
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00"
},
"equipment_model_id": "a2d97d52-899e-4359-b9ca-5506c3170b71",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5de65b0c-c95f-4510-b26a-dac450660d3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "22a071a6-ec7b-4cfb-9e12-1318c2aca70d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b420cbe5-32e7-463a-8ed4-188a63a15534",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "801de3d3-4a49-48fc-b106-c1fa473958aa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+00:00"
},
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00"
},
"equipment_family_id": "bb04c67f-3f86-4784-84de-965d39620387",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b41919d1-9753-4664-9ef3-9b1e729e3877",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17965fca-91ef-4732-b1d7-92e310c28fc0",
"_parent_code": "sample string 6",
"sales_organization_id": "71fe4ff5-75eb-4a27-a365-72bc670cc88e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+00:00"
},
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00"
},
"date_in_production_since": "2026-01-24T09:55:32.7210406+00:00",
"date_out_of_production_since": "2026-01-24T09:55:32.7210406+00:00",
"date_end_support": "2026-01-24T09:55:32.7210406+00:00",
"sales_organization_id": "01bac7cc-824f-40c0-a8c7-35b8710ba5e9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+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-01-24T09:55:32.7210406+00:00"
},
"project_status_id": "14cce41c-bc26-4895-901f-984a95614bad",
"project_status_code": "sample string 10",
"project_status": {
"id": "00d34ba6-3564-41d0-bd65-c4c0d8cd7b06",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c15e2eb1-a256-4a7f-9736-3d4201e9629c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00"
},
"company_id": "fde5b2b6-ece1-47ca-8e0c-0b1ff43e2461",
"company_code": "sample string 12",
"db_address_id": "1460b9e7-30e0-436a-a0df-b5bdf2cc58e2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "be536bb7-b910-41a2-bc60-4cfbb4f16c77",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4704eceb-d371-4f30-970a-fe117ac62566",
"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-01-24T09:55:32.7210406+00:00",
"date_create": "2026-01-24T09:55:32.7210406+00:00",
"date_update": "2026-01-24T09:55:32.7210406+00:00",
"updated_by_user_id": "9c99ae60-f96f-41df-b5ff-df93b578ac35",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-24T09:55:32.7210406+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-01-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-24T09:55:32.7210406+00:00",
"date_last_job": "2026-01-24T09:55:32.7210406+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-24T09:55:32.7210406+00:00",
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00",
"is_mobile_installation": true
},
"job_type_id": "2cfe8096-d58f-49b3-b0fa-d0c4bd5df60c",
"job_type_code": "sample string 7",
"job_type": {
"id": "5d389942-ee6b-457d-b0a6-e5f27f65834c",
"name": "sample string 2",
"sales_organization_id": "7ded6820-deb7-4f7e-8b84-76ddb6f9b045",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00",
"code": "sample string 7"
},
"job_priority_id": "e3865ffa-ee68-4ed2-8f1b-188d3ef46797",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f3d14467-6405-4ea6-b875-9baee85a0d1c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4a7f4c03-0f4e-42fa-894a-62209729dc3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00"
},
"job_status_id": "de989064-2b10-4999-bb27-8fd79066b1c1",
"job_status_code": "sample string 11",
"db_address_id": "9a0e4134-698b-453f-b7ad-936a0a2085a9",
"contact_id": "c7912a77-5f77-4cc7-bf54-ee40ddd5e0a4",
"requested_by_company_id": "9263426f-486b-4b02-89d4-249d45fc1212",
"requested_by_contact_id": "7866eb86-c4b3-43d1-ac40-b909fb0f65f0",
"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-01-24T09:55:32.7210406+00:00",
"due_date": "2026-01-24T09:55:32.7210406+00:00",
"date_create": "2026-01-24T09:55:32.7210406+00:00",
"date_update": "2026-01-24T09:55:32.7210406+00:00",
"date_closed": "2026-01-24T09:55:32.7210406+00:00",
"suggested_user_id": "3082afd8-10fd-4ec4-8d59-8b17adc89b00",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b0dca00c-0eed-42b3-816d-87beafa6bddb",
"db_language_id": "15d644f8-5c1a-47fb-9670-4b85ec030872",
"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-01-24T09:55:32.7210406+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "505bc546-c05d-4fdd-a8dc-8b3bc62e6741",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a3b313bf-7206-494f-98e0-3aaa10cfa8e2",
"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": "968f94e0-67b3-47da-89d9-65408cbbe280",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4c200c58-2974-4e1a-9d14-1fad172c28ec"
},
"suggested_date_start": "2026-01-24T09:55:32.7210406+00:00",
"skill_id": "76fb3364-41b2-49ce-a902-e7b5abf2b957",
"skill_code": "sample string 32",
"skill": {
"id": "88f88596-b694-43d9-8004-0407cbd03e23",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5e3ada2b-66a9-45b5-8281-4c3fb030cb12",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e51ab7c1-b936-4421-a303-36f0c07e67ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45cfd099-071d-408b-8dc3-28da2bb2b22f",
"db_currency_id": "6ba0d462-edb2-4c9a-8851-a52fdfbf7a14",
"db_language_id": "70552e27-20b5-489e-9ada-0ec841f407d4",
"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-01-24T09:55:32.7053616+00:00"
},
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a16f619a-e3aa-4fb9-9141-b16c2696e078",
"date_reported_by_company": "2026-01-24T09:55:32.7210406+00:00",
"id2": 36,
"company_id": "c695034b-5102-4639-9a81-2cf0bf559a79",
"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": "6b017178-e706-4411-b754-b3bb83ba2d64",
"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-01-24T09:55:32.7210406+00:00"
},
"work_instruction_details_id": "3ccc746b-4cc7-4a42-90da-e0b58d346e41",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cb5a0eb9-0d7d-438d-a558-94891d8a81e6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a45af7f4-4955-4b60-b824-30ea20d95938",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-24T09:55:32.7210406+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": "864709c1-cd14-4194-a619-3a0480d39826",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-24T09:55:32.7210406+00:00"
}