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": "21a7384e-be6a-4b96-9d52-a0566b0bd338",
"jobs_id": "e07cf088-5d24-45b0-a2e4-561e0daa8faa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e1784ea2-5a32-4847-8e4f-dc7ec2ef5ba6",
"_parent_id": "fe4bd106-8695-4e6a-a143-549e765421d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e1ff1d78-b0e2-45e8-b9cb-fc1b9651f6c8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ca0b11f0-26b2-4f0c-8021-8ebc5a9ce96d",
"_parent_id": "e0698324-272e-491f-816c-620424094c86",
"root_parent_id": "5c43baa9-33d5-4354-a4c7-34f2e01fb1e9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b45d435e-4a61-4205-8645-b1735df0325e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6e5b9d65-6c45-45f8-ac41-fdf0affa114e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12f85194-7655-4390-91f7-633dfb189767",
"_parent_code": "sample string 6",
"sales_organization_id": "fbe42660-0ea7-4047-906b-4fe60927fb05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+00:00"
},
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00"
},
"equipment_model_id": "32a32a2f-829c-444f-a7f7-4b20170c65cc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a6e91b7b-96cc-4e5b-8cfd-efafb870f45f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bf548f1c-13cf-4d20-a73f-31c69cdfc3cc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "05445466-d828-45e6-81bb-d6f3f881b8c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5816d818-8827-4741-9a5c-974e24e9759d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+00:00"
},
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00"
},
"equipment_family_id": "6ace56da-60bf-4676-b5c3-2738b6aac7a4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6e5b9d65-6c45-45f8-ac41-fdf0affa114e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12f85194-7655-4390-91f7-633dfb189767",
"_parent_code": "sample string 6",
"sales_organization_id": "fbe42660-0ea7-4047-906b-4fe60927fb05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+00:00"
},
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00"
},
"date_in_production_since": "2026-10-23T09:13:40.5676715+00:00",
"date_out_of_production_since": "2026-10-23T09:13:40.5676715+00:00",
"date_end_support": "2026-10-23T09:13:40.5676715+00:00",
"sales_organization_id": "d6ffa8aa-ea61-4933-87d8-9f4f87da5f09",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+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-10-23T09:13:40.5676715+00:00"
},
"project_status_id": "3e0267fc-9485-45ff-9d34-08ac142e1994",
"project_status_code": "sample string 10",
"project_status": {
"id": "ac3c4337-6db4-4e38-b458-decf850d2e6c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3e068fb6-c0c5-47dd-8b05-aa1504cc7325",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00"
},
"company_id": "819ec097-6fba-4867-a1f3-e35b850cc7ec",
"company_code": "sample string 12",
"db_address_id": "7ca15ec9-816c-4178-904a-be02d9560858",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "05be4066-6701-49f4-8a9e-74d10b8f5290",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "44f72716-c133-48fa-9cbb-2980f22df1ff",
"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-10-23T09:13:40.5676715+00:00",
"date_create": "2026-10-23T09:13:40.5676715+00:00",
"date_update": "2026-10-23T09:13:40.5676715+00:00",
"updated_by_user_id": "003eae24-9695-488c-91a6-0926e93c8895",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-23T09:13:40.5676715+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-10-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-23T09:13:40.5676715+00:00",
"date_last_job": "2026-10-23T09:13:40.5676715+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-23T09:13:40.5676715+00:00",
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00",
"is_mobile_installation": true
},
"job_type_id": "a2c92ea2-fd08-4531-a0fa-c03db3770a31",
"job_type_code": "sample string 7",
"job_type": {
"id": "8577391c-e449-48e7-954d-a4ceea56cd65",
"name": "sample string 2",
"sales_organization_id": "ab8852dd-8f0e-4b49-ba1b-933c8c550c14",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00",
"code": "sample string 7"
},
"job_priority_id": "6d2fe3f3-f4f5-4271-b389-0aba37a36a22",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "65945611-382f-43d5-ac01-a56fa6f89ac9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "099bc04d-852b-441c-a1e1-c81bd3cc1e2d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00"
},
"job_status_id": "9618f7ad-58c2-481c-a765-9e71cf8fe49c",
"job_status_code": "sample string 11",
"db_address_id": "14f5f3a9-f8b2-45f2-b7ab-2ef23b0d2b19",
"contact_id": "f332edab-913a-4cfd-a3ac-622fa255e85e",
"requested_by_company_id": "1ce16657-cddd-4007-9141-140751b9cb25",
"requested_by_contact_id": "a202f911-6090-4cb9-bb62-14ea5f3c50b1",
"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-10-23T09:13:40.5676715+00:00",
"due_date": "2026-10-23T09:13:40.5676715+00:00",
"date_create": "2026-10-23T09:13:40.5676715+00:00",
"date_update": "2026-10-23T09:13:40.5676715+00:00",
"date_closed": "2026-10-23T09:13:40.5676715+00:00",
"suggested_user_id": "7a7711ae-09b0-4773-886f-23eb4bca4d54",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1a7a99c3-4abd-423a-96dd-27a0a9b0d759",
"db_language_id": "cdf2ac34-04ad-4ed7-a023-eb4ee0ea34d6",
"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-10-23T09:13:40.5676715+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f0395234-06fd-41de-81bb-da81dbbff719",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "eb8f850c-b285-4f8c-856a-a9592efab0e7",
"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": "22da1907-ed6e-434f-ac31-3e3e943fb66f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c446a96a-8352-4904-abae-a56d36e00757"
},
"suggested_date_start": "2026-10-23T09:13:40.5676715+00:00",
"skill_id": "ed7d67bb-16c1-4241-81a8-e80080e2d56d",
"skill_code": "sample string 32",
"skill": {
"id": "9d1ab06d-749a-4c03-bcc8-c4dceb815ece",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "304b27d4-3ace-4b2d-b988-ed7350cbc9b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3e9df157-24bd-41fc-9b75-6e93dc223774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1fc5b2-5033-4e85-bc18-a4f1fb97d704",
"db_currency_id": "46fbf985-3535-4914-8b1f-628045cc3ded",
"db_language_id": "63525ddc-35d9-4943-9829-f1ab413abe64",
"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-10-23T09:13:40.5676715+00:00"
},
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0d61a85f-2df3-4b66-8b40-4e3c5c719876",
"date_reported_by_company": "2026-10-23T09:13:40.5676715+00:00",
"id2": 36,
"company_id": "09fe04bc-0188-4173-adf5-c36753e2c586",
"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": "4832700c-907b-4e7d-9e75-a1a0ceab2672",
"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-10-23T09:13:40.5676715+00:00"
},
"work_instruction_details_id": "f4d12204-a5a7-4045-80ac-be050d4d2276",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3e9f20e7-aa85-494a-8131-05279a29deb1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d1b29aa6-2cd6-4b79-bfc2-be0cf00ee301",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-23T09:13:40.5676715+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": "afc6556e-5e3b-4131-9f93-a6ab3a64d0da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-23T09:13:40.5676715+00:00"
}