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": "c96bbac5-1e35-4422-a648-82f99990e881",
"jobs_id": "dd5ff848-89c5-4d0a-ac46-a91d59d10fe6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "61c3b6ca-3328-41e1-9918-1bc5b84e8966",
"_parent_id": "bfd6aa27-6a28-400d-a328-6f36e65e65c3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fa5b569b-fd3d-439a-bd33-08bbb28eea91",
"project_reference_back_office": "sample string 5",
"project": {
"id": "53555dde-de14-413b-b7e5-883c71c7a4b7",
"_parent_id": "06d23e64-8b66-4230-9542-c4b8ed4bb4d9",
"root_parent_id": "0166e51e-40bd-4080-8aa5-89cfa9073fa0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8a884b6-9557-46cf-b57a-39bfbdaff9c8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "44f8083f-2f4d-4ef8-b5e5-395828f1b29a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b753ea1-8320-42c2-b7ac-479652f11633",
"_parent_code": "sample string 6",
"sales_organization_id": "420dc080-1c32-420a-98d2-4fe1a5de2cc4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+00:00"
},
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00"
},
"equipment_model_id": "02544f50-a890-4ccd-ab20-c934b4240f31",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e471d47a-f7f0-4a47-b360-3174be8af6af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f30e6c7d-0826-4bb5-9335-20bcfe89c1a8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "394efc69-e387-4e26-8203-e409fd9d88bb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e6ed44de-64d2-4add-a508-39ea8b8b3dcf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+00:00"
},
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00"
},
"equipment_family_id": "210298e9-4155-4a66-9d96-06dffd8655a4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "44f8083f-2f4d-4ef8-b5e5-395828f1b29a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b753ea1-8320-42c2-b7ac-479652f11633",
"_parent_code": "sample string 6",
"sales_organization_id": "420dc080-1c32-420a-98d2-4fe1a5de2cc4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+00:00"
},
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00"
},
"date_in_production_since": "2026-06-27T13:47:25.8187653+00:00",
"date_out_of_production_since": "2026-06-27T13:47:25.8187653+00:00",
"date_end_support": "2026-06-27T13:47:25.8187653+00:00",
"sales_organization_id": "be6b1723-7c28-4db2-ab8e-e6c6d4fa66d3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+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-06-27T13:47:25.8187653+00:00"
},
"project_status_id": "60084be1-8d06-48ca-b72f-6ab689e2c9fe",
"project_status_code": "sample string 10",
"project_status": {
"id": "89882468-e159-46e4-af3b-6dfcb0157fb4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1b9c3dd7-d65a-4404-9452-7fa2d02dce03",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00"
},
"company_id": "cf8371ac-94e3-4b44-a1fa-75f772cf9801",
"company_code": "sample string 12",
"db_address_id": "c36ae353-e8fb-4c15-9aeb-abb972ef19f5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "92f99d6a-781e-4ed6-9a33-c8daab6b45da",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2ba10501-f73f-4dd7-8cee-616c84b39496",
"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-06-27T13:47:25.8187653+00:00",
"date_create": "2026-06-27T13:47:25.8187653+00:00",
"date_update": "2026-06-27T13:47:25.8187653+00:00",
"updated_by_user_id": "576f3eb9-9569-4fa5-b2a2-54702e15148c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-27T13:47:25.8187653+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-06-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-27T13:47:25.8187653+00:00",
"date_last_job": "2026-06-27T13:47:25.8187653+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-27T13:47:25.8187653+00:00",
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00",
"is_mobile_installation": true
},
"job_type_id": "d6d25e32-9f21-455f-aa54-5c2903a85eba",
"job_type_code": "sample string 7",
"job_type": {
"id": "c2b56f11-57f4-49b7-99e7-aa6358b6ca07",
"name": "sample string 2",
"sales_organization_id": "747ba82d-c778-4037-a82f-26eae1eac100",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00",
"code": "sample string 7"
},
"job_priority_id": "414e0f7b-730e-46f3-8dae-f245a806d6f5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ea54b325-2620-4e82-b9d2-1f4485e660dd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b185aed5-2c0c-4ba3-b62b-953d2febf498",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00"
},
"job_status_id": "4c5907d2-4eba-49a6-bf5b-1251adc80593",
"job_status_code": "sample string 11",
"db_address_id": "cfdab09c-1ba1-4701-bf3b-4bdd4bb163cd",
"contact_id": "21f5c9e0-1142-4ee0-bb85-05cc1ed0bb88",
"requested_by_company_id": "5d3560a5-e803-4057-a56a-6ced2370ccb6",
"requested_by_contact_id": "0348bbb5-defb-4e24-ba34-d0608da56dd3",
"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-06-27T13:47:25.8187653+00:00",
"due_date": "2026-06-27T13:47:25.8187653+00:00",
"date_create": "2026-06-27T13:47:25.8187653+00:00",
"date_update": "2026-06-27T13:47:25.8187653+00:00",
"date_closed": "2026-06-27T13:47:25.8187653+00:00",
"suggested_user_id": "85b098b5-f92c-4bc9-9c35-9fa38474cff6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dce6662f-d54f-42d8-afef-5952155db8eb",
"db_language_id": "a3df5aef-b564-41c5-b1f0-ea8ce8dfb068",
"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-06-27T13:47:25.8187653+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "94b2d33b-b3ca-4a46-8b88-ff242a64840d",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0f25906f-6612-4df4-92d2-c2faef8a7c54",
"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": "03029c2e-1f0e-4c1f-a88d-31db7e83c548",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ce7948cb-d0d7-46c9-9118-0a21d055b1e0"
},
"suggested_date_start": "2026-06-27T13:47:25.8187653+00:00",
"skill_id": "f8f2baff-2706-4f78-9411-00d64c5a9fb0",
"skill_code": "sample string 32",
"skill": {
"id": "6029b5f7-ee7c-474d-b39d-8cefe4e4a38e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "697e95da-ee9f-4327-846b-29408cf1e9b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dd578c7-4885-4506-9aa5-24274334c35c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abe3d0bc-bdce-4875-818a-ccab9a488a3c",
"db_currency_id": "bdee6b94-08e2-438d-866f-d6edc9ea68e0",
"db_language_id": "0947eac9-0c2b-411d-9436-b01e1e4464a9",
"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-06-27T13:47:25.8187653+00:00"
},
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fd3b38e7-4fa0-47ad-929e-c41acf553a3a",
"date_reported_by_company": "2026-06-27T13:47:25.8187653+00:00",
"id2": 36,
"company_id": "383863a1-9e20-4dca-be8e-16b08507db9e",
"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": "6bf00b4e-7ff6-4ced-889f-f7134111c862",
"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-06-27T13:47:25.8187653+00:00"
},
"work_instruction_details_id": "6af5937c-b7a1-490b-9376-c98c3fe8b8d6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "370acfef-7842-4064-b4b8-87308de242b6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c56d1c80-0f9a-44c0-9d61-52f75a459dc5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-27T13:47:25.8187653+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": "fcb4d172-bb1a-4597-9a6c-81feefb94162",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-27T13:47:25.8187653+00:00"
}