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": "0690eed2-40c8-4b5d-94d3-9dee8bdff2c0",
"jobs_id": "6853cd57-3b8e-48bb-9514-41992431ef5f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "21bf3a21-d9d0-4eae-94c1-e96d23902122",
"_parent_id": "13dba20d-aff2-485d-b3ac-4a563e611d90",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4b7dc75a-5496-42de-b900-62f5538e6f14",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d4b966e4-9f06-40c7-842b-387a6d8342fc",
"_parent_id": "df76e93c-e826-4220-a651-6f8795b361cd",
"root_parent_id": "6611fc41-8a52-4adf-ac1b-004438fb9a29",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "53c1f117-7741-4b59-a933-58c7e7a9ec30",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "93361e20-41b8-4ff6-af33-0b13f16ac5af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8c466fb-65e3-4a2e-8687-e86d58201fca",
"_parent_code": "sample string 6",
"sales_organization_id": "8a6eaeab-ed56-45f7-911b-96d44c8b1fbd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+00:00"
},
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00"
},
"equipment_model_id": "55dc058b-7bcc-4c63-a6f3-d4c5e8f9208a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bc0e1e1c-881c-4520-94a1-5d59bbff5b49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9278caed-7061-4221-9c4f-cb814134537e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "72c8adfd-fb6b-42f6-9ce2-91cb6c828ce9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5f282127-18d8-4e7e-9b68-fab3e5e3ca6f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+00:00"
},
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00"
},
"equipment_family_id": "58030c94-18a0-40c9-a40a-7069b149b05b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "93361e20-41b8-4ff6-af33-0b13f16ac5af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8c466fb-65e3-4a2e-8687-e86d58201fca",
"_parent_code": "sample string 6",
"sales_organization_id": "8a6eaeab-ed56-45f7-911b-96d44c8b1fbd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+00:00"
},
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00"
},
"date_in_production_since": "2026-02-17T21:30:18.3452965+00:00",
"date_out_of_production_since": "2026-02-17T21:30:18.3452965+00:00",
"date_end_support": "2026-02-17T21:30:18.3452965+00:00",
"sales_organization_id": "2157f38d-6a61-47f0-a266-034efb704cbe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+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-02-17T21:30:18.3452965+00:00"
},
"project_status_id": "25f9b4e5-54ac-4bef-8bad-c759770414d5",
"project_status_code": "sample string 10",
"project_status": {
"id": "4e915b06-8149-4f19-b93c-a8cb0774c1c3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c25a0492-fe3e-4d4d-ba1f-6509d2ff3d3d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00"
},
"company_id": "8a041d6c-6885-41e2-bf47-1a022fd4d2af",
"company_code": "sample string 12",
"db_address_id": "728dacd1-e0f8-4786-8312-d2847897a1fb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e260786f-db6f-4bff-9414-0c9db35245b3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4e0a3c64-208b-42c4-8937-cb6750e31fe8",
"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-02-17T21:30:18.3452965+00:00",
"date_create": "2026-02-17T21:30:18.3452965+00:00",
"date_update": "2026-02-17T21:30:18.3452965+00:00",
"updated_by_user_id": "803386a0-1e51-413e-8d6e-5f561db3cc40",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-17T21:30:18.3452965+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-02-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-17T21:30:18.3452965+00:00",
"date_last_job": "2026-02-17T21:30:18.3452965+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-17T21:30:18.3452965+00:00",
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00",
"is_mobile_installation": true
},
"job_type_id": "c4342c7f-e61a-48b9-a6e6-e8418ab5f374",
"job_type_code": "sample string 7",
"job_type": {
"id": "52308397-e200-4f7d-9246-68d0ecfc96b7",
"name": "sample string 2",
"sales_organization_id": "dfa1b08b-f79d-40d4-9848-b0f2db4d2925",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00",
"code": "sample string 7"
},
"job_priority_id": "e45fe322-b58a-4105-9a11-253000f5d66b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08b04c33-1337-489c-861a-8033414a789e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e15954d7-bc24-42d6-abf8-b9d622f03eac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00"
},
"job_status_id": "d807fd05-7adb-4878-9a24-c09e986f4e04",
"job_status_code": "sample string 11",
"db_address_id": "a79b0417-c9b4-44e5-bf95-c75d9cda5f56",
"contact_id": "f5210a8a-f3ca-444d-91f5-acb05233b59b",
"requested_by_company_id": "75850934-2f04-4dee-9e2d-b78d401705c5",
"requested_by_contact_id": "e14d5889-12d5-49b4-a0e2-6b4e94723d9c",
"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-02-17T21:30:18.3452965+00:00",
"due_date": "2026-02-17T21:30:18.3452965+00:00",
"date_create": "2026-02-17T21:30:18.3452965+00:00",
"date_update": "2026-02-17T21:30:18.3452965+00:00",
"date_closed": "2026-02-17T21:30:18.3452965+00:00",
"suggested_user_id": "e0edd64b-3573-46a1-a01d-05318a163ced",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "313f188a-bbf7-4545-ae08-c23d4b6aa0f5",
"db_language_id": "86036f74-ba8a-4c5f-ac54-203141a9335b",
"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-02-17T21:30:18.3452965+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d4f7ebfa-93d3-4eeb-a3a1-aef219ec3d13",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4236c103-0c34-44ac-ad87-804ce46025c4",
"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": "ed6e1602-4f8d-4a14-94a6-cfa932c3def4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8db9f408-e82d-49e7-93fc-481ca3e4d624"
},
"suggested_date_start": "2026-02-17T21:30:18.3452965+00:00",
"skill_id": "487420ea-dc36-4275-b412-1cd0633bad59",
"skill_code": "sample string 32",
"skill": {
"id": "5d24e9fd-b2ab-4f14-95b1-a1e7135d8df8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a4cd2088-357f-4661-9abd-785b1d3fd3a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86668a7a-b22e-4570-b163-8e5c93a3fdbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad3298bc-78d9-406f-b0a1-6fbde33b4808",
"db_currency_id": "916690e0-45ff-47d6-96bc-5221684dbbe5",
"db_language_id": "65bb6bbb-4328-4e32-b056-2ccc8b02e7c6",
"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-02-17T21:30:18.3452965+00:00"
},
"modified_dateutc": "2026-02-17T21:30:18.3452965+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "382e4d66-b14b-478e-a934-e64898f81187",
"date_reported_by_company": "2026-02-17T21:30:18.3452965+00:00",
"id2": 36,
"company_id": "93188516-03ad-4db3-a005-c4b7adb51e4f",
"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": "83a9b7ef-5028-4666-91df-0e2c077dbe66",
"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-02-17T21:30:18.3452965+00:00"
},
"work_instruction_details_id": "b6be03b8-ca0b-4cb1-aeff-f692fe5ec12e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4a4e7323-5a36-4452-9960-79ba62faeb1d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9b9120aa-8802-4bcd-9c74-8a6486b207cf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-17T21:30:18.3609222+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": "51e3795b-75c7-4b7f-9e7a-7280ac014ac2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-17T21:30:18.3609222+00:00"
}