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": "e050fb02-49ee-4f53-bfe9-f66fcb203930",
"jobs_id": "b4d87e04-91a6-4c94-b02f-ba834cb8ad2e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "86e00094-5438-4131-b36e-b7bb5f741a86",
"_parent_id": "6b6e0d81-a6f4-4699-81ee-75c2ab33ac58",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cedc5ba2-696a-436e-990e-c742d9914cf4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f6d678eb-b691-480b-8cf1-84deeff1e1eb",
"_parent_id": "971ec945-5db9-4bc3-bb2c-4f0bf54e54a7",
"root_parent_id": "f52d0416-aa4e-4c55-bf44-c30db39a511d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "07e8cfa5-09e4-4108-9bcb-867f3f74a70f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b5211fb0-7b10-4957-8031-bb5048061d28",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16927940-d197-4ca7-be61-68a6c63fa950",
"_parent_code": "sample string 6",
"sales_organization_id": "2701fa4c-5c05-418d-99fb-3af0f3085fd6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+00:00"
},
"modified_dateutc": "2026-05-21T08:40:31.5481295+00:00"
},
"equipment_model_id": "0831ac70-e5f1-428c-a1da-a8fff7f2a62c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7b07dfa9-8139-49c6-9fef-da023029b1bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c5f4449e-3c6b-4e52-9ccd-9ced4135d44b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c54d0e51-3480-4e70-aa3d-1e178d341df7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "448fa26d-5123-4a0f-a2b5-f48afee4bf27",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+00:00"
},
"modified_dateutc": "2026-05-21T08:40:31.5481295+00:00"
},
"equipment_family_id": "51bbd8de-28a3-4f7f-be6e-86e2fe6b324f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b5211fb0-7b10-4957-8031-bb5048061d28",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16927940-d197-4ca7-be61-68a6c63fa950",
"_parent_code": "sample string 6",
"sales_organization_id": "2701fa4c-5c05-418d-99fb-3af0f3085fd6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+00:00"
},
"modified_dateutc": "2026-05-21T08:40:31.5481295+00:00"
},
"date_in_production_since": "2026-05-21T08:40:31.5481295+00:00",
"date_out_of_production_since": "2026-05-21T08:40:31.5481295+00:00",
"date_end_support": "2026-05-21T08:40:31.5481295+00:00",
"sales_organization_id": "78d11314-5beb-406b-85ee-acbe4573078e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+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-05-21T08:40:31.5637536+00:00"
},
"project_status_id": "aa388a01-9cd8-44b5-930a-febe0f6bb620",
"project_status_code": "sample string 10",
"project_status": {
"id": "ce9743c7-9b07-4119-b4eb-3fadeed54899",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "52017f4c-7ea6-452f-b2b8-67746a6b357f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T08:40:31.5637536+00:00"
},
"company_id": "2be1128d-3622-442c-ae65-4844c80016b6",
"company_code": "sample string 12",
"db_address_id": "c726c60f-5774-4613-a376-d1d408743aed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "31d95b80-f892-4f2c-b5cb-c5c4f96ffe55",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b97c4a54-b65a-4a25-9632-23386e9fcb7d",
"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-05-21T08:40:31.5637536+00:00",
"date_create": "2026-05-21T08:40:31.5637536+00:00",
"date_update": "2026-05-21T08:40:31.5637536+00:00",
"updated_by_user_id": "d8cbf4ca-492a-4617-9d02-39032c0a3a26",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T08:40:31.5637536+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-05-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T08:40:31.5637536+00:00",
"date_last_job": "2026-05-21T08:40:31.5637536+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T08:40:31.5637536+00:00",
"modified_dateutc": "2026-05-21T08:40:31.5637536+00:00",
"is_mobile_installation": true
},
"job_type_id": "e91f8c15-4a07-4c43-9d31-7033b821f3cd",
"job_type_code": "sample string 7",
"job_type": {
"id": "f9841ab1-36b7-44da-96f7-1ddad8dfc0a7",
"name": "sample string 2",
"sales_organization_id": "05635b67-1912-4114-80e9-1e31c7b10dfd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T08:40:31.5637536+00:00",
"code": "sample string 7"
},
"job_priority_id": "0de21e47-13c5-49bb-8e53-f37c5f02104c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d25f1e56-4f41-4f26-8179-2ebf6a32e81f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "725f6154-6a30-4e1b-9c56-ef6c9712e670",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T08:40:31.5637536+00:00"
},
"job_status_id": "6b01192f-40dd-48eb-ae5e-ffe3e7b37a0e",
"job_status_code": "sample string 11",
"db_address_id": "ebf9befc-6818-4057-b8b1-13f83023b424",
"contact_id": "34fff10c-1e38-4d7a-b17a-0141f4c887dd",
"requested_by_company_id": "714ddfe4-1eef-40ff-a437-c69608e83714",
"requested_by_contact_id": "ebfa23e0-3a42-4e42-bf84-6cd1f624d04f",
"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-05-21T08:40:31.5637536+00:00",
"due_date": "2026-05-21T08:40:31.5637536+00:00",
"date_create": "2026-05-21T08:40:31.5637536+00:00",
"date_update": "2026-05-21T08:40:31.5637536+00:00",
"date_closed": "2026-05-21T08:40:31.5637536+00:00",
"suggested_user_id": "a9b8a5cf-4a5b-442a-9336-5c31d711f51c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f7033366-9cdf-4699-b81c-0867635a5341",
"db_language_id": "6782b19d-51a3-49be-921c-aeea7c1168d7",
"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-05-21T08:40:31.5637536+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e544c19a-7bcb-46f7-a0df-08ef568db60d",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9fb71156-e5dc-482c-b84f-da82aeb00347",
"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": "785992c6-62c6-44ea-97bc-35981e6b5221",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T08:40:31.5637536+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9c756c58-6c32-4c20-8ec7-72239f8bc4d3"
},
"suggested_date_start": "2026-05-21T08:40:31.5637536+00:00",
"skill_id": "4a2e80aa-ec26-4e4e-9acc-d18a4ff4f613",
"skill_code": "sample string 32",
"skill": {
"id": "025c9110-2aff-4243-ae1a-f133b977664f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7bd78276-b711-4bd5-aef7-1e698483b168",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3fafdf09-38b1-498a-934f-c636f81949a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72db155d-5697-421a-945c-0249807540eb",
"db_currency_id": "ad17747f-7a49-4d59-abeb-901b3906dc99",
"db_language_id": "7524619a-4f1d-4625-9ae4-fe96d282ca1d",
"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-05-21T08:40:31.5481295+00:00"
},
"modified_dateutc": "2026-05-21T08:40:31.5637536+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a1e22d90-7506-4b8b-9a08-2423c4fde02b",
"date_reported_by_company": "2026-05-21T08:40:31.5637536+00:00",
"id2": 36,
"company_id": "e956a22a-55d6-4aae-8e5f-42088e371022",
"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": "48e164b3-cfa8-4e1a-b592-08586aeb2e6e",
"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-05-21T08:40:31.5637536+00:00"
},
"work_instruction_details_id": "ad2c8913-ebbc-4ebc-934f-00f0ca93143f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3d6a6359-54c9-425c-a459-3c4d4ecca91a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b25082d1-bdc4-4c15-80fd-dfd29413d8cb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T08:40:31.5637536+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": "62c81e36-f1bc-4f88-8284-26ef544405cf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T08:40:31.5637536+00:00"
}