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": "3ebf1344-898b-4fa6-88b7-a6588583cb21",
"jobs_id": "8862a569-a097-4360-940c-8da828f11371",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ba9c2a47-e470-4141-a2b4-05924730ad2e",
"_parent_id": "8d32cd71-f549-4efd-a43b-f045bd08d37c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3b6ea057-3804-48f6-94d4-08fb3ba1f3dd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0e5a5850-cb1e-4ed3-b746-0d2ef73a4850",
"_parent_id": "cdac11b9-385e-4889-810e-81dc7b65ca4c",
"root_parent_id": "73d70c8c-6025-4811-bef3-6ab3d5547837",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "73955af2-5fc2-431a-b49f-32c341039357",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a8822d62-feb5-4ef8-8a80-3c8555250a21",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3a0fbd31-e761-41ea-95c6-804543c7e1cf",
"_parent_code": "sample string 6",
"sales_organization_id": "7e6efa7d-b2a1-45dd-b626-865af25a1154",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+00:00"
},
"modified_dateutc": "2026-10-08T12:55:49.4164116+00:00"
},
"equipment_model_id": "f4de839c-92e0-4277-9b73-9ae87491d59e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6721d6fa-4877-4dfa-8ba1-ee0b64b0ac2e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5e0c888a-450e-4170-93ad-c90774d226d3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6ec7064b-7326-4b36-95e4-ddce375ad223",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "528d5fb4-7f5d-4329-8fc2-c2cfbb6477d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+00:00"
},
"modified_dateutc": "2026-10-08T12:55:49.4164116+00:00"
},
"equipment_family_id": "279bbf24-4e95-45b5-9993-ada0e7623b8c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a8822d62-feb5-4ef8-8a80-3c8555250a21",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3a0fbd31-e761-41ea-95c6-804543c7e1cf",
"_parent_code": "sample string 6",
"sales_organization_id": "7e6efa7d-b2a1-45dd-b626-865af25a1154",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+00:00"
},
"modified_dateutc": "2026-10-08T12:55:49.4164116+00:00"
},
"date_in_production_since": "2026-10-08T12:55:49.4164116+00:00",
"date_out_of_production_since": "2026-10-08T12:55:49.4164116+00:00",
"date_end_support": "2026-10-08T12:55:49.4164116+00:00",
"sales_organization_id": "37c8335e-abbc-4167-85cd-9ae7f5957ba9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+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-10-08T12:55:49.4355542+00:00"
},
"project_status_id": "c5fea9cf-61a1-4be8-8776-23b7beadeef7",
"project_status_code": "sample string 10",
"project_status": {
"id": "188ed06c-a19d-4bda-b9e7-a36ddf4de9e0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9ec4a52d-f3e3-4566-a3e3-9c09b31d77fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T12:55:49.4355542+00:00"
},
"company_id": "152380e5-cc1a-44cc-ac5d-c4b57f8c8cc4",
"company_code": "sample string 12",
"db_address_id": "d3cdea1b-dad3-4a85-bc32-86de875bb9ab",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c89f71de-f697-4b5e-aecb-6b7007f37ca3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3e706483-bb14-42ac-a886-8865ad55e16f",
"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-10-08T12:55:49.4355542+00:00",
"date_create": "2026-10-08T12:55:49.4355542+00:00",
"date_update": "2026-10-08T12:55:49.4355542+00:00",
"updated_by_user_id": "a17c4619-52d7-4c17-bb3f-eeb3fc9299b1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T12:55:49.4355542+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T12:55:49.4355542+00:00",
"date_last_job": "2026-10-08T12:55:49.4355542+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T12:55:49.4355542+00:00",
"modified_dateutc": "2026-10-08T12:55:49.4355542+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c11886d-29fe-4522-9201-cbdb2a48eab6",
"job_type_code": "sample string 7",
"job_type": {
"id": "acd8fe1f-52cc-4e21-9888-273e0a80cbc7",
"name": "sample string 2",
"sales_organization_id": "831085de-19cc-4406-aa2c-e1a28b358fb0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T12:55:49.4355542+00:00",
"code": "sample string 7"
},
"job_priority_id": "4a8b62de-4879-4d55-afff-b0add742e4e1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "70a2f1f3-aeae-4679-8f28-dd66cc7bff83",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c15e80c6-f393-4c89-9af9-334a06b76bfe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T12:55:49.4355542+00:00"
},
"job_status_id": "ea91b852-6436-4f5f-99d9-356c586e88de",
"job_status_code": "sample string 11",
"db_address_id": "901b467f-8cce-4fcd-baaf-0169781b0274",
"contact_id": "16373987-4f3d-4358-9e06-70d61ebdf538",
"requested_by_company_id": "32f1c337-dbfc-4e8e-86e7-ec8334d6c4a7",
"requested_by_contact_id": "e0255c3c-b283-4190-a368-1de2b1590bfe",
"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-10-08T12:55:49.4355542+00:00",
"due_date": "2026-10-08T12:55:49.4355542+00:00",
"date_create": "2026-10-08T12:55:49.4355542+00:00",
"date_update": "2026-10-08T12:55:49.4355542+00:00",
"date_closed": "2026-10-08T12:55:49.4355542+00:00",
"suggested_user_id": "e9830e30-62d0-4f81-a0fa-345a914697c1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "87c6dd31-fc3b-4dfa-9bc4-0a3e97eb7349",
"db_language_id": "ded22d8f-c62f-4daa-b643-1debf4f92da2",
"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-10-08T12:55:49.4355542+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b067f8cb-0126-4e17-9c8f-778149f9a16e",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "01914ff6-a623-402b-8b41-382f18641c3f",
"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": "aaf99fd0-34e4-43a1-a42f-343d24ff841c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T12:55:49.4355542+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0f9999e9-af94-4ce9-8d64-9edda3b6e6c6"
},
"suggested_date_start": "2026-10-08T12:55:49.4355542+00:00",
"skill_id": "678e6d67-4e16-4343-8fd2-98cc4fa4eb25",
"skill_code": "sample string 32",
"skill": {
"id": "64e9c3cb-1795-4797-ba4a-1fa076df7cec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "029e5a5f-24ec-4b67-ad5c-fe61d0bc1b1e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d855a8c-ec9f-4e3f-b31b-6bbc17896589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83467c47-86f6-4086-b01b-452a418645e8",
"db_currency_id": "71362cc7-9aeb-4a66-b948-f0aa19f7cfd8",
"db_language_id": "484ac2ca-b5cd-46a8-91e3-d8b5accf6bb9",
"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-10-08T12:55:49.4164116+00:00"
},
"modified_dateutc": "2026-10-08T12:55:49.4355542+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6a2a2cd4-01a6-477f-a378-e0056749decf",
"date_reported_by_company": "2026-10-08T12:55:49.4355542+00:00",
"id2": 36,
"company_id": "c096723a-63c7-42ff-a488-98194c9f4b0f",
"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": "6ad7fe66-cbac-41d6-9254-707112d22082",
"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-10-08T12:55:49.4355542+00:00"
},
"work_instruction_details_id": "df57575f-b319-4d12-b1a0-690ba6dc6db9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0599fc4f-e99b-468c-a992-40f3806be7b1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9456be5f-7e6c-4667-9c9c-dc0f4c9a5b72",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T12:55:49.4476678+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": "d306a6a3-8a87-407d-883f-41a521eaa657",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T12:55:49.4476678+00:00"
}