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": "1ab458fd-b291-4f8f-8f40-ad74cd27e21e",
"jobs_id": "a903b310-9527-476e-ba7f-5bfa0615ffc9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5045e259-0853-443b-a3cb-de0e54c10f5d",
"_parent_id": "14705d41-b259-4850-9ec7-223b0d87689f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "212bb58a-fdee-4c9d-9519-bb32dfcd6b3a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1ea3dbb4-d042-4b52-ad7c-df30a595e891",
"_parent_id": "4343d678-4f3a-41f4-b50b-30a0c27acbc0",
"root_parent_id": "0e6434be-5011-47df-abe4-a3c64a76f0fd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0a62c1dd-cc37-4734-a211-bd8851f24ea5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "da913548-307c-460c-acbd-097c91f9b522",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2c874ef-120d-459a-a003-7858849fa13b",
"_parent_code": "sample string 6",
"sales_organization_id": "912cc53a-0859-4c44-bd9e-70ce75c82cda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+00:00"
},
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00"
},
"equipment_model_id": "7899b07d-af73-4d3b-861f-fa23b7a503ed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f34ea893-6cbd-4ab2-bc63-45b3d1f1f685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "964da445-8fa1-4191-b96f-9c3c455ff9b1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cbf22f35-4fe8-4ad7-be87-6b44d54522b7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c68f0d53-c874-4374-bf98-d055cd5e99ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+00:00"
},
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00"
},
"equipment_family_id": "e5fa6c43-aa3c-436e-9ebf-cdf950083a12",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "da913548-307c-460c-acbd-097c91f9b522",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2c874ef-120d-459a-a003-7858849fa13b",
"_parent_code": "sample string 6",
"sales_organization_id": "912cc53a-0859-4c44-bd9e-70ce75c82cda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+00:00"
},
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00"
},
"date_in_production_since": "2026-01-30T15:07:11.3091627+00:00",
"date_out_of_production_since": "2026-01-30T15:07:11.3091627+00:00",
"date_end_support": "2026-01-30T15:07:11.3091627+00:00",
"sales_organization_id": "4b72f3e1-2749-4a00-bbdb-daae47873438",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+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-01-30T15:07:11.3091627+00:00"
},
"project_status_id": "0a3f9ef9-dda9-438b-96ac-282ae4b8e1f7",
"project_status_code": "sample string 10",
"project_status": {
"id": "8f0f245f-d08e-43d3-ab8c-092496de3892",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3cb4b7f3-e530-4eab-b57d-515e64622ed9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00"
},
"company_id": "553f9522-6a22-4583-b74e-14ff5ba139a0",
"company_code": "sample string 12",
"db_address_id": "2d7ee6e4-81df-4527-bae0-faa0311567cd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9017552a-1286-4856-b641-e0cd66bd8dfb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "65944128-12ba-4534-a954-698938318148",
"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-01-30T15:07:11.3091627+00:00",
"date_create": "2026-01-30T15:07:11.3091627+00:00",
"date_update": "2026-01-30T15:07:11.3091627+00:00",
"updated_by_user_id": "30d8bd37-1622-4541-bc7b-c5a02de6deb1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-30T15:07:11.3091627+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-01-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-30T15:07:11.3091627+00:00",
"date_last_job": "2026-01-30T15:07:11.3091627+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-30T15:07:11.3091627+00:00",
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00",
"is_mobile_installation": true
},
"job_type_id": "74913fee-fb6c-4949-9e67-9650185dd2ec",
"job_type_code": "sample string 7",
"job_type": {
"id": "bf7fc8c4-609f-4009-93a5-e978fc548052",
"name": "sample string 2",
"sales_organization_id": "fcc3ea68-e374-41e9-9cba-b23480f31f27",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00",
"code": "sample string 7"
},
"job_priority_id": "2a3b4d06-5be4-4e35-8299-37059b882383",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "42b7db68-abb5-4afd-b890-95fe988edb40",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "58545ee2-a592-468f-a866-d314dcaa6e67",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00"
},
"job_status_id": "ea032cdc-a711-46ed-aa63-db00e3e2dbab",
"job_status_code": "sample string 11",
"db_address_id": "1ae54f4f-c233-44dc-828e-ae3280bccd25",
"contact_id": "8b70d0a6-0516-482b-9c7d-1bebf10b96ac",
"requested_by_company_id": "44d0c8d5-e12d-4d85-98dc-bae4d85f6c37",
"requested_by_contact_id": "0d8ca586-c733-4816-9ddd-20542a120ec9",
"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-01-30T15:07:11.3091627+00:00",
"due_date": "2026-01-30T15:07:11.3091627+00:00",
"date_create": "2026-01-30T15:07:11.3091627+00:00",
"date_update": "2026-01-30T15:07:11.3091627+00:00",
"date_closed": "2026-01-30T15:07:11.3091627+00:00",
"suggested_user_id": "978762b7-ef2c-4eb3-aa4b-e86df4b3e4ea",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "77bb67c8-1662-4fa8-bcee-d947508ce0ce",
"db_language_id": "d38d68a7-071e-4539-ad17-08fdd4e6d71e",
"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-01-30T15:07:11.3091627+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eb4ab92e-a6fb-44b7-b732-db3a47324395",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "eb946176-c507-4b16-8aa3-bc77159113ac",
"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": "3f34bb23-e5c5-4e31-a8a0-40ae1c72a897",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1a44a6f4-6613-43a0-8260-a07799d3b646"
},
"suggested_date_start": "2026-01-30T15:07:11.3091627+00:00",
"skill_id": "9e6a8726-aded-4d37-9b81-bf8c036e4102",
"skill_code": "sample string 32",
"skill": {
"id": "1b06fe30-3ec6-41c2-ba6c-427527a86cdb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2a0b5e2d-897b-4276-8d9a-7ebb2062b9f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23258dcd-a748-4f02-bb02-255e7110b8ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8d9ac49-007e-49ad-9b66-c7ad217920c5",
"db_currency_id": "f741fccc-0864-40f8-9f5d-c12d8c5137e2",
"db_language_id": "ef7e6725-b9c6-4c85-995b-e51b90b3faea",
"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-01-30T15:07:11.3091627+00:00"
},
"modified_dateutc": "2026-01-30T15:07:11.3091627+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78742e43-410b-4306-80d9-bab432876afa",
"date_reported_by_company": "2026-01-30T15:07:11.3091627+00:00",
"id2": 36,
"company_id": "a3ef0dec-cd5c-4567-b6b4-a0c66c9402df",
"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": "d0823fff-0638-484f-84bb-dabbcc00496a",
"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-01-30T15:07:11.3247907+00:00"
},
"work_instruction_details_id": "50008a6e-6af9-4aea-b94f-ad43e9a393a2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8d4bf3c1-e468-4adb-a1c4-18a3bb3a7b82",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c8521c35-3324-4ead-b55a-de5bc3f12686",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-30T15:07:11.3247907+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": "d52f8840-5ae6-4b70-a43f-79a031473e46",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-30T15:07:11.3247907+00:00"
}