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": "303a160d-39e7-4d87-b729-bda10e4c2d8c",
"jobs_id": "3d7bec43-8caf-408b-8392-2db22591bccd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5824a099-12fc-4473-a42a-b27ea72ee97b",
"_parent_id": "822abd79-83b0-4b28-9136-cadea6ed1106",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3815eb60-722f-49f3-b2cf-b68c2b444ba9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "afd9bc18-50de-422e-8941-4bdff1e07079",
"_parent_id": "479ec000-a1f8-486a-87e5-0051579f2624",
"root_parent_id": "f9a70501-62b9-42ae-8759-fe82f4f1aacc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f2971942-b2ab-42af-9e01-578cf8782edd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "734095c2-66c3-4e6f-8c41-bd69755925d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "30e3bb90-14b1-4923-973e-0b0e491b2573",
"_parent_code": "sample string 6",
"sales_organization_id": "e4d5c4e0-8e49-45e7-b41f-03552cc7d010",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+00:00"
},
"modified_dateutc": "2026-06-20T19:27:33.983815+00:00"
},
"equipment_model_id": "b10534cd-9c2d-4297-b139-5638ced73684",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8f29409c-5511-4ee9-af54-b7e3f83f586f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9e09340c-c912-4f0e-bc58-9dd9cb284901",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1f3fc22c-7c31-49e4-960d-c41b3f5d689d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "22cf61b1-584f-4a45-86f7-7991babe0f26",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+00:00"
},
"modified_dateutc": "2026-06-20T19:27:33.983815+00:00"
},
"equipment_family_id": "4f9861ab-a1c0-4144-8a5a-c7563518e03a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "734095c2-66c3-4e6f-8c41-bd69755925d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "30e3bb90-14b1-4923-973e-0b0e491b2573",
"_parent_code": "sample string 6",
"sales_organization_id": "e4d5c4e0-8e49-45e7-b41f-03552cc7d010",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+00:00"
},
"modified_dateutc": "2026-06-20T19:27:33.983815+00:00"
},
"date_in_production_since": "2026-06-20T19:27:33.983815+00:00",
"date_out_of_production_since": "2026-06-20T19:27:33.983815+00:00",
"date_end_support": "2026-06-20T19:27:33.983815+00:00",
"sales_organization_id": "23dc6466-3144-47f1-aab5-abda0937eca9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+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-20T19:27:33.9994374+00:00"
},
"project_status_id": "1ff110f0-8d01-4c89-acfe-a095ae075f58",
"project_status_code": "sample string 10",
"project_status": {
"id": "61a26ca3-8226-4ea9-8d8b-7b8b6cf634dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "510a7fcf-3151-4add-83dc-34efdb40d4ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-20T19:27:33.9994374+00:00"
},
"company_id": "f022d9db-f38a-45ff-9ef0-7ddc87178ca3",
"company_code": "sample string 12",
"db_address_id": "c18df514-7a5b-4ee3-be3f-3c70d9cffe33",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e7884945-e7a4-4f4c-b267-98d2aa57d436",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c29fcc93-502a-4f3d-be5f-70914ebf1458",
"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-20T19:27:33.9994374+00:00",
"date_create": "2026-06-20T19:27:33.9994374+00:00",
"date_update": "2026-06-20T19:27:33.9994374+00:00",
"updated_by_user_id": "04bbea9b-b1a5-4672-bfbf-f79be09f2be2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-20T19:27:33.9994374+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-20T19:27:33.9994374+00:00",
"date_last_job": "2026-06-20T19:27:33.9994374+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-20T19:27:33.9994374+00:00",
"modified_dateutc": "2026-06-20T19:27:33.9994374+00:00",
"is_mobile_installation": true
},
"job_type_id": "2d22dc88-24da-4662-ade2-f4e2c3d4b5c5",
"job_type_code": "sample string 7",
"job_type": {
"id": "29fe9324-3b96-4190-a7a6-37b6aa3b475e",
"name": "sample string 2",
"sales_organization_id": "76a5ead1-7f92-49c5-93f6-4fdd7d90da41",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-20T19:27:33.9994374+00:00",
"code": "sample string 7"
},
"job_priority_id": "51422b8f-183f-4c04-9ca3-dade737ad955",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "27d3a0d4-c918-4bd8-85b5-5dc3913fec05",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8c7da080-331d-403c-a3fa-029b32620415",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-20T19:27:33.9994374+00:00"
},
"job_status_id": "86b5febc-12bc-4712-a789-c87e096266ec",
"job_status_code": "sample string 11",
"db_address_id": "5da56a33-2d09-4ca2-a395-85a43ae46bbc",
"contact_id": "ac59e9b8-c313-49c0-b625-01818ddc376e",
"requested_by_company_id": "ead3c008-9509-44df-bd77-5b0683598da1",
"requested_by_contact_id": "de22511b-565f-41ba-afd7-7932adbf2308",
"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-20T19:27:33.9994374+00:00",
"due_date": "2026-06-20T19:27:33.9994374+00:00",
"date_create": "2026-06-20T19:27:33.9994374+00:00",
"date_update": "2026-06-20T19:27:33.9994374+00:00",
"date_closed": "2026-06-20T19:27:33.9994374+00:00",
"suggested_user_id": "d45fc901-8395-4330-9348-cc30f93ffffa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1c45e1d3-46be-4f3e-a4a5-b424caf81e1f",
"db_language_id": "09b63e90-4e5a-4e34-9742-eae1412cfcbe",
"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-20T19:27:33.9994374+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9929586e-2487-470e-8ccc-a895ea446c7c",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "965ad0ce-d51c-4995-b9a1-c227a79c62a0",
"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": "0f4176d7-a20a-4ba3-9c33-20f8f8f00cf7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-20T19:27:33.9994374+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "234df65b-b409-46a3-a168-0ff106818f1d"
},
"suggested_date_start": "2026-06-20T19:27:33.9994374+00:00",
"skill_id": "6979b558-2808-499e-a088-f75381d8cf1a",
"skill_code": "sample string 32",
"skill": {
"id": "09506c0e-1e3b-4b6a-83cc-386767b1fb66",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8909ff07-09d2-4025-84a5-ae683485b323",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23b63136-c52f-46a7-a444-7ea2800e7f19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eec64a92-5948-4057-96dc-b7b272bef701",
"db_currency_id": "deb9a5ee-7f8a-4929-b8ef-76f3125abd1c",
"db_language_id": "92849d1b-2ff6-465f-855a-9e25306e5320",
"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-20T19:27:33.983815+00:00"
},
"modified_dateutc": "2026-06-20T19:27:33.9994374+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e68e8fe6-d5b3-4ac0-8e55-e89bab4aa26c",
"date_reported_by_company": "2026-06-20T19:27:33.9994374+00:00",
"id2": 36,
"company_id": "3f8acc14-d70c-4f11-a70d-9689cd4456f7",
"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": "07a4d92d-0272-4bb8-9792-dacb9a3e9294",
"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-20T19:27:33.9994374+00:00"
},
"work_instruction_details_id": "c85623c9-9f6c-4475-88a4-6bfc9d2693d8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9f77b3ea-ac72-48d2-acfc-109bc1f4aba0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "08cfab03-1433-4cd9-9032-6ca929180996",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-20T19:27:33.9994374+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": "8a6eb0f5-b8e3-4e5a-b279-948312c605dc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-20T19:27:33.9994374+00:00"
}