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": "7c80653c-ee30-4df6-ab28-171bb2328572",
"jobs_id": "5568cd60-2484-4353-b4aa-8cb7c2ca1167",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3ada7023-fb67-48bf-a74e-05da563eafba",
"_parent_id": "398582c3-f9cb-431d-a28d-7620098342b9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9d890641-788f-4878-addd-dde373e55a52",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d014eb01-00b9-4fb9-9130-51c0608e4e97",
"_parent_id": "4dd100d1-1a43-48f9-a40b-fb28f3079c9c",
"root_parent_id": "1f2dd8eb-6002-4b37-b943-14ef903d8637",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1ac626a3-5582-4ba3-a3ab-edeca3bff40e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d7a0e17a-012c-408c-a4dc-30df8d632ab3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8ce0d78f-3aed-44ed-a449-a737cf241a6e",
"_parent_code": "sample string 6",
"sales_organization_id": "f340e46c-3f16-4192-a7e1-7fcaea488b57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+00:00"
},
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00"
},
"equipment_model_id": "02fd55da-35a0-496f-85c3-f915d48c5800",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "af08994b-d668-41f1-ad40-9d2199c37924",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2e7864be-4f1a-45b8-b918-175321563081",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "adce98c5-a0c1-4864-aac6-97d50fb2831d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "91e127b5-0d26-4ffe-b7ec-73d85046f8d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+00:00"
},
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00"
},
"equipment_family_id": "516a0757-97ee-4db0-b740-f3b2aa104d7e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d7a0e17a-012c-408c-a4dc-30df8d632ab3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8ce0d78f-3aed-44ed-a449-a737cf241a6e",
"_parent_code": "sample string 6",
"sales_organization_id": "f340e46c-3f16-4192-a7e1-7fcaea488b57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+00:00"
},
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00"
},
"date_in_production_since": "2026-09-20T22:40:59.4466306+00:00",
"date_out_of_production_since": "2026-09-20T22:40:59.4466306+00:00",
"date_end_support": "2026-09-20T22:40:59.4466306+00:00",
"sales_organization_id": "68285ee7-ca14-4869-bdbc-1fdbeab49bcc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+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-09-20T22:40:59.4466306+00:00"
},
"project_status_id": "285c2407-d952-4a98-b026-00ecfa1319f2",
"project_status_code": "sample string 10",
"project_status": {
"id": "e946c7df-e54d-4cd9-8a43-5f0489b00213",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b988546d-0900-473a-b465-38d661825bda",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00"
},
"company_id": "3ccb4c31-6b7f-4a80-8f83-08acac5a7d02",
"company_code": "sample string 12",
"db_address_id": "3d6038ce-34e6-4599-88a9-6f6faeb4b9f6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "29a2b970-92a7-4b39-855c-a78f176cd9b4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "001f2e04-830a-455a-b263-eecebb2483f3",
"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-09-20T22:40:59.4466306+00:00",
"date_create": "2026-09-20T22:40:59.4466306+00:00",
"date_update": "2026-09-20T22:40:59.4466306+00:00",
"updated_by_user_id": "d7080ff4-1937-468e-b42c-0ea8d016e70c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-20T22:40:59.4466306+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-09-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-20T22:40:59.4466306+00:00",
"date_last_job": "2026-09-20T22:40:59.4466306+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-20T22:40:59.4466306+00:00",
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00",
"is_mobile_installation": true
},
"job_type_id": "0f672c40-c063-4f51-bfc9-3ee163549bc4",
"job_type_code": "sample string 7",
"job_type": {
"id": "4d401ce7-2ccd-4781-a840-74d39191e923",
"name": "sample string 2",
"sales_organization_id": "dac4f410-6d65-44be-9a1d-164c57e95c24",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00",
"code": "sample string 7"
},
"job_priority_id": "63e68d6e-5c6d-42af-87ee-4eaaaa377b2e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f7ad4994-21bc-4f11-aa95-27f90974ef34",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ed3a04d5-c307-4647-ad1a-32d583c172d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00"
},
"job_status_id": "3d1cc5de-a3bc-4e0e-9f03-2fe4fbdfeac5",
"job_status_code": "sample string 11",
"db_address_id": "777ac0b4-5082-4a48-a73e-df2750d0e8fd",
"contact_id": "4e2c0086-30be-4eb3-ba5a-fd3cd6c03fb6",
"requested_by_company_id": "b1526a63-61d3-4a11-bf5f-0a5cf3a9e872",
"requested_by_contact_id": "6722d8f8-cf48-431a-a69c-710e22ed89eb",
"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-09-20T22:40:59.4466306+00:00",
"due_date": "2026-09-20T22:40:59.4466306+00:00",
"date_create": "2026-09-20T22:40:59.4466306+00:00",
"date_update": "2026-09-20T22:40:59.4466306+00:00",
"date_closed": "2026-09-20T22:40:59.4466306+00:00",
"suggested_user_id": "1cefc323-8347-4662-a03c-dc941d8db885",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "429f251a-2e2e-4e85-a157-a59f08aa1ea6",
"db_language_id": "3c427972-947f-4d83-8bc7-7522abdba8e9",
"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-09-20T22:40:59.4466306+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c650f5ff-7342-4b6d-af49-21d2f923abcf",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c31ecbdc-728f-405d-b9ac-47203dcdb9f9",
"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": "0ecb1c5f-6468-4d9b-9293-05b59013d54a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0c87155d-ac57-4e75-8b41-3ab5982ca617"
},
"suggested_date_start": "2026-09-20T22:40:59.4466306+00:00",
"skill_id": "39bb6af4-b0f8-491f-9a6c-527ceff70c4b",
"skill_code": "sample string 32",
"skill": {
"id": "f6e3b443-0692-4ec6-bd5d-4c09f5a925ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "433faeda-8e09-48f7-8d14-a80e83e7c99e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6d53627-c634-49ce-a5af-af5a5eda9c45",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8995d98b-7a74-4b09-a4e1-22a3315fee5d",
"db_currency_id": "44c78544-31cb-424d-8941-8ea30a9218c2",
"db_language_id": "c4587941-d887-48f7-9f77-9955d9bc84de",
"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-09-20T22:40:59.4466306+00:00"
},
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "21a4bb31-0df0-4c42-94d3-072524de5de2",
"date_reported_by_company": "2026-09-20T22:40:59.4466306+00:00",
"id2": 36,
"company_id": "e0b65b8c-f264-4aae-bdbd-e6aa8c348f86",
"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": "c108e99d-210e-435b-9bd2-88b7c6139c62",
"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-09-20T22:40:59.4466306+00:00"
},
"work_instruction_details_id": "e22d7423-53dc-4cc4-9d7c-c8d364d1161e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2fd38cc0-bad9-4efa-85b9-f2e323e123f4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "26122d00-5017-4c06-9e9b-20fa7240dc5b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-20T22:40:59.4466306+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": "132fa7f1-83f4-46b1-9967-73156744fdfb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-20T22:40:59.4466306+00:00"
}