Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "2cc47aeb-fbdc-45f0-8e11-680126f832e4",
"jobs_id": "f0a616a6-8f30-4307-b69e-e6bbcba733f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "62eed12a-ee79-41e4-addd-92dbcf79b5d0",
"_parent_id": "0faa0ebe-6bdc-4b10-a39d-8cfed21bdddf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5ba7212c-93fe-44d7-bde6-dae727219b07",
"project_reference_back_office": "sample string 5",
"project": {
"id": "077877cd-447b-4f59-ba38-714af16aa47b",
"_parent_id": "b765e267-f29b-4038-b0ea-60fe18b034a7",
"root_parent_id": "21938c74-b890-4bd3-a5fe-63db8c48b752",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cf436c22-3b83-4b3d-90df-aab73fe14bd3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "26549ea4-e43e-4e54-a632-855adcc34777",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "03acee9b-b6b8-4e62-95c4-036c98e0a863",
"_parent_code": "sample string 6",
"sales_organization_id": "901e0938-68e3-4f91-8f40-97d214630830",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+00:00"
},
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00"
},
"equipment_model_id": "9bc3d94f-4c1b-469f-b45c-f3063c2b6225",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2d5a7cbd-644c-4ad8-85fd-2c1df23f00d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "72d38775-30aa-48a8-8442-5a02082f9f48",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4993b55a-6438-40cc-8cd0-713e52eebde1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "19a7328c-edd4-4f7c-b2fe-3a356f213751",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+00:00"
},
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00"
},
"equipment_family_id": "bfa8f12e-d89c-49e2-b641-fa4a85fce49b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "26549ea4-e43e-4e54-a632-855adcc34777",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "03acee9b-b6b8-4e62-95c4-036c98e0a863",
"_parent_code": "sample string 6",
"sales_organization_id": "901e0938-68e3-4f91-8f40-97d214630830",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+00:00"
},
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00"
},
"date_in_production_since": "2026-04-24T06:21:45.3581243+00:00",
"date_out_of_production_since": "2026-04-24T06:21:45.3581243+00:00",
"date_end_support": "2026-04-24T06:21:45.3581243+00:00",
"sales_organization_id": "f1dba4e8-556b-470e-b5ae-4b438840f875",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+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-24T06:21:45.3581243+00:00"
},
"project_status_id": "ed027379-2cc4-4346-8411-a401a3b9bcb9",
"project_status_code": "sample string 10",
"project_status": {
"id": "e552383c-a873-4b85-8b78-eb274610e554",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ae99a0b9-d9a0-4e76-a066-cc23f998d3cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00"
},
"company_id": "a0ee82d4-1afd-4496-a3d6-017ff0c5fa4d",
"company_code": "sample string 12",
"db_address_id": "7e6f9dcf-ffde-4344-baeb-3bc5cbec8c2e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "50ee8603-504c-4973-a848-5180993b5879",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6b5c5a31-0415-43e0-8064-7bf48db3d554",
"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-24T06:21:45.3581243+00:00",
"date_create": "2026-04-24T06:21:45.3581243+00:00",
"date_update": "2026-04-24T06:21:45.3581243+00:00",
"updated_by_user_id": "7001c91b-8d65-47fd-854e-372ba0f02ef8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T06:21:45.3581243+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T06:21:45.3581243+00:00",
"date_last_job": "2026-04-24T06:21:45.3581243+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T06:21:45.3581243+00:00",
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00",
"is_mobile_installation": true
},
"job_type_id": "7e6ee018-3af4-48e1-a860-04b1951b3462",
"job_type_code": "sample string 7",
"job_type": {
"id": "dae5c672-7f12-42be-bd33-a89a4f76f2de",
"name": "sample string 2",
"sales_organization_id": "99e37d86-094b-43d8-bd40-25ae3a781ea8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00",
"code": "sample string 7"
},
"job_priority_id": "372173d5-ae74-477a-bc7a-f6b19ad91271",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "22f56369-61d7-4a64-80e6-76f59c6cbf2d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "71e283ba-2ed6-46c5-b76e-b6fbbaf21ede",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00"
},
"job_status_id": "85f2bdd6-c7e9-40ae-8bdf-cc1e55cb3575",
"job_status_code": "sample string 11",
"db_address_id": "b36cba72-31af-4a56-bdb8-73e4c4847919",
"contact_id": "18a357ba-19db-4855-94de-c2c7ec41332b",
"requested_by_company_id": "74dc2fdc-21eb-46dd-98aa-87453f6ec920",
"requested_by_contact_id": "e1229370-9ac0-44de-a431-bfb06f7a4bb5",
"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-24T06:21:45.3581243+00:00",
"due_date": "2026-04-24T06:21:45.3581243+00:00",
"date_create": "2026-04-24T06:21:45.3581243+00:00",
"date_update": "2026-04-24T06:21:45.3581243+00:00",
"date_closed": "2026-04-24T06:21:45.3581243+00:00",
"suggested_user_id": "5ab6b9e8-096a-4e26-bf07-76737fdea7f0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "910386c1-3e70-4f89-8cba-0b9c3898a97b",
"db_language_id": "c5f1f664-814e-4a75-9e17-814db2d40f1b",
"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-24T06:21:45.3581243+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a75f2ca2-c1a5-44b1-bda8-cccdcd3554fc",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea978fcf-6bd6-476e-b168-ba5a412a5ccb",
"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": "476f7f2f-fd35-49c5-b13b-71854fcebcb3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a426ac55-9f8d-4b51-8f64-60b602eb4819"
},
"suggested_date_start": "2026-04-24T06:21:45.3581243+00:00",
"skill_id": "1ba9f66c-fe30-455b-accf-f817d7675916",
"skill_code": "sample string 32",
"skill": {
"id": "f2f4c03d-83ab-4b96-acb8-a107a4186623",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "62ec47d3-8ddd-4d39-a1da-9cd2f82ff2d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0ee1a02-800b-43ef-afaa-a91358572a1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "027db9a6-46af-498d-8da3-0077ef3f11d4",
"db_currency_id": "ff91743c-04fa-4dfc-9937-d067a3992eb4",
"db_language_id": "81cb4d6c-5f3d-487c-a268-7a0b23c61a9a",
"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-24T06:21:45.3581243+00:00"
},
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "75289f53-86a9-4d5f-9185-a10a8e2b83f2",
"date_reported_by_company": "2026-04-24T06:21:45.3581243+00:00",
"id2": 36,
"company_id": "9b0beb44-6564-4b95-b505-408124980913",
"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": "5b478140-bbab-4972-9e19-795ed3b2d6e9",
"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-24T06:21:45.3581243+00:00"
},
"work_instruction_details_id": "c5ee067c-00bb-494a-84df-753108518e0b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "111dd348-bd97-46e2-9266-167ec29773a2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "15cdc6e8-10b1-434a-9c67-3e0e9806cb39",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T06:21:45.3581243+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": "033e5453-e747-4c7a-9bb9-70781c6fa07b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T06:21:45.3581243+00:00"
}