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": "34d43d42-cb20-41af-ad9d-bf35e631bd81",
"jobs_id": "d68ca499-99f2-46a9-8ddb-a6f90cde5cba",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5615610a-5124-4b85-b138-8c5b92d5682c",
"_parent_id": "1cad6b74-dd76-42de-abba-c8ddc2746ddc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1bc9d78f-c4e9-4b25-8628-70d0c6cd50fd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6fd11244-333e-4f1f-8536-9d0a31005e65",
"_parent_id": "f1596db4-8f68-4700-bbd2-56e0ada59a0e",
"root_parent_id": "58a38196-5fc0-410e-b268-1f9a19fb8fbe",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f9c6eb4b-1ca5-423c-8322-a25ab9518a2c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "adff7c04-0ca6-4c65-b44d-349fa3157796",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "51d2b016-8c7d-4d37-bdc1-41a391d27ab9",
"_parent_code": "sample string 6",
"sales_organization_id": "7575dd4d-a9d9-452f-a652-3980276dab85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+00:00"
},
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00"
},
"equipment_model_id": "f20e9ea0-ca87-4701-aba9-271b97e7f81a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db2358bb-5bb5-49b6-b711-f077e875b1f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a2bb6373-b1be-4adb-b83e-c94f02fa72f4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5f834f01-a486-4940-95b8-9211905000ac",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a4ebdec4-2026-4dbd-aa0e-d9eea3e42997",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+00:00"
},
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00"
},
"equipment_family_id": "1ab80630-3f09-4d36-b959-07a938457395",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "adff7c04-0ca6-4c65-b44d-349fa3157796",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "51d2b016-8c7d-4d37-bdc1-41a391d27ab9",
"_parent_code": "sample string 6",
"sales_organization_id": "7575dd4d-a9d9-452f-a652-3980276dab85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+00:00"
},
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00"
},
"date_in_production_since": "2026-06-23T04:42:48.0095146+00:00",
"date_out_of_production_since": "2026-06-23T04:42:48.0095146+00:00",
"date_end_support": "2026-06-23T04:42:48.0095146+00:00",
"sales_organization_id": "3e6b041f-7179-4b1f-bf3a-2b79fbd3f650",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+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-06-23T04:42:48.0095146+00:00"
},
"project_status_id": "63cf131c-f680-4b7e-b7b3-40577da3a15c",
"project_status_code": "sample string 10",
"project_status": {
"id": "b71aff22-c538-468f-adc8-57fe870a73e6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9c0d0256-bf6d-4f70-babe-b15f6f205f80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00"
},
"company_id": "87b19e5c-edd9-48c8-8bcb-c7ff53f3f56f",
"company_code": "sample string 12",
"db_address_id": "4043dea0-9702-498d-bc36-fb6e853c7f0d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f5b8e424-6885-4c6d-b89e-aeadd48f2871",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd9f5240-cbed-4ab2-9808-f2ac1964fb8c",
"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-06-23T04:42:48.0095146+00:00",
"date_create": "2026-06-23T04:42:48.0095146+00:00",
"date_update": "2026-06-23T04:42:48.0095146+00:00",
"updated_by_user_id": "4b21fbbe-a455-4427-a432-dc0c34f4ff78",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-23T04:42:48.0095146+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-06-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-23T04:42:48.0095146+00:00",
"date_last_job": "2026-06-23T04:42:48.0095146+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-23T04:42:48.0095146+00:00",
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00",
"is_mobile_installation": true
},
"job_type_id": "0da3e390-1aad-4059-be49-a4b3d75fd76e",
"job_type_code": "sample string 7",
"job_type": {
"id": "6b18202a-340a-4112-a048-72a2b4a01563",
"name": "sample string 2",
"sales_organization_id": "a72bb7d7-0b81-45e5-a36d-b0a0a54bebe7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00",
"code": "sample string 7"
},
"job_priority_id": "ca30d512-f7a2-4f53-a12d-63ab7467eb9b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a81b9b8e-1342-4228-9eb2-c60a7a246e5b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fc1ad71e-0338-4453-8c99-755841b2de4c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00"
},
"job_status_id": "f113fccb-4fe9-4ab4-8bdc-4edc2f7b7dab",
"job_status_code": "sample string 11",
"db_address_id": "be4ed9f7-1d54-4884-8ca6-97e0a8ee7aea",
"contact_id": "90975e7b-8213-4fc6-90d1-c51f8a75c41d",
"requested_by_company_id": "c90e7abe-7fde-4afb-a5bf-8f81b639a0e3",
"requested_by_contact_id": "0c9a1e4c-48a6-41e7-bbae-7768f1063408",
"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-06-23T04:42:48.0095146+00:00",
"due_date": "2026-06-23T04:42:48.0095146+00:00",
"date_create": "2026-06-23T04:42:48.0095146+00:00",
"date_update": "2026-06-23T04:42:48.0095146+00:00",
"date_closed": "2026-06-23T04:42:48.0095146+00:00",
"suggested_user_id": "76579c2f-9142-48ed-b737-60d022c58719",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "519847f9-1ef4-425d-9380-535cd67b0e04",
"db_language_id": "8104f841-3834-4f5c-b2eb-0898c22e0175",
"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-06-23T04:42:48.0095146+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c0fe95ea-0d74-4485-a8c0-837a19147455",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4d72c9ac-624b-4560-81ec-0d432c3bf8f6",
"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": "48120860-48f0-4352-943d-fd47ff331886",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "22d8ebcd-99c2-4e22-b0dc-315a2ba233a1"
},
"suggested_date_start": "2026-06-23T04:42:48.0095146+00:00",
"skill_id": "dec3a7b3-35dc-4dbd-b43b-27b5223c5245",
"skill_code": "sample string 32",
"skill": {
"id": "3a3d7534-7609-4c49-b88c-f59f622b277a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b31f0932-1693-4943-b711-54bab7b666ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe46b729-9311-4130-988f-56eb2f2c795c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c63d3529-8528-4f6f-91ce-e963a8df5f2b",
"db_currency_id": "e60a2e71-93bc-4155-9e6f-4e0711b473db",
"db_language_id": "028e688c-e995-4943-9586-168167093fc9",
"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-06-23T04:42:48.0095146+00:00"
},
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3687abcd-cb1f-4efc-a7b2-905488d3b935",
"date_reported_by_company": "2026-06-23T04:42:48.0095146+00:00",
"id2": 36,
"company_id": "7ddeb759-161f-459f-a94d-31c397289ee2",
"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": "1f087dec-3013-4936-8710-cf015f28206f",
"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-06-23T04:42:48.0095146+00:00"
},
"work_instruction_details_id": "68af9e82-84b7-4e03-b05b-6348de050b5e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ff7180ad-0242-48a0-9ce5-b6e27e065b6a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4625d69a-ffcc-4f2b-8566-20568d5cc21b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-23T04:42:48.0095146+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": "c6fa0529-40f3-49f6-91e3-0cf215136702",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-23T04:42:48.0095146+00:00"
}