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": "caa3cad4-0b53-483a-9299-a10415fa7892",
"jobs_id": "67b10ebb-c31b-466d-b8da-c22fe268ed2f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3cb1d271-53e3-4424-88db-cb6a6f915e48",
"_parent_id": "9e52cb2b-a2c6-48bc-8955-bfc82f2b2193",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dfbc7ff9-219a-4671-b7eb-79025eb2f627",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f4ab25a0-4b71-4159-bbe9-625233ba418b",
"_parent_id": "0ed1089e-0a87-47a0-ba2c-720402c0e05b",
"root_parent_id": "e5619a7a-3bac-418f-9494-fa841feb242a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ba6fef12-b0ea-4cc3-a4cd-f300003b25e0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7e9f47ce-fdae-40a5-b455-cf154ab0f997",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f592a85e-a187-4d97-a30c-dfd10a711864",
"_parent_code": "sample string 6",
"sales_organization_id": "396f5ef3-c28d-4032-980d-31ddf3f7660a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+00:00"
},
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00"
},
"equipment_model_id": "b7d5e6c9-51f6-4f42-928b-d7a9859456d4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3fc289ea-d8ae-4fa2-994d-a3c997e960f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "271e64d0-1548-4ab1-8742-1139f0681687",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "06b2bf23-17d5-4912-baa2-7ae2a56e7182",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "29ffd17f-9a15-4881-b115-3943409e7b2e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+00:00"
},
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00"
},
"equipment_family_id": "8113b8e4-a5ce-437f-b0ae-b3ae6de762ba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7e9f47ce-fdae-40a5-b455-cf154ab0f997",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f592a85e-a187-4d97-a30c-dfd10a711864",
"_parent_code": "sample string 6",
"sales_organization_id": "396f5ef3-c28d-4032-980d-31ddf3f7660a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+00:00"
},
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00"
},
"date_in_production_since": "2026-09-20T06:13:55.3414512+00:00",
"date_out_of_production_since": "2026-09-20T06:13:55.3414512+00:00",
"date_end_support": "2026-09-20T06:13:55.3414512+00:00",
"sales_organization_id": "6a15b2b5-8c4f-4337-963d-9f3ed75476c2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+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-20T06:13:55.3414512+00:00"
},
"project_status_id": "e1f98f65-8d6c-4155-8982-87351283cabb",
"project_status_code": "sample string 10",
"project_status": {
"id": "3e030250-e907-45c9-a6b6-b1654890c533",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e0203dc4-f3a3-4a65-b091-bdc5245fa899",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00"
},
"company_id": "f5704f6d-a73e-43e7-bd17-5789d353c4a4",
"company_code": "sample string 12",
"db_address_id": "d2a411f5-74b9-4c66-91c7-6e2d65058e85",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a188a52e-26f0-4101-8d0b-5e167067bb47",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fc71a290-2247-4164-a006-c7bc168243c1",
"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-20T06:13:55.3414512+00:00",
"date_create": "2026-09-20T06:13:55.3414512+00:00",
"date_update": "2026-09-20T06:13:55.3414512+00:00",
"updated_by_user_id": "211abfec-42ea-4b75-bd3d-36e5ef1f690d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-20T06:13:55.3414512+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-20T06:13:55.3414512+00:00",
"date_last_job": "2026-09-20T06:13:55.3414512+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-20T06:13:55.3414512+00:00",
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00",
"is_mobile_installation": true
},
"job_type_id": "47cdb076-9a17-4922-b931-b5d6f2425da6",
"job_type_code": "sample string 7",
"job_type": {
"id": "76c61e1b-e99c-42a1-808c-0cd5b254dca3",
"name": "sample string 2",
"sales_organization_id": "48d3f62d-5c4d-478d-b57f-376757a7b66d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00",
"code": "sample string 7"
},
"job_priority_id": "538968ec-e8ba-407f-b4e0-e32d340deab4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9ab3d2f2-fccc-4d4e-96d2-a0ee83caa476",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2dd39285-50e5-4e45-8833-56224b5c85c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00"
},
"job_status_id": "429b4ee1-2ae2-4136-956f-dcc3f4d6e3a6",
"job_status_code": "sample string 11",
"db_address_id": "e30b32d5-e527-4473-8d11-0334baa81c77",
"contact_id": "a4188fb4-8f0e-47a3-94c2-2fc42b73dfe6",
"requested_by_company_id": "74072392-10cc-4df3-9409-efb7534553a3",
"requested_by_contact_id": "e7ce5489-13d7-46ff-bcda-695b8d1ee699",
"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-20T06:13:55.3414512+00:00",
"due_date": "2026-09-20T06:13:55.3414512+00:00",
"date_create": "2026-09-20T06:13:55.3414512+00:00",
"date_update": "2026-09-20T06:13:55.3414512+00:00",
"date_closed": "2026-09-20T06:13:55.3414512+00:00",
"suggested_user_id": "61c7f9a2-f40e-4f0c-8bf7-f78a7fb5d141",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "50c81f69-a6a0-446c-93ff-afbfaa3a0349",
"db_language_id": "0375e191-679e-4620-9878-401227c7d8c5",
"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-20T06:13:55.3414512+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cde70b6a-352a-48c8-86ac-db8b8b3c7407",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "67ca76e4-cf4e-4ead-8056-c1d8e34b4015",
"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": "268030fc-8c9a-4881-8ea7-1d3d7b5a4494",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "64c3c473-ceb8-4958-99f2-a03329a248b0"
},
"suggested_date_start": "2026-09-20T06:13:55.3414512+00:00",
"skill_id": "9be7444c-f968-4117-9108-3c32cbe6969a",
"skill_code": "sample string 32",
"skill": {
"id": "6c40865a-8ad0-49f2-8bdd-460781ea0d69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "551b4a2b-9701-464d-b071-7e51d3d1769c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf11b340-1ae9-41f3-b1c4-3a94225ac630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2178ca0b-58a2-42d9-8e8e-4a51bdafbac5",
"db_currency_id": "e68c57c3-2408-45e1-abfa-7ffcd35bf0fe",
"db_language_id": "1b102f6d-8f0d-418a-97bb-30591bd069a2",
"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-20T06:13:55.32583+00:00"
},
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b732161f-56f8-4bf3-ac84-b120a4d46900",
"date_reported_by_company": "2026-09-20T06:13:55.3414512+00:00",
"id2": 36,
"company_id": "bef43d1e-78a5-48ea-8067-64b05db79bc3",
"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": "77905ef7-9e48-4e9d-bd03-8fa429689a00",
"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-20T06:13:55.3414512+00:00"
},
"work_instruction_details_id": "79039c3e-18b7-440a-be1a-eb74a60b6f43",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8eaf6551-bf27-4aa7-9091-80ef90bbf3dc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "53742894-c160-4038-b4c6-cbf36b08b032",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-20T06:13:55.3414512+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": "f3b87ebd-c2ba-40d8-8e9a-08eddfd5d619",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-20T06:13:55.3414512+00:00"
}