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": "71913103-25fa-463f-9b0f-1fdc36766d31",
"jobs_id": "40a29dea-ad76-4ea2-b2b3-2c5f7721145c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1ac9e632-654b-4b9c-840b-864e1956f315",
"_parent_id": "5e1fcd4d-6cdf-4ce9-bb87-bd899a25a114",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d38258f6-917b-4623-896c-359f4fa386ed",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7529606d-d947-4476-9654-033574b0a550",
"_parent_id": "5f52db32-3c2b-4096-8653-44090dd8bb47",
"root_parent_id": "6b59c234-a6bc-449b-8a8c-9b29b53bb754",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9308ce50-f846-4c0c-9cfd-cd830d17865a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "53520772-c7d2-47cc-810b-77e725698e71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8a20189e-56d7-4a91-a7fa-6e911fc2a145",
"_parent_code": "sample string 6",
"sales_organization_id": "b06c845b-0739-4d49-9fc9-f638feb17608",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+00:00"
},
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00"
},
"equipment_model_id": "5b99c4dd-6546-430f-a1b3-c0735e5c3855",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e3299919-1ee1-4583-9247-9fe6e75ac4c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bacc3ef7-b31d-4187-a7d1-87672c05152d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fc5210cc-163d-4eb0-b04e-536fa9f50cb8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ca2548e4-d198-4842-81c5-c39e95893286",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+00:00"
},
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00"
},
"equipment_family_id": "8e12128c-b1f0-4d3e-b140-a244bbed9b6b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "53520772-c7d2-47cc-810b-77e725698e71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8a20189e-56d7-4a91-a7fa-6e911fc2a145",
"_parent_code": "sample string 6",
"sales_organization_id": "b06c845b-0739-4d49-9fc9-f638feb17608",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+00:00"
},
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00"
},
"date_in_production_since": "2026-04-10T04:04:31.1820084+00:00",
"date_out_of_production_since": "2026-04-10T04:04:31.1820084+00:00",
"date_end_support": "2026-04-10T04:04:31.1820084+00:00",
"sales_organization_id": "c139a5f8-4e65-40c8-b935-1147107229dd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+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-04-10T04:04:31.1820084+00:00"
},
"project_status_id": "4ecc33e2-d865-4d01-ad92-0cd23d48b15d",
"project_status_code": "sample string 10",
"project_status": {
"id": "4c80f4e7-3c16-4dc6-b6b3-50688b9b5a0f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2a212b48-8a0d-44aa-8185-d3a41594d130",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00"
},
"company_id": "583fe0f5-8e22-473f-8040-534a842b9ab4",
"company_code": "sample string 12",
"db_address_id": "1f3a7e43-1d6e-46a4-82b2-cecf0085d5a4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2348700f-e044-4d4e-a562-ab8065c9ed38",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "af838db6-a6e3-45c0-a7c5-a7c5455716e6",
"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-04-10T04:04:31.1820084+00:00",
"date_create": "2026-04-10T04:04:31.1820084+00:00",
"date_update": "2026-04-10T04:04:31.1820084+00:00",
"updated_by_user_id": "e49d787c-64d3-4074-9bf8-a47d509847a7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-10T04:04:31.1820084+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-04-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-10T04:04:31.1820084+00:00",
"date_last_job": "2026-04-10T04:04:31.1820084+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-10T04:04:31.1820084+00:00",
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00",
"is_mobile_installation": true
},
"job_type_id": "2df1125c-b622-4338-bf4a-a10826e029a4",
"job_type_code": "sample string 7",
"job_type": {
"id": "403404b1-d874-4f57-b06f-2967ad5038be",
"name": "sample string 2",
"sales_organization_id": "01c05b3e-d44b-4748-bf10-a7115b3bfe2b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00",
"code": "sample string 7"
},
"job_priority_id": "1a54834e-e699-42c6-a5df-ea8ce670f9f6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "51508866-8568-4e0c-b78a-e7e6a363880e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c0461842-524a-4b27-9d82-333394a9376a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00"
},
"job_status_id": "0c73b852-83bf-4664-8636-08eba1fde66d",
"job_status_code": "sample string 11",
"db_address_id": "f7ca1740-53d2-469c-9652-483615da9fe5",
"contact_id": "04750c22-5e3c-4dae-b72e-483a1aca3fe0",
"requested_by_company_id": "08564b32-442d-443f-946f-2715053e8aff",
"requested_by_contact_id": "fafdda5c-930d-449c-8fe3-8ac4a44ed01f",
"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-04-10T04:04:31.1820084+00:00",
"due_date": "2026-04-10T04:04:31.1820084+00:00",
"date_create": "2026-04-10T04:04:31.1820084+00:00",
"date_update": "2026-04-10T04:04:31.1820084+00:00",
"date_closed": "2026-04-10T04:04:31.1820084+00:00",
"suggested_user_id": "2271fd8c-c0fa-4d56-b960-22bd6d4fd3f4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "34ce60a0-1f54-4ec6-bd91-0b06731aa055",
"db_language_id": "c547bcd0-6790-4bf7-9b9f-677d114da0fe",
"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-04-10T04:04:31.1820084+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e2f39924-f0f3-4fb0-8f6a-cc1d839a7e25",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "31201cbe-68ea-4ed6-9f42-9cb033806caa",
"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": "f6ac395c-5ddd-4052-9e63-2b3770e17c89",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4cbfa825-53d4-4de5-95e2-d20945420fcf"
},
"suggested_date_start": "2026-04-10T04:04:31.1820084+00:00",
"skill_id": "a53c64af-f533-46e3-9ce6-1156f989caa0",
"skill_code": "sample string 32",
"skill": {
"id": "5628d282-b290-44a0-99e0-6ee983b18fd3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5d69dcbb-8fb1-4434-b99c-35ee7c5fce1e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "71f88c26-3904-4d22-bcac-6744c68692ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "684c3045-cd93-4304-9d9b-10eab5e1052d",
"db_currency_id": "9eb0da2e-1580-47e0-9808-b62b9c68f5a7",
"db_language_id": "c6432bc7-a7e5-4fae-a8ef-694f1961e0ff",
"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-04-10T04:04:31.1820084+00:00"
},
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b77fcb0e-f753-4b30-8b48-c7072ba5d5f3",
"date_reported_by_company": "2026-04-10T04:04:31.1820084+00:00",
"id2": 36,
"company_id": "6b3785cf-67d8-4de9-96f0-a8bfeaec9532",
"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": "4ad9156b-b9bd-41b0-b11f-a1637a401a68",
"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-04-10T04:04:31.1820084+00:00"
},
"work_instruction_details_id": "c14dd12b-38bb-4ef5-b223-c504c861f387",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c3a7e6ba-6654-40e1-8269-78073b93514b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "79a52686-cd62-44d0-8f44-bb7d61957ab6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-10T04:04:31.1820084+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": "8f3fc13c-0661-407e-b4bd-a4a8857a7196",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-10T04:04:31.1820084+00:00"
}