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": "8a26994e-fcfb-4edb-900d-e55e92047d8f",
"jobs_id": "4dfc0b44-fdd3-4d67-b4a1-9e56dcfee3f2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a4ca41fb-13c9-4066-a315-112cc02cc40b",
"_parent_id": "cda70180-55d3-4ed2-92ed-7e4f0e128e3c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a5dcdeae-4852-41ab-8555-9552fd523d57",
"project_reference_back_office": "sample string 5",
"project": {
"id": "10d5db0d-6bd7-4278-b3e7-28f853108755",
"_parent_id": "28ef2ef2-04c6-4d16-aa9c-9ead83bdaf60",
"root_parent_id": "e4aa80e3-aa4a-49a1-983b-1e4c32719ad5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4c54d368-754a-42cf-941f-1ea55e52b5c0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7d90f950-0338-4883-b43b-535f046eca9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc027513-7e52-4bea-8c7b-cfee5410ca59",
"_parent_code": "sample string 6",
"sales_organization_id": "6b318da5-bbf1-4433-a9e0-0096a0897e7e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+00:00"
},
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00"
},
"equipment_model_id": "07840e97-7e07-4dd5-8391-5763940e8e64",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1d19d6b7-dfc4-499e-bbae-83c3cb22ac4e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bcca3be9-5b3b-46b6-a50f-e9b76287d792",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3c653aa2-fcdb-4a49-a791-5f375da4efcc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70444014-bdf5-4ba2-b60c-48e2e89630b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+00:00"
},
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00"
},
"equipment_family_id": "a06a6f30-b42a-4194-b765-c860c74c4a9c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7d90f950-0338-4883-b43b-535f046eca9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc027513-7e52-4bea-8c7b-cfee5410ca59",
"_parent_code": "sample string 6",
"sales_organization_id": "6b318da5-bbf1-4433-a9e0-0096a0897e7e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+00:00"
},
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00"
},
"date_in_production_since": "2026-05-07T20:56:20.8683498+00:00",
"date_out_of_production_since": "2026-05-07T20:56:20.8683498+00:00",
"date_end_support": "2026-05-07T20:56:20.8683498+00:00",
"sales_organization_id": "f70d47e4-db90-4b79-ab83-06b50c8496e6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+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-07T20:56:20.8683498+00:00"
},
"project_status_id": "06440d3d-000d-4b90-a7ab-7be784305715",
"project_status_code": "sample string 10",
"project_status": {
"id": "6649237c-568e-49a3-99df-d5065853e691",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2f1e1001-c69b-4a2a-9306-6eafa1c6faf7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00"
},
"company_id": "92516085-4e73-40bc-a412-b498a25757fc",
"company_code": "sample string 12",
"db_address_id": "88a3c2ed-573c-45ee-b9b8-a02c413913da",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f75c8360-dd83-4542-b0bc-1aa75651b233",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f7184c21-4f59-43a8-859d-85c113e177d2",
"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-07T20:56:20.8683498+00:00",
"date_create": "2026-05-07T20:56:20.8683498+00:00",
"date_update": "2026-05-07T20:56:20.8683498+00:00",
"updated_by_user_id": "51679d9d-ba95-497b-a92a-371bc0b47771",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T20:56:20.8683498+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T20:56:20.8683498+00:00",
"date_last_job": "2026-05-07T20:56:20.8683498+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T20:56:20.8683498+00:00",
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00",
"is_mobile_installation": true
},
"job_type_id": "d2a79c07-d5d4-4fbf-9654-0e517f46a871",
"job_type_code": "sample string 7",
"job_type": {
"id": "aa0953a7-5f1b-443b-9cc9-5b055e905f95",
"name": "sample string 2",
"sales_organization_id": "9d2fd481-36a1-4ef0-bebc-aed49a387cbb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00",
"code": "sample string 7"
},
"job_priority_id": "16539be0-1528-4732-8aac-c1c44ccef869",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "061a1cae-9cb6-48e0-ad65-f7b16885d1f3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d822570-5ba2-40ff-81da-be443b850de5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00"
},
"job_status_id": "863b5365-f93c-4b2c-b75f-ae228ce4cba0",
"job_status_code": "sample string 11",
"db_address_id": "a82e080c-099e-48a0-b810-ea1b3ee53d97",
"contact_id": "51c5208e-fb85-4bba-8bca-da02bc3a5cc7",
"requested_by_company_id": "aef9f0b1-5133-4228-bfee-ddc84e636141",
"requested_by_contact_id": "8fa45e25-06e3-4fe4-bc16-fe093f060a39",
"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-07T20:56:20.8683498+00:00",
"due_date": "2026-05-07T20:56:20.8683498+00:00",
"date_create": "2026-05-07T20:56:20.8683498+00:00",
"date_update": "2026-05-07T20:56:20.8683498+00:00",
"date_closed": "2026-05-07T20:56:20.8683498+00:00",
"suggested_user_id": "c64bcd12-de9f-4101-b6b1-815fd7819f03",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "97b01fb0-4295-4701-b742-5fbc671c2aa7",
"db_language_id": "2e5e5176-44a4-47db-ad87-ae1ec53ba50c",
"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-07T20:56:20.8683498+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ed62f469-bef4-455f-9e49-a2edd1865a99",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e53a3fcd-8f78-41cd-adbd-2fbda095739a",
"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": "0c423324-630f-4bba-aa30-e41dec70ed9c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e084ede4-322c-44e3-a45b-004fc15add8a"
},
"suggested_date_start": "2026-05-07T20:56:20.8683498+00:00",
"skill_id": "793c00e9-0b18-4046-86c5-bb93435a6a61",
"skill_code": "sample string 32",
"skill": {
"id": "aa9e740f-dfc2-4579-9660-45ac84f224a3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ba0502bd-7ed5-47a0-9961-c93b133e92c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3978fb72-9318-4b07-8fa3-0eb2ef813b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6b9667c-f087-45be-a740-d1e964967eb2",
"db_currency_id": "792ed93a-ad8f-49af-aecc-47d85cf8277d",
"db_language_id": "104cc47e-d398-4a94-a2b7-45756f1ffa36",
"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-07T20:56:20.8683498+00:00"
},
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "51125f17-921f-4c62-84b1-88a0f60b616b",
"date_reported_by_company": "2026-05-07T20:56:20.8683498+00:00",
"id2": 36,
"company_id": "a387c1ff-b0e4-4bc5-8be8-9f2f08ecb524",
"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": "da60fe2a-f5d4-46c8-b91c-4c729be715fa",
"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-07T20:56:20.8683498+00:00"
},
"work_instruction_details_id": "0eea4aab-7cc8-4df9-803d-31133a9c627b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "06baf4e0-b7c5-4af0-a30e-bc91ccb3cb64",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d7ef2fd2-bb6c-4fb7-8628-a630333fd50b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T20:56:20.8683498+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": "fd06ae73-a41a-43b4-bc66-c9f47a2181c6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T20:56:20.8683498+00:00"
}