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": "90b43b8e-0105-44d3-b9ad-2adc87480c3d",
"jobs_id": "fc3d8d23-451e-494b-93b6-799e2e802d77",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4e7dde04-a6c4-4faf-a3d8-e6c6872a7350",
"_parent_id": "ac6e2b1c-46ca-461e-922e-14967772b7b3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e1216751-ad08-4dff-9563-207777f9fcab",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ee46a6ac-bc0a-49c0-9d0d-09b45e8f2adc",
"_parent_id": "1bbcdbc4-8328-4426-80f2-5c9a6b6ea751",
"root_parent_id": "a3c6a1b0-6f5d-45fb-b6a4-ca0084362754",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6a298b17-c2d6-435c-804b-809725c8fd47",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bbad8c3c-5516-4486-95b8-0a9078e6194a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0cc1b75c-bc82-4882-b5fc-cc99a0415231",
"_parent_code": "sample string 6",
"sales_organization_id": "68db5d80-6bc4-4663-86b5-c10af0900487",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+00:00"
},
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00"
},
"equipment_model_id": "de069523-d416-4e86-992d-947a8cdd87f8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d7921276-c756-4cf1-a010-06b74f1caf59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c1f1f90a-aa79-41e7-829f-a39b5158228c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "88f59cdc-ddaf-428d-8203-4b6f6383f61c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b89c47b9-73d9-47cf-bd2d-a0191ce6c3f9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+00:00"
},
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00"
},
"equipment_family_id": "52451e46-6ded-4f59-8818-9adde6cd811e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bbad8c3c-5516-4486-95b8-0a9078e6194a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0cc1b75c-bc82-4882-b5fc-cc99a0415231",
"_parent_code": "sample string 6",
"sales_organization_id": "68db5d80-6bc4-4663-86b5-c10af0900487",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+00:00"
},
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00"
},
"date_in_production_since": "2026-07-09T21:01:05.901036+00:00",
"date_out_of_production_since": "2026-07-09T21:01:05.901036+00:00",
"date_end_support": "2026-07-09T21:01:05.901036+00:00",
"sales_organization_id": "382b94fe-145c-47fb-9e60-6eecab956f9d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+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-09T21:01:05.901036+00:00"
},
"project_status_id": "cab3b84e-379d-4b31-ba34-ca7956c01497",
"project_status_code": "sample string 10",
"project_status": {
"id": "bbfc47b3-88a8-493f-8343-3d9342656f81",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bcbc25a1-9b0f-4d14-9c31-90c4d6f9e353",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00"
},
"company_id": "c9fb86a2-7340-4e56-a9ea-93a072fb142f",
"company_code": "sample string 12",
"db_address_id": "cd4a9cba-1252-43bc-9a4d-3fd112d142a6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "96c5a439-06cb-4577-b916-34115f1d7f9f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bef693d4-505c-42bd-b86c-9c269d506883",
"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-09T21:01:05.901036+00:00",
"date_create": "2026-07-09T21:01:05.901036+00:00",
"date_update": "2026-07-09T21:01:05.901036+00:00",
"updated_by_user_id": "b49f92af-e3e4-4315-863e-95cf1c8f6815",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-09T21:01:05.901036+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-09T21:01:05.901036+00:00",
"date_last_job": "2026-07-09T21:01:05.901036+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-09T21:01:05.901036+00:00",
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00",
"is_mobile_installation": true
},
"job_type_id": "24e2d0fe-b678-4cfd-b913-2ca2fed3f394",
"job_type_code": "sample string 7",
"job_type": {
"id": "0a84d4e7-0036-4917-abfb-ad8b34794342",
"name": "sample string 2",
"sales_organization_id": "218c3f5d-d892-4f95-bdb0-6a4e063b1a1b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00",
"code": "sample string 7"
},
"job_priority_id": "92da12b6-aecc-40e7-a14c-c143a79fff8f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fb62cc9a-179f-40a8-ba67-2093c91f063c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "70f6c7a2-fbf6-4a34-b6c3-5ba8080bb7f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00"
},
"job_status_id": "1f6601fc-368d-4621-b9b1-138b14093c6e",
"job_status_code": "sample string 11",
"db_address_id": "438fa3d9-89d9-4df7-9779-48abb9861354",
"contact_id": "4c4cb8cb-463a-40ea-ad73-2ddfa5528e14",
"requested_by_company_id": "3e2bdf4f-5cec-4bf1-87ca-501ece8fb5f3",
"requested_by_contact_id": "026ee7b4-5e06-4f0a-ae49-32064a486435",
"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-09T21:01:05.901036+00:00",
"due_date": "2026-07-09T21:01:05.901036+00:00",
"date_create": "2026-07-09T21:01:05.901036+00:00",
"date_update": "2026-07-09T21:01:05.901036+00:00",
"date_closed": "2026-07-09T21:01:05.901036+00:00",
"suggested_user_id": "3de50d15-9c70-4bcb-be42-bfbf4c0a47fb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a1e62702-b4b2-497f-89a4-d740c9e4b141",
"db_language_id": "cd94a209-9b60-4691-a74a-18f3ca456ddb",
"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-09T21:01:05.901036+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "39718b63-7947-4a94-b8ab-db6e9520a5a8",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bb52d2e4-163e-448f-8a49-ca61fd3d2398",
"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": "2286d780-6244-41b7-8ecf-5559d8c9fa29",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "81c02e79-e5d8-4726-ae5c-bc4bce04ec7f"
},
"suggested_date_start": "2026-07-09T21:01:05.901036+00:00",
"skill_id": "9cdaa439-16ca-4d4c-ac44-73f41176b8b1",
"skill_code": "sample string 32",
"skill": {
"id": "973cda2f-3da4-407d-8871-cf35c42c6dc1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2c620047-39af-43c5-8c51-6d1fe6e7de0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8be14b1-f095-4aac-baaf-4b3413582884",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0cbffb98-6d12-40bd-abca-13b1459287d0",
"db_currency_id": "8ee2cdca-778b-4eb7-9cb3-6c5b9ce15a27",
"db_language_id": "92a36ae4-422c-47d4-b064-d096fc997f4e",
"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-09T21:01:05.901036+00:00"
},
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "262771f2-4878-40e4-9aae-31319482c888",
"date_reported_by_company": "2026-07-09T21:01:05.901036+00:00",
"id2": 36,
"company_id": "5741940a-84ea-4c74-b505-2a234cffba4f",
"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": "08a502aa-b9cb-46bc-869a-58aca9695795",
"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-09T21:01:05.901036+00:00"
},
"work_instruction_details_id": "252bd330-26a0-489c-99d4-b9caddf1aa41",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "43c10b4c-68a8-449f-9697-c9090b4b50a2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fc8f0850-0cea-4930-91e7-e828b7a5c04c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-09T21:01:05.901036+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": "2d192cfa-cee4-4d59-b39e-d990d5b04aaa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-09T21:01:05.901036+00:00"
}