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": "cd520769-85cc-4537-8733-1056808a2832",
"jobs_id": "3a31fac1-f7f2-4f3b-8e12-8fecfbf5b6f4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "04b33a6d-a647-465f-addd-6950aee10536",
"_parent_id": "9c19f339-58c6-4d77-bbaf-4696b7bade80",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d75030cf-7691-465f-9ea2-ab57a787acda",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9bb84cda-bfa6-41f2-8e42-80c6d0fc312e",
"_parent_id": "eb6c95f2-7fc2-4329-b8bb-65a4d6287a0a",
"root_parent_id": "5910f0ea-beb0-4c01-a37b-4cc9bbe08aba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "24620095-0bde-4ae9-99b1-bb7908d45a54",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3198f8ea-b403-4744-93e4-6deacce0157a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "07e1d1aa-50e5-4bd8-a083-6595f4c0f178",
"_parent_code": "sample string 6",
"sales_organization_id": "2ead2849-6d50-45b6-b2f2-c5b6694c705e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+00:00"
},
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00"
},
"equipment_model_id": "1b736277-3f77-4960-aa6c-a479846593f0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f91b4e78-cc39-4b27-9ca4-a6782ab85043",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ae417cf7-ed9c-46d5-b6d0-54eda8fe9b23",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "74d553af-a1e9-452f-a6db-0e5414d02de3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "75836a91-93f1-4b4b-9c59-86988ca76cca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+00:00"
},
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00"
},
"equipment_family_id": "4aa8e683-2431-49e7-bbad-9ee3683f8756",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3198f8ea-b403-4744-93e4-6deacce0157a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "07e1d1aa-50e5-4bd8-a083-6595f4c0f178",
"_parent_code": "sample string 6",
"sales_organization_id": "2ead2849-6d50-45b6-b2f2-c5b6694c705e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+00:00"
},
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00"
},
"date_in_production_since": "2026-06-26T13:06:51.439929+00:00",
"date_out_of_production_since": "2026-06-26T13:06:51.439929+00:00",
"date_end_support": "2026-06-26T13:06:51.439929+00:00",
"sales_organization_id": "b273cbd4-3701-49b4-bebf-1d47ee924371",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+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-06-26T13:06:51.439929+00:00"
},
"project_status_id": "2d3afc77-9c21-41bd-b260-f8f18fd6d748",
"project_status_code": "sample string 10",
"project_status": {
"id": "d135346a-7610-426a-8fc5-31ada00b365b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d14a7a24-642e-419d-b7a9-e2c20a365f8b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00"
},
"company_id": "b3c3be6c-0ce2-410e-b2a5-7574aa0be950",
"company_code": "sample string 12",
"db_address_id": "8d0ff2ef-c6f1-4c2b-bb07-5bf1c3861f19",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "53b2b91f-b816-483b-a520-34150a56cf7d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "18a92e34-0e73-496e-b459-9ef8e3d6f388",
"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-06-26T13:06:51.439929+00:00",
"date_create": "2026-06-26T13:06:51.439929+00:00",
"date_update": "2026-06-26T13:06:51.439929+00:00",
"updated_by_user_id": "a543fa42-1e72-42a5-8037-3a442a36ee74",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-26T13:06:51.439929+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-06-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-26T13:06:51.439929+00:00",
"date_last_job": "2026-06-26T13:06:51.439929+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-26T13:06:51.439929+00:00",
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00",
"is_mobile_installation": true
},
"job_type_id": "7efa7f34-cf12-4a62-b3b4-846e974a3e63",
"job_type_code": "sample string 7",
"job_type": {
"id": "38f445ee-075f-4220-9c24-2a1433cf018c",
"name": "sample string 2",
"sales_organization_id": "81f40e85-fecc-4bb5-af96-56619334d441",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00",
"code": "sample string 7"
},
"job_priority_id": "381b1640-1920-4e04-bc56-516fd88d1743",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cb3b27d2-3dcd-437a-a064-971c330437d7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8c88f7ff-fabf-4950-b53b-8704c210a912",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00"
},
"job_status_id": "c484dc3f-8788-4af7-975d-7a104ba4f8e7",
"job_status_code": "sample string 11",
"db_address_id": "2c56f725-95df-43c1-9afc-45c6f696ce3d",
"contact_id": "e2e4980c-f2c2-4ced-9ada-11a1cdd48977",
"requested_by_company_id": "6f884825-3222-4725-bea1-d845686b1d98",
"requested_by_contact_id": "48404c88-80af-4471-8b24-7be6f36d5cdc",
"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-06-26T13:06:51.439929+00:00",
"due_date": "2026-06-26T13:06:51.439929+00:00",
"date_create": "2026-06-26T13:06:51.439929+00:00",
"date_update": "2026-06-26T13:06:51.439929+00:00",
"date_closed": "2026-06-26T13:06:51.439929+00:00",
"suggested_user_id": "90b40759-5547-49d4-8187-beef0564c9f4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9c25fa42-0079-41b0-8adb-fa996415f605",
"db_language_id": "8aace719-c05f-41fc-8ad4-011c75f879eb",
"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-06-26T13:06:51.439929+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5f334e13-5ebf-4d64-8110-a38a22942e24",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "83b2ec87-ee35-42f6-b23f-d58af5eb9576",
"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": "7cbdf553-0d42-4662-bc37-a80c9db771f3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e76f5be0-6bf4-470b-938d-0cb99988ec5e"
},
"suggested_date_start": "2026-06-26T13:06:51.439929+00:00",
"skill_id": "391abf14-180e-4149-bff9-3dc68f56b14d",
"skill_code": "sample string 32",
"skill": {
"id": "baa5485b-a984-456e-9640-6338a0e3bf78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1eb7730d-34aa-43ac-a225-d6dea398cbd7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a077a38-8a78-473a-9b18-1a24027da13a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9937c851-a41d-44d9-ae13-27c47fba36bb",
"db_currency_id": "a87a35ce-5743-40c0-a020-be05f8f85d5f",
"db_language_id": "fe21b616-32fc-4d0c-afef-f196c9bd2128",
"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-06-26T13:06:51.439929+00:00"
},
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "12e5e267-5997-470c-a736-8cd3f99423ad",
"date_reported_by_company": "2026-06-26T13:06:51.439929+00:00",
"id2": 36,
"company_id": "39192aef-1ff8-4194-a894-ddce35eb7400",
"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": "9cfb081b-2ff7-4dd3-8a33-b833821092d4",
"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-06-26T13:06:51.439929+00:00"
},
"work_instruction_details_id": "e3e3b2be-07de-4472-9e79-e9db99d69b76",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "958081f1-e40c-41a9-8d8f-0bb9c899672f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3572aabb-d3f3-4bf8-a6d7-9a0829e8181d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-26T13:06:51.439929+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": "733554e1-c331-4249-9a1c-9870550c4387",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-26T13:06:51.439929+00:00"
}