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": "a040545c-5401-4aad-b08f-5a42627be00b",
"jobs_id": "9538bd1e-1b7f-4cd2-a800-71981f261fd4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4fbec1f9-5c6b-4b5f-9328-6497e566c6fc",
"_parent_id": "358fb7e0-8fa8-49b9-b145-c7a3f72faa63",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a188cd59-20f4-4f1a-b9aa-87ab498fadcd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "630f2b11-3c6b-49e0-821c-285e10d75edc",
"_parent_id": "b8fb3917-670b-47c3-98b2-aa6b11737ee1",
"root_parent_id": "9747dd76-c7b8-4930-a160-106b603a55bd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "55341158-0ca8-4888-b973-ad2bc48ebbce",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "66333eaa-4449-454c-9dfc-3b1da70735e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e0467c13-9e6b-4705-83aa-5257093ace9c",
"_parent_code": "sample string 6",
"sales_organization_id": "0557238f-700f-4b53-b55a-343787450928",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+00:00"
},
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00"
},
"equipment_model_id": "f554fbfc-932c-44fd-a027-add8a90ddf56",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "745479ab-c0e2-45f7-b660-0f2a568d66f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "453ad6e1-8dcb-4c01-a9f6-87af3d8fe906",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b57ed5c3-35be-41ff-963f-ffd074d72d70",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ba4956be-54a3-4796-80db-34be1af7906d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+00:00"
},
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00"
},
"equipment_family_id": "11588557-a5e6-4d77-bb8d-b9f5e05be5b5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "66333eaa-4449-454c-9dfc-3b1da70735e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e0467c13-9e6b-4705-83aa-5257093ace9c",
"_parent_code": "sample string 6",
"sales_organization_id": "0557238f-700f-4b53-b55a-343787450928",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+00:00"
},
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00"
},
"date_in_production_since": "2026-07-12T21:24:19.1287966+00:00",
"date_out_of_production_since": "2026-07-12T21:24:19.1287966+00:00",
"date_end_support": "2026-07-12T21:24:19.1287966+00:00",
"sales_organization_id": "8e21a345-0669-4d61-bc41-50056702af6a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+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-12T21:24:19.1287966+00:00"
},
"project_status_id": "e9ac4b9d-5f09-417a-948f-04e6fe2e7c53",
"project_status_code": "sample string 10",
"project_status": {
"id": "99631e03-ba8e-4f69-a93f-92abff6253db",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8e0969ac-2a22-401e-ad27-89f70735d433",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00"
},
"company_id": "9481f26b-bd44-4cc1-b4fd-057c72697fa3",
"company_code": "sample string 12",
"db_address_id": "9f6cdecc-0624-4067-be3d-ee01deccf533",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eba7ec56-374b-4672-a2c9-6c3109483a86",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0bb90158-42fc-4bac-aae5-e7751d609477",
"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-12T21:24:19.1287966+00:00",
"date_create": "2026-07-12T21:24:19.1287966+00:00",
"date_update": "2026-07-12T21:24:19.1287966+00:00",
"updated_by_user_id": "4f778929-cdd3-4f6f-b590-7e9662a2fb7b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-12T21:24:19.1287966+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-12T21:24:19.1287966+00:00",
"date_last_job": "2026-07-12T21:24:19.1287966+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-12T21:24:19.1287966+00:00",
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00",
"is_mobile_installation": true
},
"job_type_id": "9542e84b-1b20-4e30-99d4-dcf98e6b376d",
"job_type_code": "sample string 7",
"job_type": {
"id": "b4e21bd0-3c3c-4aae-a4ac-0d8a5e75d6a6",
"name": "sample string 2",
"sales_organization_id": "8fd6c66c-49f0-4da5-8122-dfe239850449",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00",
"code": "sample string 7"
},
"job_priority_id": "bc15f64b-7309-45a0-b4db-8f7b45c70400",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5464f6d2-5db9-4a0c-b6a5-1197f8c7e21c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0d25e791-90fb-45b5-996d-05443204ee2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00"
},
"job_status_id": "96891570-253c-4575-8dcf-46d824c4c640",
"job_status_code": "sample string 11",
"db_address_id": "b6235e95-7619-407e-a496-09a3cbb440ce",
"contact_id": "1cb32bdc-4bd0-4d61-9a6c-da25303491c3",
"requested_by_company_id": "dfc16aba-809b-45a6-b18b-0a340be617cd",
"requested_by_contact_id": "9807715d-9813-4490-9cf7-abf209cd2a45",
"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-12T21:24:19.1287966+00:00",
"due_date": "2026-07-12T21:24:19.1287966+00:00",
"date_create": "2026-07-12T21:24:19.1287966+00:00",
"date_update": "2026-07-12T21:24:19.1287966+00:00",
"date_closed": "2026-07-12T21:24:19.1287966+00:00",
"suggested_user_id": "3ca0e34d-55b9-4e9e-89cc-5508fb3d3682",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a375d175-576f-4c7e-b4f5-1b5e4c314142",
"db_language_id": "db1e4f9b-6244-43e7-aacc-cc44bf05cb89",
"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-12T21:24:19.1287966+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cc54a768-e0db-43b4-b42e-bf17febaf331",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "059dbb45-092a-43ac-a628-39271b954e0d",
"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": "299982fa-b8dc-4281-bfc4-63c79bfabcd5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4b2e417c-5f68-4fda-a692-e080112555c1"
},
"suggested_date_start": "2026-07-12T21:24:19.1287966+00:00",
"skill_id": "10e17fe4-669e-41dc-a122-fac0a3eb10b2",
"skill_code": "sample string 32",
"skill": {
"id": "73dc45e8-fb80-4fb4-9d5c-eab15249bdcb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "409bf36c-62c0-4c17-99b8-df3b33b72a24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a9d27ba-0662-4a44-be48-ce64b80c365d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad0358a6-e42f-4380-b077-cd91b2f1f522",
"db_currency_id": "bf527d2f-7817-4c34-b349-1254c6e6e618",
"db_language_id": "785bd9fe-9aa1-4fe7-b070-29e079105494",
"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-12T21:24:19.1287966+00:00"
},
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "79afa9c7-2c3d-4ae1-97a4-c2f42b563103",
"date_reported_by_company": "2026-07-12T21:24:19.1287966+00:00",
"id2": 36,
"company_id": "a20255e5-bcfa-4191-8c08-595b517dc8d7",
"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": "aca263c9-43d1-4b54-b210-6f90d8e4df5b",
"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-12T21:24:19.1287966+00:00"
},
"work_instruction_details_id": "d4c0dabc-fc0e-4269-ae95-127ee7c3d713",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6b370e0b-e2b5-43c7-929e-a89f91089bb0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5d577679-2c60-463d-a3f6-72686a6efa3d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-12T21:24:19.1287966+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": "b1a7a0b5-6356-4afd-ab81-63d98b50487a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-12T21:24:19.1287966+00:00"
}