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": "0049f7fa-67f1-4058-92fe-057c18d783a0",
"jobs_id": "093ea0f6-367a-408a-9ff4-d06d6cbe2c0b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "87d6fe39-84b8-4e62-85d9-1b677c651e78",
"_parent_id": "e0bbb3b4-f679-404a-9d97-d93d5c342442",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c10a26fa-8107-4b5d-857b-97f561e8e0c3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7e24377f-3ce3-4e97-8d53-be6f0aa91a67",
"_parent_id": "61e02f9b-8d2f-4cba-b870-32fb3e8e7ec8",
"root_parent_id": "3aac70ce-4341-466e-a9f7-1c842c79cc9f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "65d9e32e-2b8f-4d81-bde4-38177c9f5764",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d4781fb2-2348-4cf9-98ed-07ea931fbbbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1152dfc2-0a69-47ea-b26f-69299435144c",
"_parent_code": "sample string 6",
"sales_organization_id": "c2f48ac3-8b73-4ae2-aea7-a4384cbfa636",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+00:00"
},
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00"
},
"equipment_model_id": "ae3ec9a8-dae9-4d82-bbb5-e77e30970aab",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c17c2d73-2c0b-4c46-bda9-0ac4e2f4e17f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "123fb284-d929-495d-9946-ae7891b7a19f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "294ac9b3-a8a3-4d83-89fa-80e12bb60ef0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e4728c4f-4d57-4dbd-94b2-f1f6a1d1c805",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+00:00"
},
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00"
},
"equipment_family_id": "2830897e-8f53-4a9a-8425-6791794d5c1a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d4781fb2-2348-4cf9-98ed-07ea931fbbbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1152dfc2-0a69-47ea-b26f-69299435144c",
"_parent_code": "sample string 6",
"sales_organization_id": "c2f48ac3-8b73-4ae2-aea7-a4384cbfa636",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+00:00"
},
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00"
},
"date_in_production_since": "2026-01-25T11:13:50.1060597+00:00",
"date_out_of_production_since": "2026-01-25T11:13:50.1060597+00:00",
"date_end_support": "2026-01-25T11:13:50.1060597+00:00",
"sales_organization_id": "efdfd457-b92b-47ac-88df-87e3d8f1328b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+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-01-25T11:13:50.1060597+00:00"
},
"project_status_id": "68685ad5-e709-419b-a9ea-12bf7120379b",
"project_status_code": "sample string 10",
"project_status": {
"id": "9374a074-c94a-4ff9-b273-e75a61767c8d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "be426bb1-1e5b-4a1f-9f38-a2076ced580f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00"
},
"company_id": "f72095ac-d451-472f-9f08-198708317f52",
"company_code": "sample string 12",
"db_address_id": "6790ff9f-99b3-4674-82fa-f9971593c80d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "38b83ad6-64e4-4cfc-8801-fd324c28dc22",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0337b1c8-b2d3-454a-9e15-91f01c96cce6",
"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-01-25T11:13:50.1060597+00:00",
"date_create": "2026-01-25T11:13:50.1060597+00:00",
"date_update": "2026-01-25T11:13:50.1060597+00:00",
"updated_by_user_id": "e9ceb8b1-d6ca-4916-bed0-99e923d68b5c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-25T11:13:50.1060597+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-01-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-25T11:13:50.1060597+00:00",
"date_last_job": "2026-01-25T11:13:50.1060597+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-25T11:13:50.1060597+00:00",
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00",
"is_mobile_installation": true
},
"job_type_id": "498ec768-e7d9-4e6a-a593-e59575137a3b",
"job_type_code": "sample string 7",
"job_type": {
"id": "58a253e3-603d-403d-9ea8-922541072b75",
"name": "sample string 2",
"sales_organization_id": "1de8019e-51b7-4425-b592-9611f5a34415",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00",
"code": "sample string 7"
},
"job_priority_id": "9442e6af-11fc-4930-82d5-73f07adc67a9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aefb6eb2-209f-4f45-8dd1-af9af6d71bdd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cc7e31d8-cca1-4490-87e8-b74ac9264c51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00"
},
"job_status_id": "0eae997c-2ce3-4f56-a2b0-7ba95901bd22",
"job_status_code": "sample string 11",
"db_address_id": "37770220-8982-4571-8317-5c49a173b84d",
"contact_id": "897d41c1-1a5a-4654-9878-37ec3674fda4",
"requested_by_company_id": "5c527dfc-30ef-41b7-9c8d-1fff4432c02c",
"requested_by_contact_id": "53286341-8f24-4118-b51c-bb76c4336ba7",
"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-01-25T11:13:50.1060597+00:00",
"due_date": "2026-01-25T11:13:50.1060597+00:00",
"date_create": "2026-01-25T11:13:50.1060597+00:00",
"date_update": "2026-01-25T11:13:50.1060597+00:00",
"date_closed": "2026-01-25T11:13:50.1060597+00:00",
"suggested_user_id": "a8bdab49-da80-4267-b2d1-1ddf4c91f55d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cf654dea-bbbb-4403-be68-7f55016ee572",
"db_language_id": "091cd6f0-a025-4efd-bdb7-3266bd78fe97",
"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-01-25T11:13:50.1060597+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b2bb58ae-6dea-4ee2-9d14-3f4cca7bc07d",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5e586a1c-475a-44ea-ad62-b0f7acbf9d99",
"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": "06fc5055-4c3e-4071-a6b9-018c912634ee",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5da0352c-85fc-4d8f-b2be-19189b8bf397"
},
"suggested_date_start": "2026-01-25T11:13:50.1060597+00:00",
"skill_id": "65984eab-1a7b-4076-8af2-3c139bdeb2c4",
"skill_code": "sample string 32",
"skill": {
"id": "2892df51-27e6-4874-b5f1-5585b109902c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a79223f0-f0df-4714-a079-6ff713797bce",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e0998630-aa01-4232-ac33-cecf6fd0a327",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50722099-54ab-4a19-b5b0-20d75f677c54",
"db_currency_id": "3440c4b1-f273-404e-ad9d-1badf9fd3498",
"db_language_id": "3386c0a7-f731-408b-af62-a04a5e8b66da",
"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-01-25T11:13:50.1060597+00:00"
},
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dc04180c-588d-4834-8749-f1321e3f3c8c",
"date_reported_by_company": "2026-01-25T11:13:50.1060597+00:00",
"id2": 36,
"company_id": "5b328a9a-00cd-4784-a397-1368d3b89d8d",
"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": "b4b5aa73-91f8-4c1b-9498-71d785a3c57c",
"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-01-25T11:13:50.1060597+00:00"
},
"work_instruction_details_id": "c4d34db9-6d2e-4cfa-b0cd-dc0a2f4441b2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4e918e12-405a-49a7-9379-f27c045cb73b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6e42ab16-8ad5-4e8c-8e33-b83d2d86d5b7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-25T11:13:50.1060597+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": "bda149cf-f4a4-4bd8-b27f-7c8cf49d3615",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-25T11:13:50.1060597+00:00"
}