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": "3fbc5342-e80a-4923-9cd4-4b945557f6dd",
"jobs_id": "74512bf1-cfc6-422a-a695-51c95667d11d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f2e8f483-176d-4aad-9f29-e671e51030fd",
"_parent_id": "ed1945f7-6c02-4aa3-bc4c-95fc3e50d43d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e6c2737d-2e10-4ba6-8498-7e2393b4fc25",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c8c19cbd-4307-4a64-9dd2-0f2a087a5754",
"_parent_id": "6d2aa5e2-103e-4ee0-b78d-1a3696d9d08d",
"root_parent_id": "e2c7d5bc-caa9-4541-b5e0-b371b9bf89de",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2509a5a1-5117-47ed-85ad-10fc6dd3c27e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "952774c0-3c7b-44ff-aee9-019586aff235",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ce16994e-e28e-495e-a088-4bd79c04f7da",
"_parent_code": "sample string 6",
"sales_organization_id": "00af2aaa-60d9-4d83-8ced-a0554c659dff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+00:00"
},
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00"
},
"equipment_model_id": "a516966d-677e-45c3-915f-c2a2da004f89",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6964e614-582f-424e-aa48-d8042a0257fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1d63335f-997a-461e-ace3-ef9938d5068e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1edfa032-4629-4b97-8c6a-d9ed66d9a5cc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "951e89b6-5336-4513-b8d0-6ab97f4f8c7f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+00:00"
},
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00"
},
"equipment_family_id": "f11e123c-3e5d-47a7-ba37-760ac436d3d1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "952774c0-3c7b-44ff-aee9-019586aff235",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ce16994e-e28e-495e-a088-4bd79c04f7da",
"_parent_code": "sample string 6",
"sales_organization_id": "00af2aaa-60d9-4d83-8ced-a0554c659dff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+00:00"
},
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00"
},
"date_in_production_since": "2026-08-01T03:59:24.9804601+00:00",
"date_out_of_production_since": "2026-08-01T03:59:24.9804601+00:00",
"date_end_support": "2026-08-01T03:59:24.9804601+00:00",
"sales_organization_id": "68ee1904-5567-42ed-9e46-b6265f9203d0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+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-01T03:59:24.9804601+00:00"
},
"project_status_id": "5f4d5da5-ef7f-46d0-8ee4-5cde0c697def",
"project_status_code": "sample string 10",
"project_status": {
"id": "6e3e2880-ef2c-4777-a561-05b643cbecab",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4652d3c6-3006-43cf-8db1-2f5e00e66cb8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00"
},
"company_id": "5f5cddbe-2a1d-4e59-b0ae-85fa61906fab",
"company_code": "sample string 12",
"db_address_id": "1124a7ff-0458-43a4-bb28-3333cddf9532",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "897d573f-4080-4965-9f1d-45772d69a912",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c2f6b66e-dae8-4b70-b3b3-2eac5e8e97da",
"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-01T03:59:24.9804601+00:00",
"date_create": "2026-08-01T03:59:24.9804601+00:00",
"date_update": "2026-08-01T03:59:24.9804601+00:00",
"updated_by_user_id": "2e4be5b0-449a-4d81-8b2c-1d3487ddd2f0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-01T03:59:24.9804601+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-01T03:59:24.9804601+00:00",
"date_last_job": "2026-08-01T03:59:24.9804601+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-01T03:59:24.9804601+00:00",
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00",
"is_mobile_installation": true
},
"job_type_id": "c918c70e-0586-4e02-b58c-1f82c1885897",
"job_type_code": "sample string 7",
"job_type": {
"id": "705f69c6-35e6-4f94-bbc0-afe8ce891dfe",
"name": "sample string 2",
"sales_organization_id": "a72a48be-f614-4281-aca7-1f9c53a63a69",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00",
"code": "sample string 7"
},
"job_priority_id": "86aff483-4a77-4833-95fa-3d80bf0df5f4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e4667a42-82e8-45ef-99cd-44370a6dc61a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "916ced17-29f2-4bf5-8950-1d99cd0596a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00"
},
"job_status_id": "3c356649-6848-452f-a2ab-a3adf175cc48",
"job_status_code": "sample string 11",
"db_address_id": "a48cbb65-8833-46d9-8839-d1378eff5849",
"contact_id": "7f935b57-ebc9-4668-8818-266426038dcb",
"requested_by_company_id": "97ed997d-2929-467e-83c3-50118cb3168a",
"requested_by_contact_id": "d3767042-787b-4870-bc91-533adb080256",
"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-01T03:59:24.9804601+00:00",
"due_date": "2026-08-01T03:59:24.9804601+00:00",
"date_create": "2026-08-01T03:59:24.9804601+00:00",
"date_update": "2026-08-01T03:59:24.9804601+00:00",
"date_closed": "2026-08-01T03:59:24.9804601+00:00",
"suggested_user_id": "5b2476b1-0b29-4b6f-a067-ad33ae71edfe",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bcd34155-2bd0-44f8-809b-d22151ab0465",
"db_language_id": "29fa5d5e-893c-47ae-b08e-5e58ff9332a1",
"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-01T03:59:24.9804601+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eccbd884-8363-4b9f-910c-dc21cdfa0467",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "372b8987-e6ba-4075-8943-88c2357628b5",
"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": "06d91da8-29ef-4a9b-b7ae-74b98c7df7e5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4898d17f-a3de-4741-bc98-27bdc1ead240"
},
"suggested_date_start": "2026-08-01T03:59:24.9804601+00:00",
"skill_id": "80876b6f-5654-45d0-b753-66d756743777",
"skill_code": "sample string 32",
"skill": {
"id": "e80abcbc-d30d-47d9-b74b-787c94702087",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "709f8e93-19ff-4291-a174-90565028a74d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24e5072f-5200-497a-b2f3-f894bcaa64dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "505c5757-8dbc-41f6-a2f3-8c60a06954b2",
"db_currency_id": "91470abc-c476-4772-a792-d0ed630c95b4",
"db_language_id": "ffef33a4-5a3d-45da-b1f4-ae26ac914fbf",
"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-01T03:59:24.9804601+00:00"
},
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "40e7b055-c5af-42ad-b275-2e23a9da4576",
"date_reported_by_company": "2026-08-01T03:59:24.9804601+00:00",
"id2": 36,
"company_id": "ffde18d0-3763-4aaa-b880-ccdbc4fc64f7",
"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": "1de2defb-ae89-49e6-a507-c3eb862b4e5d",
"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-01T03:59:24.9804601+00:00"
},
"work_instruction_details_id": "f090bd21-2c4c-419f-87bf-bd0a4051dac2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d04ed2e7-40bd-4447-9e28-976b0688c2ca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "25802af8-566f-4313-982b-1012fe0aaaed",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-01T03:59:24.9804601+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": "91ffd18c-3a9f-4f58-bdfe-ae8ac4169068",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-01T03:59:24.9804601+00:00"
}