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": "5844fb44-6b70-43bc-9662-87500fa73773",
"jobs_id": "aa36dba6-52ae-4a98-b67d-3260bfcc561a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6ea5c8e6-fe1f-4856-aa89-28461a487b8f",
"_parent_id": "f3a05355-596d-4cd5-b41c-bf6a7ff324d0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8796b029-513f-4a27-8b77-338e85b1e7b7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "74275a94-cb80-4b4a-ac22-5c8cb3d56e30",
"_parent_id": "a747aa62-f0d1-48c9-9489-127da3fc166b",
"root_parent_id": "20e46edd-0926-40d1-ace0-0d0764c06e27",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5dfa5096-11e2-4721-af6d-c37fee51a038",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "894634e0-a9e9-466a-8e54-b92fbbfbd01b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b5b8110c-b763-47eb-93fd-0a5368c498c6",
"_parent_code": "sample string 6",
"sales_organization_id": "9c429a6c-101d-4c17-bf14-6d9682831116",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+00:00"
},
"modified_dateutc": "2025-12-02T08:50:18.5667454+00:00"
},
"equipment_model_id": "507ee5a7-869a-46d8-98d0-ee852fdbfef4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f139f16e-78e7-4aae-9bdd-4bbd65e29ff2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "79ee79a2-0c32-45dc-9271-18fc4f2c89c5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0131cd34-2008-472a-9579-099e9b043930",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "514fc5ad-2540-46f0-a9d3-bd9709c91691",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+00:00"
},
"modified_dateutc": "2025-12-02T08:50:18.5667454+00:00"
},
"equipment_family_id": "b25fedae-6702-4596-a13c-893c3f8946be",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "894634e0-a9e9-466a-8e54-b92fbbfbd01b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b5b8110c-b763-47eb-93fd-0a5368c498c6",
"_parent_code": "sample string 6",
"sales_organization_id": "9c429a6c-101d-4c17-bf14-6d9682831116",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+00:00"
},
"modified_dateutc": "2025-12-02T08:50:18.5667454+00:00"
},
"date_in_production_since": "2025-12-02T08:50:18.5667454+00:00",
"date_out_of_production_since": "2025-12-02T08:50:18.5667454+00:00",
"date_end_support": "2025-12-02T08:50:18.5667454+00:00",
"sales_organization_id": "c893b263-401a-4d06-a18f-9c6ec1055e3a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+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": "2025-12-02T08:50:18.5667454+00:00"
},
"project_status_id": "0e852083-2af2-4ddd-bea5-b39c62b04159",
"project_status_code": "sample string 10",
"project_status": {
"id": "4b01180f-cf47-4c75-ba84-b480b12fceb1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9cef87cd-96c5-4146-ab58-7e8490537b83",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-02T08:50:18.5667454+00:00"
},
"company_id": "d629dfa7-d498-4490-a938-419c031a7a89",
"company_code": "sample string 12",
"db_address_id": "559fb76c-8fc8-4cd0-936e-2ab8564f5df2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f2f92e51-2341-4423-b8b5-a2b37969de74",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cad19cad-311c-4791-a66b-6059ea051294",
"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": "2025-12-02T08:50:18.5667454+00:00",
"date_create": "2025-12-02T08:50:18.5667454+00:00",
"date_update": "2025-12-02T08:50:18.5667454+00:00",
"updated_by_user_id": "f1ba71cb-ce81-414c-862a-67bcfcd72d9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-02T08:50:18.5667454+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": "2025-12-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-02T08:50:18.5667454+00:00",
"date_last_job": "2025-12-02T08:50:18.5667454+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-02T08:50:18.5667454+00:00",
"modified_dateutc": "2025-12-02T08:50:18.5667454+00:00",
"is_mobile_installation": true
},
"job_type_id": "ec417408-8318-41cc-92bd-0d4689806c30",
"job_type_code": "sample string 7",
"job_type": {
"id": "2a489d46-ad73-4c61-99a2-c5478f973d59",
"name": "sample string 2",
"sales_organization_id": "d1a5775a-4a1c-4fcc-90b9-bc0c56dab5bc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-02T08:50:18.5667454+00:00",
"code": "sample string 7"
},
"job_priority_id": "c60171ae-5697-44e1-a9da-8aeb7ded0e7f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f50dc9c5-614e-46dd-abcd-ceac07776ba3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "65ed3500-bdd4-4caa-b7a2-510342fed3ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-02T08:50:18.5824287+00:00"
},
"job_status_id": "8a43bd72-d29d-4811-9ba7-2f1837e36c57",
"job_status_code": "sample string 11",
"db_address_id": "ff352ec1-5d3e-4040-8d08-3e441958d43c",
"contact_id": "e404d568-8ecf-42c7-a421-6665bbf5252f",
"requested_by_company_id": "cbbcccd6-b550-4d72-a4b7-3d5097eafe13",
"requested_by_contact_id": "e3126dd3-b80f-4bf2-94da-a83a3851952f",
"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": "2025-12-02T08:50:18.5824287+00:00",
"due_date": "2025-12-02T08:50:18.5824287+00:00",
"date_create": "2025-12-02T08:50:18.5824287+00:00",
"date_update": "2025-12-02T08:50:18.5824287+00:00",
"date_closed": "2025-12-02T08:50:18.5824287+00:00",
"suggested_user_id": "3b897537-83c6-4f9e-b124-d936f03f0516",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7c265c84-1c3b-49d2-80c7-420248511e60",
"db_language_id": "df00f43f-c02a-4cba-bdbf-9cd188fb5dbb",
"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": "2025-12-02T08:50:18.5824287+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a889f476-0c6e-49fd-aa82-18fb7d28c474",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8531d39d-0c9c-40a6-b8bb-6aca829e0973",
"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": "a75650f0-cf7c-4063-b780-659e1bd6e64d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-02T08:50:18.5824287+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "65774271-58d6-4f7b-87c9-940414c66324"
},
"suggested_date_start": "2025-12-02T08:50:18.5824287+00:00",
"skill_id": "0bde9b5a-e8fa-4585-b063-babd3d9bda47",
"skill_code": "sample string 32",
"skill": {
"id": "866c7207-c3be-444b-83ab-c673602a3e7f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f01925a3-32f4-49e5-984a-c92d2bb37ca8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d7a5e53-5ad3-4807-bd4b-2155ef2efd68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4013494-61fd-4a76-b328-443fcad71ce3",
"db_currency_id": "8906dc7e-3310-45f2-b354-da10c091db31",
"db_language_id": "1fd112b4-7fa9-489c-b7c1-c21cfbffa8b4",
"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": "2025-12-02T08:50:18.5667454+00:00"
},
"modified_dateutc": "2025-12-02T08:50:18.5824287+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2bd815fe-9da9-4267-b4b6-610479a600a4",
"date_reported_by_company": "2025-12-02T08:50:18.5824287+00:00",
"id2": 36,
"company_id": "d162a8ef-bdd3-4848-a4ee-311684e75b04",
"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": "1bfdb263-46e9-4d55-818a-492ddbc60373",
"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": "2025-12-02T08:50:18.5824287+00:00"
},
"work_instruction_details_id": "1e460cde-7cf9-4fa9-b173-36e5ec5a54e5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4eca3a72-778a-4d09-9356-7e25b743fc9d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f716478b-e3b2-4086-8cb0-2ec9c63fc8b2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-02T08:50:18.5824287+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": "0ce1ee9c-dcfe-4b6e-ae2a-5f9f84aa1e82",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-02T08:50:18.5824287+00:00"
}