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": "6a710d8e-5a90-4c0e-81a4-1a625fed6d7e",
"jobs_id": "489c7711-649a-42b2-bceb-823ea9d39107",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "443e0cd4-b11a-44b8-92e5-ff7d71e45775",
"_parent_id": "6783e9e1-f9fc-420a-a268-77a649bc2e7e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4844fa66-64c7-41ac-a119-3e97236c19c4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "23f30264-7c43-45eb-81d4-0aaee515d1e8",
"_parent_id": "14138aa0-8425-4fc7-b1e8-aa8c4ba7cfd0",
"root_parent_id": "d5fe0593-046c-4e96-9b3d-4abdf6654294",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b46d18d3-e4db-4c74-92f1-7068d9b2fdf7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "062e1cfc-c61a-42a6-9c1b-26be556fa481",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50bd4b13-bbca-4df1-bfa7-b1a4c9b756f6",
"_parent_code": "sample string 6",
"sales_organization_id": "44bdbea4-f539-4bb1-bd6a-3dec28083dac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+00:00"
},
"modified_dateutc": "2026-08-21T10:11:49.7723442+00:00"
},
"equipment_model_id": "b7f0f855-ca37-4f33-a96d-cf33742b6a7e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "067912ce-9fed-4494-9c81-dcc75908cccd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a2ed0a0d-700e-4869-96fc-ec934a0d05cd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b7daf281-0a41-4a72-ac83-75063ba04fe9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "52798c3e-da8b-4a7c-b718-eb5d4a127fa0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+00:00"
},
"modified_dateutc": "2026-08-21T10:11:49.7723442+00:00"
},
"equipment_family_id": "7fc7f6cc-02c9-4709-9977-4a633b503bf2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "062e1cfc-c61a-42a6-9c1b-26be556fa481",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50bd4b13-bbca-4df1-bfa7-b1a4c9b756f6",
"_parent_code": "sample string 6",
"sales_organization_id": "44bdbea4-f539-4bb1-bd6a-3dec28083dac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+00:00"
},
"modified_dateutc": "2026-08-21T10:11:49.7723442+00:00"
},
"date_in_production_since": "2026-08-21T10:11:49.7723442+00:00",
"date_out_of_production_since": "2026-08-21T10:11:49.7723442+00:00",
"date_end_support": "2026-08-21T10:11:49.7723442+00:00",
"sales_organization_id": "86bff250-476b-4d78-9ef4-55b85f2891fa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+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-08-21T10:11:49.7723442+00:00"
},
"project_status_id": "58ad488b-2c4f-4595-a06e-5d79e554dbd1",
"project_status_code": "sample string 10",
"project_status": {
"id": "4a83aa25-672c-4b02-90b7-a62e08b37ced",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "39cac5f6-4535-46d9-86fd-3ef2b4903d69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T10:11:49.7723442+00:00"
},
"company_id": "d91362bd-acb2-4497-bf2e-1c8718255f7e",
"company_code": "sample string 12",
"db_address_id": "e0c9bd8f-cba2-4c1d-8e04-ee8d47da0ebb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3d0d079d-3929-474c-8658-392611fa152b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a356e500-62b0-4584-8a07-b6cc6be46c18",
"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-08-21T10:11:49.7723442+00:00",
"date_create": "2026-08-21T10:11:49.7723442+00:00",
"date_update": "2026-08-21T10:11:49.7723442+00:00",
"updated_by_user_id": "cab81b8e-0bca-4a2d-a21f-b275d850a2bf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-21T10:11:49.7723442+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-08-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-21T10:11:49.7723442+00:00",
"date_last_job": "2026-08-21T10:11:49.7723442+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-21T10:11:49.7879665+00:00",
"modified_dateutc": "2026-08-21T10:11:49.7879665+00:00",
"is_mobile_installation": true
},
"job_type_id": "3200131c-461c-40fd-8dd2-0c4d4f85c611",
"job_type_code": "sample string 7",
"job_type": {
"id": "766fc0ca-9679-4c5c-928d-894f6e9c484f",
"name": "sample string 2",
"sales_organization_id": "2f270fb0-ebfc-49e6-bf41-8e75e3062ba0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-21T10:11:49.7879665+00:00",
"code": "sample string 7"
},
"job_priority_id": "d3d846d9-b286-4edc-ba46-1cfec33e5b8a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "eee621b2-fdbf-49fa-8b08-ba545e72ca47",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8bed75ee-cc73-4bb1-ad54-c2c78abf288e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T10:11:49.7879665+00:00"
},
"job_status_id": "0a7260ea-d408-4dfe-b51d-2a6af77d5b66",
"job_status_code": "sample string 11",
"db_address_id": "ed7160ed-b5ec-4695-b5f7-fba26a293926",
"contact_id": "b4374bc5-496b-42de-acdd-b1f913414294",
"requested_by_company_id": "2c02ff2f-8b29-4fdf-a6dd-955b5cddcc64",
"requested_by_contact_id": "ed1d449d-61b3-4ba3-84a1-20e5dc3c7f40",
"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-08-21T10:11:49.7879665+00:00",
"due_date": "2026-08-21T10:11:49.7879665+00:00",
"date_create": "2026-08-21T10:11:49.7879665+00:00",
"date_update": "2026-08-21T10:11:49.7879665+00:00",
"date_closed": "2026-08-21T10:11:49.7879665+00:00",
"suggested_user_id": "26d9e599-1c6c-49ed-9bb8-cc79acb3ae52",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6729ca6c-3323-4aa0-9fed-d005ffa9ee94",
"db_language_id": "0d586187-6210-4702-a255-d038a110542b",
"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-08-21T10:11:49.7879665+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ee8ab87f-eb6f-40f7-8288-e91a5b2439c1",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d58c5be4-3cc0-4699-954a-9a03b9bbc4cf",
"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": "ad3eb48f-d68b-48fe-af49-0c9fd628da9e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-21T10:11:49.7879665+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "698578da-0b0c-43c4-9279-f2243ae66227"
},
"suggested_date_start": "2026-08-21T10:11:49.7879665+00:00",
"skill_id": "e488de90-6e9c-4dbf-8ca4-f256df84c44a",
"skill_code": "sample string 32",
"skill": {
"id": "af50e0c9-1138-43ee-8360-2973a53a1cff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "83d623e5-8c6f-466a-818d-12cd4d026122",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5b78b17-958d-4236-8aa4-389352a1cb90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3afe6240-70cb-4823-b52d-f3181e7f82fa",
"db_currency_id": "a1c10909-e7a8-47c0-85b4-44aa71043c41",
"db_language_id": "01520fa8-cb46-44e7-9086-3fcb265abb49",
"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-08-21T10:11:49.7723442+00:00"
},
"modified_dateutc": "2026-08-21T10:11:49.7879665+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "305a0f34-2ecf-452a-b0fa-7b0ef4565015",
"date_reported_by_company": "2026-08-21T10:11:49.7879665+00:00",
"id2": 36,
"company_id": "9b401ee1-62d3-4394-bcaf-05df112a59fc",
"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": "2ccbc33c-d296-4324-bbba-026367ef25ef",
"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-08-21T10:11:49.7879665+00:00"
},
"work_instruction_details_id": "c710a05a-4d0b-4095-a935-d9808dd4b83c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c3dfc8e3-94f8-4b10-b7bd-59afc6793ba4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "37bcfc7f-ae84-4764-b721-e04232094292",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-21T10:11:49.7879665+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": "7f0576e7-dca5-4ee5-b098-7c8db2d0a5a3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-21T10:11:49.7879665+00:00"
}