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": "b6256063-18ab-4ce6-bf72-e6c17353610c",
"jobs_id": "3d0b71ef-82c0-4cac-bfeb-5e26c0cc439b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ab6c0746-7dd3-4e23-a000-c252f5898796",
"_parent_id": "baaa66c6-42f8-4f51-bb53-9f3af210d548",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "80c49a4c-8778-4f72-87d0-e264e15f0ddb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "61974f51-b7b9-4a12-8699-c3023ab2d5ff",
"_parent_id": "4efc190e-28f6-4aed-af7a-23e71c8b19e6",
"root_parent_id": "3b1fcc8a-23d7-4f9d-aaea-6f373c31882f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ccdf779c-f753-45c5-8e6b-5702f19dc6f2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "752246db-7ae1-438e-9bdd-b8f6e51044eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27c480f5-5a54-4a99-bc8c-50f9bb647e4a",
"_parent_code": "sample string 6",
"sales_organization_id": "569ef0f7-f7b7-4868-8e84-5e61fd31f501",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+00:00"
},
"modified_dateutc": "2026-11-04T16:02:03.5432921+00:00"
},
"equipment_model_id": "e5af8b8e-4516-4e7a-945a-7287d75698c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2271b70c-a229-452e-9636-3169a971243f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "93b0fcd7-6ed3-444c-a980-89028c6d5565",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e185579b-8776-422f-9679-797bfa92d08d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "63704221-de0e-48d3-bf50-3cd487cc61dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+00:00"
},
"modified_dateutc": "2026-11-04T16:02:03.5432921+00:00"
},
"equipment_family_id": "0f4c0cff-beae-4a8d-bcb4-3b2cd4ed7b5a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "752246db-7ae1-438e-9bdd-b8f6e51044eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27c480f5-5a54-4a99-bc8c-50f9bb647e4a",
"_parent_code": "sample string 6",
"sales_organization_id": "569ef0f7-f7b7-4868-8e84-5e61fd31f501",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+00:00"
},
"modified_dateutc": "2026-11-04T16:02:03.5432921+00:00"
},
"date_in_production_since": "2026-11-04T16:02:03.5432921+00:00",
"date_out_of_production_since": "2026-11-04T16:02:03.5432921+00:00",
"date_end_support": "2026-11-04T16:02:03.5432921+00:00",
"sales_organization_id": "0810ea05-3b09-4221-a2bd-08a1dc7b882c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+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-11-04T16:02:03.5533819+00:00"
},
"project_status_id": "cf1b3938-e118-4b3d-a77d-fc8704fbcad3",
"project_status_code": "sample string 10",
"project_status": {
"id": "4399415c-487f-446d-b346-af5fc08f2281",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bd8777bd-6446-44b1-a6fd-2caf4a85e8a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T16:02:03.5533819+00:00"
},
"company_id": "24d4433f-c395-4153-b4f8-4c135720e187",
"company_code": "sample string 12",
"db_address_id": "8fcc378a-a4c9-469b-a9ed-8611349db350",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2f79174a-c4b2-49e6-a5fc-f80ca1b3fa08",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "95eb444e-66cc-46a6-87d3-118bd90af99f",
"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-11-04T16:02:03.5533819+00:00",
"date_create": "2026-11-04T16:02:03.5533819+00:00",
"date_update": "2026-11-04T16:02:03.5533819+00:00",
"updated_by_user_id": "d0c93912-95cc-4809-9c78-f7049d3b8cc7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-04T16:02:03.5533819+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-11-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-04T16:02:03.5533819+00:00",
"date_last_job": "2026-11-04T16:02:03.5533819+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-04T16:02:03.5533819+00:00",
"modified_dateutc": "2026-11-04T16:02:03.5533819+00:00",
"is_mobile_installation": true
},
"job_type_id": "d7a339d5-b2ce-4e67-b4d6-cbb6f37a6e72",
"job_type_code": "sample string 7",
"job_type": {
"id": "12c5e10a-a849-4aeb-8851-62939ed512af",
"name": "sample string 2",
"sales_organization_id": "9f5a28d7-3e3a-4d48-9c84-07424ba2cb1f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-04T16:02:03.5533819+00:00",
"code": "sample string 7"
},
"job_priority_id": "80bee522-df4b-4564-b424-0b6e4f47a8ee",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "480226ed-9d8f-47eb-94bd-4449b2b311b7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "255c4455-d276-4757-a1b5-8a5f95262326",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-04T16:02:03.5533819+00:00"
},
"job_status_id": "28f3cec6-329c-4c4c-a270-c01309aec2c6",
"job_status_code": "sample string 11",
"db_address_id": "b9673417-9f66-4744-8cd9-abc9564c972f",
"contact_id": "9698083c-c55f-4530-802f-4b1684c926fd",
"requested_by_company_id": "79b617c8-e157-4905-888c-52d7aa7d5b77",
"requested_by_contact_id": "ee8aef8f-e08c-425c-9756-960e036124d7",
"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-11-04T16:02:03.5533819+00:00",
"due_date": "2026-11-04T16:02:03.5533819+00:00",
"date_create": "2026-11-04T16:02:03.5533819+00:00",
"date_update": "2026-11-04T16:02:03.5533819+00:00",
"date_closed": "2026-11-04T16:02:03.5533819+00:00",
"suggested_user_id": "cd4c7775-41f6-465e-9be8-ee4fb9b20429",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "830a970a-aed7-4312-8a0f-6a5b042f8068",
"db_language_id": "a54f8273-1987-42d0-8d33-695f475ba0ae",
"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-11-04T16:02:03.5533819+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "90ec056f-7ea2-48bc-be2d-b09fc1d8673d",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "046983f0-e567-46f4-a837-d9c1b825c25f",
"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": "4038631b-213b-42df-8ec6-f790bae6a577",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-04T16:02:03.5722828+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2e634505-e891-49fb-acf0-93c4dec8e575"
},
"suggested_date_start": "2026-11-04T16:02:03.5722828+00:00",
"skill_id": "4676120a-47c0-407a-abf3-16367671e261",
"skill_code": "sample string 32",
"skill": {
"id": "0b5c82eb-e80b-4f0c-b6b0-4d2c65f18a97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "da4c6ea9-010d-4015-9306-e07000b232f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "43f79ae0-4868-46ac-beeb-c3853d959375",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "880e4e7c-922e-412c-b459-69629acc92d5",
"db_currency_id": "7de399db-d78c-44fb-84bf-85f5bf27e49b",
"db_language_id": "abc07992-bae6-4359-9838-c77e1567db12",
"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-11-04T16:02:03.5432921+00:00"
},
"modified_dateutc": "2026-11-04T16:02:03.5722828+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ff9485de-3ee7-45e7-a0ec-b6e5ba461026",
"date_reported_by_company": "2026-11-04T16:02:03.5722828+00:00",
"id2": 36,
"company_id": "15ef7478-b4fb-4d17-9b6c-7ae9eadad7a4",
"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": "4db502fa-7eac-4bee-bf36-13b360595dd1",
"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-11-04T16:02:03.5722828+00:00"
},
"work_instruction_details_id": "3bcc4c95-8e4b-42b2-a269-48704875232f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9490fca6-ac38-486c-946a-f5b70ef3faf9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "24c46c42-ea67-4fbf-a983-6e7c51f9ae6e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-04T16:02:03.5722828+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": "300e9867-7a51-430d-812c-350589ea98fa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-04T16:02:03.5722828+00:00"
}