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": "184356c0-5a41-4273-a373-f73320d6eb41",
"jobs_id": "ee1cffc5-f844-4c77-894d-9a99da494192",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e5d412c1-c2a8-48f4-b506-d29040ba5f07",
"_parent_id": "721ff8df-e1d2-47cb-9271-c8933c688dd4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "07f01096-920e-4b76-96aa-b816a4b9f99e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c1c3ac72-e0bc-43cd-8463-d19c2926d7ae",
"_parent_id": "d2e74cf3-771f-4f68-883f-9ed5512e52e1",
"root_parent_id": "4310a8b5-5eda-4438-8675-b119888652bc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "91d1ea25-8158-4d8a-adbc-4a294b4398ac",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aaf0341f-0c6d-49b4-b22a-51ccf4e5c60d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d56aa38-3e34-47b9-93bc-9a13c35134a6",
"_parent_code": "sample string 6",
"sales_organization_id": "6e70a148-5492-417e-9b6f-83b3a25494a1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+00:00"
},
"modified_dateutc": "2026-08-24T13:14:18.8919779+00:00"
},
"equipment_model_id": "f47f7065-0085-4eb0-a661-28b316fb183d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0e617889-b3aa-4cc2-91dc-486cc4fea74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ebe70b00-135e-4b18-a9b7-2d6f4a0e12b8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "84baadd2-f7cd-4304-b4a6-ee4554117e8f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "174a36ce-c92d-4144-90df-c9b0bc01d3e9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+00:00"
},
"modified_dateutc": "2026-08-24T13:14:18.8919779+00:00"
},
"equipment_family_id": "eafa3259-0229-4e06-9463-2031fa48b703",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aaf0341f-0c6d-49b4-b22a-51ccf4e5c60d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d56aa38-3e34-47b9-93bc-9a13c35134a6",
"_parent_code": "sample string 6",
"sales_organization_id": "6e70a148-5492-417e-9b6f-83b3a25494a1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+00:00"
},
"modified_dateutc": "2026-08-24T13:14:18.8919779+00:00"
},
"date_in_production_since": "2026-08-24T13:14:18.8919779+00:00",
"date_out_of_production_since": "2026-08-24T13:14:18.9076037+00:00",
"date_end_support": "2026-08-24T13:14:18.9076037+00:00",
"sales_organization_id": "e8117ced-7d6f-4e46-8ba9-cd915a3fc9ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+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-24T13:14:18.9076037+00:00"
},
"project_status_id": "5ead0053-d6d2-4742-87cd-1cac88fc7e87",
"project_status_code": "sample string 10",
"project_status": {
"id": "287b5241-dfd8-4af4-9097-a13ee85393c3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d300ad27-bb80-4ac9-92a0-0ec0da22710d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-24T13:14:18.9076037+00:00"
},
"company_id": "10d04c70-5fc1-419a-9ac4-71af1e1964f4",
"company_code": "sample string 12",
"db_address_id": "272be140-cdb4-44da-8648-7955a257d210",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a78e0c32-2cfe-4fc5-bf5c-477c265f3123",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f37749bb-03e8-4db2-adbc-eade2d7c5c70",
"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-24T13:14:18.9076037+00:00",
"date_create": "2026-08-24T13:14:18.9076037+00:00",
"date_update": "2026-08-24T13:14:18.9076037+00:00",
"updated_by_user_id": "acb8275e-4989-4c32-8842-92636baaf1ca",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-24T13:14:18.9076037+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-24T13:14:18.9076037+00:00",
"date_last_job": "2026-08-24T13:14:18.9076037+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-24T13:14:18.9076037+00:00",
"modified_dateutc": "2026-08-24T13:14:18.9076037+00:00",
"is_mobile_installation": true
},
"job_type_id": "0ee2f85b-ba06-4fb2-85d5-615cc68c8ea4",
"job_type_code": "sample string 7",
"job_type": {
"id": "a1e495b0-9861-4024-a320-3c7b90325ada",
"name": "sample string 2",
"sales_organization_id": "67086fff-198c-4945-925f-cc425cc4c404",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-24T13:14:18.9076037+00:00",
"code": "sample string 7"
},
"job_priority_id": "e88135f4-f9a8-4f25-b14f-75f2816f1c7a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e8fd636c-2890-427a-a311-680ff7c889dc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "41441655-db0e-44c4-8c98-93fa7c45708d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-24T13:14:18.9076037+00:00"
},
"job_status_id": "149d5f16-1af4-4291-a113-8a1a1c8e1809",
"job_status_code": "sample string 11",
"db_address_id": "deb27d20-9bce-4d9c-bf06-6c89c1f5de39",
"contact_id": "9de448c6-4ca7-44ab-b912-32de791d63ed",
"requested_by_company_id": "56670ca9-4db8-4ac8-92db-02e6357d7731",
"requested_by_contact_id": "2c3efddb-4365-4771-a1de-e2534616218d",
"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-24T13:14:18.9076037+00:00",
"due_date": "2026-08-24T13:14:18.9076037+00:00",
"date_create": "2026-08-24T13:14:18.9076037+00:00",
"date_update": "2026-08-24T13:14:18.9076037+00:00",
"date_closed": "2026-08-24T13:14:18.9076037+00:00",
"suggested_user_id": "7378ee3e-50d1-4d74-8376-c37fa0312f54",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "326dee7f-9033-4c65-9237-e63b812b6a51",
"db_language_id": "216abaaf-f857-477a-854a-2970089d4f81",
"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-24T13:14:18.9076037+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6417985b-18d5-401b-bd5b-015fd5af21f3",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "062b7480-ca1e-48e9-afdf-bc71e392b6b1",
"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": "e460a947-ec7e-4973-86e5-abad3f61f4f7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-24T13:14:18.9076037+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a6ebc74c-0e33-4677-b6c9-832c41f247f0"
},
"suggested_date_start": "2026-08-24T13:14:18.9076037+00:00",
"skill_id": "48c0be7f-fbf6-47df-b4c1-8175ead0a45d",
"skill_code": "sample string 32",
"skill": {
"id": "72b97c0f-0237-4d68-8575-90e18da38dc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "385faa46-9ae5-4e13-827b-354d8497ecad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8ebdea7-9fe3-452f-beb4-e71b1f11d3d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd8ea28-f88b-4834-9db0-4e146046a1f9",
"db_currency_id": "7cd5962a-df1c-4b10-8852-cff60dd4dcf0",
"db_language_id": "8a67171a-85cd-448b-8b0b-e656f914b257",
"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-24T13:14:18.8919779+00:00"
},
"modified_dateutc": "2026-08-24T13:14:18.9076037+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fb0ac089-7ab2-4f04-801b-c5d110197eaa",
"date_reported_by_company": "2026-08-24T13:14:18.9076037+00:00",
"id2": 36,
"company_id": "135aa78f-a987-4e99-bc58-8ac2dc0e8512",
"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": "15d69209-ff96-4314-9e98-69007435e8c4",
"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-24T13:14:18.9076037+00:00"
},
"work_instruction_details_id": "39e7c7a1-c354-4cdd-ad68-35c6c2f8a227",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9c2338d9-409b-4d99-9f41-475a92bbea09",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a9c8fb58-f4a0-478c-8ff7-ecffb45a460b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-24T13:14:18.9076037+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": "f143494a-52e2-4fb0-8d4c-85a87423210e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-24T13:14:18.9076037+00:00"
}