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": "e44f9771-d7e1-47d7-b30e-271df352d5bb",
"jobs_id": "79a70e3b-9e07-402a-9004-61c30d488d32",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c278199a-8b7d-41fa-a94d-ef409404bd41",
"_parent_id": "d069c35d-25c1-4f3e-9a1f-139861897078",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c3dd0d69-742d-4fea-8614-aad0931b3532",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b9cb37c4-b23c-4869-8966-4b30a94f333f",
"_parent_id": "5ff98e63-8f0f-44f6-838e-e69ed87a2b9d",
"root_parent_id": "892b2ef7-7715-4ef1-9985-80898a35c84d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b4a81fd3-d80f-4b6b-adc7-6c4a4ffbaf45",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5dc547e9-e073-4ac8-b494-ca069ffa3a3f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5cbe993a-fef8-4c08-bcfe-5d4878f3f6ee",
"_parent_code": "sample string 6",
"sales_organization_id": "2537bcad-0ac9-47cf-9213-af161a19d37e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+00:00"
},
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00"
},
"equipment_model_id": "75ed1338-5068-453d-b859-5cd5f0716791",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "475d44fc-5637-4774-9628-e7b122132101",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "590da103-4c0f-4f0a-8a66-6949d2117401",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "469b3eb2-dd5a-4fac-8af3-407aab78d200",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8bfff566-7296-4544-b18f-4219aa43c1dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+00:00"
},
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00"
},
"equipment_family_id": "cbe31beb-e4b4-4e1e-98cf-875d97b9940a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5dc547e9-e073-4ac8-b494-ca069ffa3a3f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5cbe993a-fef8-4c08-bcfe-5d4878f3f6ee",
"_parent_code": "sample string 6",
"sales_organization_id": "2537bcad-0ac9-47cf-9213-af161a19d37e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+00:00"
},
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00"
},
"date_in_production_since": "2026-07-06T05:55:28.0995418+00:00",
"date_out_of_production_since": "2026-07-06T05:55:28.0995418+00:00",
"date_end_support": "2026-07-06T05:55:28.0995418+00:00",
"sales_organization_id": "3926f1fa-2555-4e77-8d43-5398a431fe54",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+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-07-06T05:55:28.0995418+00:00"
},
"project_status_id": "2423a67b-68f3-4be3-a55b-abf678d17033",
"project_status_code": "sample string 10",
"project_status": {
"id": "5a6f28f0-d28e-48f4-a416-be2d59816f52",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c2fa3ddd-94e8-4e8a-8918-ab950472eb2b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00"
},
"company_id": "54c4cd42-2e05-4a9e-86dd-cca378dba944",
"company_code": "sample string 12",
"db_address_id": "0c9f0805-3f7f-419e-a2e8-8362d37223f6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e6feadb0-e06e-407c-921c-83e854b04a58",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "48f4e284-a67c-4d05-bfea-5824a000c891",
"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-07-06T05:55:28.0995418+00:00",
"date_create": "2026-07-06T05:55:28.0995418+00:00",
"date_update": "2026-07-06T05:55:28.0995418+00:00",
"updated_by_user_id": "50ed0b4b-bf93-4621-a332-59b3082f92da",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-06T05:55:28.0995418+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-07-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-06T05:55:28.0995418+00:00",
"date_last_job": "2026-07-06T05:55:28.0995418+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-06T05:55:28.0995418+00:00",
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00",
"is_mobile_installation": true
},
"job_type_id": "7c08613e-b370-47bd-9ea9-01ff3f0a6a2a",
"job_type_code": "sample string 7",
"job_type": {
"id": "f0ece7c4-f88b-4616-b61b-4a79c99024f4",
"name": "sample string 2",
"sales_organization_id": "6a53bb95-a679-4272-9b92-63b4366fc611",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00",
"code": "sample string 7"
},
"job_priority_id": "0a625aee-dd6d-4542-b2e9-976bb4da0972",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b1c69c6e-80ed-40ef-a319-4d6836237a24",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "671896c0-cc09-4bbc-a001-5170035a8b00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00"
},
"job_status_id": "868c4c03-a358-4acb-b90c-15e6e33a9a91",
"job_status_code": "sample string 11",
"db_address_id": "96a818d4-fc67-4699-935b-78033d2eace7",
"contact_id": "6d386d52-123f-4063-baf9-aea1963b7e38",
"requested_by_company_id": "cbdc1583-0862-4799-bc1c-0e5c118451d8",
"requested_by_contact_id": "177ed33f-b290-4f9e-b5f8-d7f673490ecd",
"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-07-06T05:55:28.0995418+00:00",
"due_date": "2026-07-06T05:55:28.0995418+00:00",
"date_create": "2026-07-06T05:55:28.0995418+00:00",
"date_update": "2026-07-06T05:55:28.0995418+00:00",
"date_closed": "2026-07-06T05:55:28.0995418+00:00",
"suggested_user_id": "b7fe11d1-ebe6-4ca3-ac31-2ff3b5ee0351",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "37d7758f-0f60-4772-9221-52d80dba283d",
"db_language_id": "22cf3f51-c627-4bef-8a94-96210e6a9d92",
"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-07-06T05:55:28.0995418+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "42934509-fab3-4b99-ae9d-33b39c2994f0",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b24865d5-b4e0-4c5b-964a-4a07ca2040ea",
"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": "4646258a-6b46-484f-8a4b-e33179b82501",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fed3ffba-85a0-4d32-9773-e0b3d1e0d9e5"
},
"suggested_date_start": "2026-07-06T05:55:28.0995418+00:00",
"skill_id": "31f7298d-924e-41b6-bd6e-9b4cef3e4ae5",
"skill_code": "sample string 32",
"skill": {
"id": "fb46b574-9ca5-420d-91de-9407fb0b08c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "98f277c4-5afa-4206-900e-6027ca757f34",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6dcdf8eb-2e07-4c37-b9e9-618b0b1384ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c195313c-1261-4834-9025-2b7c21a39a94",
"db_currency_id": "611c28c5-7544-4b1f-b7cc-6dca7616ad62",
"db_language_id": "2ea6131a-d1a1-44ed-9586-758cc8b5d774",
"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-07-06T05:55:28.0995418+00:00"
},
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fca9d4fe-8832-434c-b058-a193953a21e6",
"date_reported_by_company": "2026-07-06T05:55:28.0995418+00:00",
"id2": 36,
"company_id": "3dd1983b-93d6-462e-a3c4-f4b1ee769896",
"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": "42b8b74c-7016-4a9b-8c00-6e2a86de8e86",
"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-07-06T05:55:28.0995418+00:00"
},
"work_instruction_details_id": "7a06164f-469e-42ef-900e-19c6ce998493",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "28764c35-8868-469a-b983-65e07005671c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "96f5b2fd-b677-4952-bd1f-1874a3a69c6c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-06T05:55:28.0995418+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": "c690f9a0-8e9a-4cec-9b5f-b1ea5a323e26",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-06T05:55:28.0995418+00:00"
}