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": "b545335f-1af6-4e61-91bf-3616f12caede",
"jobs_id": "c69e2fa4-88fd-4a92-9060-fce07e69d038",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "759f4ad6-cb1f-4052-8294-d842248b35f1",
"_parent_id": "1686f631-1f96-4db0-9fa6-80410ea285fa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e9c54451-4ad7-407b-ab55-b36d6755c59a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "04568cb1-74c3-4109-a3bc-321bd0d8f158",
"_parent_id": "447794b3-dbac-4274-aaf0-5c60a8ab2dcb",
"root_parent_id": "f09269b8-1667-4ca8-a003-013473865c3f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f4a59cf0-536e-4713-88ea-f6ce2781250b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d773cab6-dbc8-4864-a5be-469166050ca9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8a551b30-f853-4675-8001-93100f9b3294",
"_parent_code": "sample string 6",
"sales_organization_id": "bc24cdd2-8da6-4408-a8f0-22617177da7e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+00:00"
},
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00"
},
"equipment_model_id": "6632c8af-0a9e-432d-87f3-48ec5ffe5cad",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ff790469-0213-4eb7-82bf-bda4aee8e588",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e3861caf-cbfd-4927-80a8-6856aedbde68",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "54a0e552-59b1-47c4-a049-3a9afed67239",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e6a2bc41-ae69-4239-87fb-41b32aa6b035",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+00:00"
},
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00"
},
"equipment_family_id": "056d4a3f-231b-4e6d-a1ba-bdc8ae8993b6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d773cab6-dbc8-4864-a5be-469166050ca9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8a551b30-f853-4675-8001-93100f9b3294",
"_parent_code": "sample string 6",
"sales_organization_id": "bc24cdd2-8da6-4408-a8f0-22617177da7e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+00:00"
},
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00"
},
"date_in_production_since": "2026-08-15T12:15:43.1696024+00:00",
"date_out_of_production_since": "2026-08-15T12:15:43.1696024+00:00",
"date_end_support": "2026-08-15T12:15:43.1696024+00:00",
"sales_organization_id": "75034945-7e26-4ad4-a276-7fbba3b156e3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+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-08-15T12:15:43.1696024+00:00"
},
"project_status_id": "38672335-d7d7-4030-bd1f-99de14d368ad",
"project_status_code": "sample string 10",
"project_status": {
"id": "bcac23fe-e331-41c8-9ba3-411736e865ac",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ba9ce491-df68-41c4-bd12-c7f3dbf0dca4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00"
},
"company_id": "390aefb3-dd10-4579-977e-02388b208ba6",
"company_code": "sample string 12",
"db_address_id": "b09553ca-f845-4b37-97b3-f2ac62ea299a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f8a7293-2f6c-430f-8779-738841d10de9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5f0c9ff6-14df-457e-8831-3f1f58e09bf9",
"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-08-15T12:15:43.1696024+00:00",
"date_create": "2026-08-15T12:15:43.1696024+00:00",
"date_update": "2026-08-15T12:15:43.1696024+00:00",
"updated_by_user_id": "d49b7b10-d082-421a-88d1-05b386d9e63d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-15T12:15:43.1696024+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-08-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-15T12:15:43.1696024+00:00",
"date_last_job": "2026-08-15T12:15:43.1696024+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-15T12:15:43.1696024+00:00",
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00",
"is_mobile_installation": true
},
"job_type_id": "bf7b7908-835a-4a06-97ed-1b3c8441f4a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "2008e1ae-406d-46da-9063-1c97f5507962",
"name": "sample string 2",
"sales_organization_id": "4c7da57c-ba65-4819-a923-ab22f28fe4a3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00",
"code": "sample string 7"
},
"job_priority_id": "62d5eb3f-287c-4e42-86db-52dcc94d17a7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e3028c01-c399-419d-b44f-3d87586f8712",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6f0cf544-fa37-470a-8fa6-7590e741769c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00"
},
"job_status_id": "be193ef9-1bb2-4fd3-b476-eb7f47e3db90",
"job_status_code": "sample string 11",
"db_address_id": "dbcb11a1-3fce-4ce9-a103-3bc2a4163c3b",
"contact_id": "7550aebd-81e1-4a17-a9de-dc9cdea64a29",
"requested_by_company_id": "1843b5be-0316-4040-bad5-3c199dcee33d",
"requested_by_contact_id": "7d13d90f-e59e-43eb-a219-ba8a72f52203",
"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-08-15T12:15:43.1696024+00:00",
"due_date": "2026-08-15T12:15:43.1696024+00:00",
"date_create": "2026-08-15T12:15:43.1696024+00:00",
"date_update": "2026-08-15T12:15:43.1696024+00:00",
"date_closed": "2026-08-15T12:15:43.1696024+00:00",
"suggested_user_id": "5ad623d8-4e18-4265-9619-dbcb1ff732b1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c9bf0faf-db70-4a3a-91f4-ea4b312455dc",
"db_language_id": "8decfbda-3d1a-4923-a887-af2657026778",
"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-08-15T12:15:43.1696024+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5e28bb65-b6d1-457c-aae3-bd47121500d7",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b1196082-a07b-4945-8185-d51e0fc7549d",
"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": "2d10ff7e-a579-407a-a918-6e16a0b031fc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c85ce269-30a7-4d1a-8723-82c0e8264766"
},
"suggested_date_start": "2026-08-15T12:15:43.1696024+00:00",
"skill_id": "1fc02119-97ec-469c-ba91-5b2ae4833c55",
"skill_code": "sample string 32",
"skill": {
"id": "ee6eaee6-7d6b-4afd-85d1-3ef1f81fea03",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "854133f2-92f5-4d39-a342-89f2fccae13e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c7ebf36f-4580-4161-8ac5-564dddd11b52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc5ebab7-e7fa-4f77-b413-28c1d605e56f",
"db_currency_id": "b8c607a1-597a-42a3-b748-c2fad0187740",
"db_language_id": "aaf3e267-3e73-426c-8a56-3b8b46261905",
"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-08-15T12:15:43.1696024+00:00"
},
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4de021bf-7d1c-4840-aecd-4cdc7d3af050",
"date_reported_by_company": "2026-08-15T12:15:43.1696024+00:00",
"id2": 36,
"company_id": "b5eaec47-6508-4b4a-b359-7c14f1d2eaa4",
"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": "74251512-38f8-47c9-8355-e8b0d1647d3b",
"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-08-15T12:15:43.1696024+00:00"
},
"work_instruction_details_id": "627b039d-f9e8-48ba-a1d4-c688d5ceaf9d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0e6749db-100b-44d9-acf2-bd5d1699b1ca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0ae8b716-5e0f-4fde-9bb3-717adbe99b76",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-15T12:15:43.1696024+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": "57a0f9c1-d465-41a8-8af9-af09e3357d3d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-15T12:15:43.1696024+00:00"
}