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": "75419ae1-856f-4052-ac33-7443ad5d5800",
"jobs_id": "0afb5696-1851-4c2c-b648-a5fddf359db0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "57ec39ee-3b7d-4aea-9faa-bd5e23ead278",
"_parent_id": "044e3839-a11e-4675-a98a-ae2ea7a83629",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "741bb7c5-a9ea-4c11-8d77-ad2c61450ada",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a24d8527-0b64-4efa-a012-c0ce6af5fcf3",
"_parent_id": "8ffadeaa-66d2-4057-9732-2d30a8cab2b0",
"root_parent_id": "bd631bbf-7284-45bc-864d-f87ec8c003bd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a4c8794f-39fc-4e48-bbff-6f7ee46d50dc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dc2f4596-cdda-4075-8d60-f33f122542ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c348ab8-b26e-46c1-b32b-e12a6b3ccf83",
"_parent_code": "sample string 6",
"sales_organization_id": "cbf2aa29-46cd-4434-82cb-8fd667b7df3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+00:00"
},
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00"
},
"equipment_model_id": "dffb5325-071d-4b0a-9dca-15adca00e871",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "02a5aadc-3580-4da2-b461-5cdb86a1e201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6b50f35d-ec2a-44a3-b10b-d300a89f6b3a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "95fdeb76-bc22-490d-85c9-0e225be49888",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7e4e66c7-a1a8-4948-98be-932573431e07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+00:00"
},
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00"
},
"equipment_family_id": "6b8a3212-cea6-466a-8fa6-9223733a102c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dc2f4596-cdda-4075-8d60-f33f122542ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c348ab8-b26e-46c1-b32b-e12a6b3ccf83",
"_parent_code": "sample string 6",
"sales_organization_id": "cbf2aa29-46cd-4434-82cb-8fd667b7df3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+00:00"
},
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00"
},
"date_in_production_since": "2026-01-17T16:43:23.5387388+00:00",
"date_out_of_production_since": "2026-01-17T16:43:23.5387388+00:00",
"date_end_support": "2026-01-17T16:43:23.5387388+00:00",
"sales_organization_id": "fecf4a06-8d8e-42f0-bcef-59c2fa9366c1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+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-17T16:43:23.5387388+00:00"
},
"project_status_id": "268aba5c-7fda-45d4-a18c-0e43e34feda5",
"project_status_code": "sample string 10",
"project_status": {
"id": "a37243ea-096a-4cb6-ad3b-2515781be864",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4b95a69e-98af-4d3d-a27a-b3bb34578fe0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00"
},
"company_id": "9b2b59c0-e174-4c0f-823b-167951634538",
"company_code": "sample string 12",
"db_address_id": "f002c8d5-3e6f-44b3-8c1b-fe834c7b9c49",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e15be95b-c0c9-4346-a98e-ec385ff5b511",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8c674c28-9a10-4e37-8a6e-3b2e1842c8ae",
"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-17T16:43:23.5387388+00:00",
"date_create": "2026-01-17T16:43:23.5387388+00:00",
"date_update": "2026-01-17T16:43:23.5387388+00:00",
"updated_by_user_id": "73bc220b-8781-4323-8b4f-ac4e52eee955",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-17T16:43:23.5387388+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-17T16:43:23.5387388+00:00",
"date_last_job": "2026-01-17T16:43:23.5387388+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-17T16:43:23.5387388+00:00",
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00",
"is_mobile_installation": true
},
"job_type_id": "9a296469-58a3-4556-a44b-2772bb0b53ae",
"job_type_code": "sample string 7",
"job_type": {
"id": "683c82f7-9bae-4466-b37f-7d47eae1e34f",
"name": "sample string 2",
"sales_organization_id": "6c23d184-aca8-48f3-8144-c4ca638a2ba6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00",
"code": "sample string 7"
},
"job_priority_id": "66586b3b-583c-4ca7-abe4-397f9e117f9c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2ec06372-038a-4b62-9b20-a42a59ad5a18",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "db40116d-ca88-4f85-8e70-b3d018078bf1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00"
},
"job_status_id": "09770e1f-e4e7-4b13-8809-91336f22d91b",
"job_status_code": "sample string 11",
"db_address_id": "ab61ff5a-7246-43e7-adce-152fc0208495",
"contact_id": "add0543f-371b-43dc-af74-12ee202a1f4a",
"requested_by_company_id": "9b593865-0d53-418a-b5c7-d6ced1803872",
"requested_by_contact_id": "3594fbfa-1594-463e-ab48-72e32dd0e59e",
"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-17T16:43:23.5387388+00:00",
"due_date": "2026-01-17T16:43:23.5387388+00:00",
"date_create": "2026-01-17T16:43:23.5387388+00:00",
"date_update": "2026-01-17T16:43:23.5387388+00:00",
"date_closed": "2026-01-17T16:43:23.5387388+00:00",
"suggested_user_id": "fa62d6cc-3d77-4f0e-8f43-9fc448a0f337",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1bc787f9-ab83-4e72-84a5-78e9cdf89a8f",
"db_language_id": "7fe39a31-3413-4b12-864a-f5ca535ddc02",
"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-17T16:43:23.5387388+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bb1769b7-40fb-4b35-9333-5668886a5efd",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "397f8cf9-2699-4af6-b68e-549a14bf79d3",
"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": "8cc43401-532b-4e6d-9799-77d66a178d7b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4be7f779-5fcd-481b-9b21-2a5abb83659a"
},
"suggested_date_start": "2026-01-17T16:43:23.5387388+00:00",
"skill_id": "9c8422ff-a894-4f5a-b63f-282ac3a78409",
"skill_code": "sample string 32",
"skill": {
"id": "e1eccf1c-759c-449d-8caa-c418b932581f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fba87460-b8e5-4e82-8d2e-677ddb7c1eb3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e5661c84-0af7-4ce8-b7d4-d7801104ab0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df2c1c34-4cd9-449b-85c0-d22329fc5893",
"db_currency_id": "5f4885b3-ea72-410a-a69b-a5de83ee5d02",
"db_language_id": "19af7782-a497-447b-b3ad-2da863cf1f0f",
"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-17T16:43:23.5387388+00:00"
},
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "98d374de-559a-4107-8cba-73c5361ff57e",
"date_reported_by_company": "2026-01-17T16:43:23.5387388+00:00",
"id2": 36,
"company_id": "692319d3-00af-48c1-ab01-865cfe2bd3c4",
"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": "b0d6d12c-287f-4f74-907b-43e242bb8614",
"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-17T16:43:23.5387388+00:00"
},
"work_instruction_details_id": "1b3066d4-c76a-4307-beaa-49883fcb62f9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9c102742-d6ca-42d3-834b-916b30b13f8c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ba13e5e0-5ff0-4aa1-bac7-2d8325210710",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-17T16:43:23.5387388+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": "31f304ea-7347-4a2e-9a3f-a3280f7236d5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-17T16:43:23.5387388+00:00"
}