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": "ed31994b-4c61-431a-8256-a49a34fa18d1",
"jobs_id": "14d4379c-ea86-4d2d-bf7b-01584d887e44",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f75c2ab8-0af3-468a-a41d-c299c46eafbe",
"_parent_id": "26df6047-1ca3-4418-b228-43a04d21d443",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "42ba8f62-6a28-4d4e-bfbd-da1d0aeb97cc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "529a9a31-0a6e-47e6-a9d0-cb53063793b5",
"_parent_id": "b75dbbe3-6431-4b8c-8bcd-ecd89ee397ed",
"root_parent_id": "845d6246-8d4f-4aa8-8932-f3e56516e031",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2b153047-f4eb-481a-87cc-912b8ef02177",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8c7f1d01-e584-48e1-8183-332d0765baec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2348fcd-cd10-48b7-b4e3-691ca30a93e2",
"_parent_code": "sample string 6",
"sales_organization_id": "3d2628de-d2c8-443b-98aa-706d8b3d48c6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+00:00"
},
"modified_dateutc": "2026-01-11T00:00:05.1340996+00:00"
},
"equipment_model_id": "e0432120-7bc1-4dc9-8917-a58bdfb7cdbc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9de2a673-b9fe-42c7-9650-4acb80fac335",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f77670fc-9f4d-48bd-b6ba-a14bdd9162a7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a6ba3b77-91ac-4ed4-a941-a408a62c532d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1a339ed4-e8ba-4110-beda-3a7f2be8dcee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+00:00"
},
"modified_dateutc": "2026-01-11T00:00:05.1340996+00:00"
},
"equipment_family_id": "3db478cf-2479-45a9-988c-849e4a88b455",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8c7f1d01-e584-48e1-8183-332d0765baec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2348fcd-cd10-48b7-b4e3-691ca30a93e2",
"_parent_code": "sample string 6",
"sales_organization_id": "3d2628de-d2c8-443b-98aa-706d8b3d48c6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+00:00"
},
"modified_dateutc": "2026-01-11T00:00:05.1340996+00:00"
},
"date_in_production_since": "2026-01-11T00:00:05.1340996+00:00",
"date_out_of_production_since": "2026-01-11T00:00:05.1340996+00:00",
"date_end_support": "2026-01-11T00:00:05.1340996+00:00",
"sales_organization_id": "85b56bca-71a1-4a8c-a2f6-49d9368c3f4c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+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-01-11T00:00:05.1497228+00:00"
},
"project_status_id": "d91308f4-7604-40bd-9f60-fd6b49675449",
"project_status_code": "sample string 10",
"project_status": {
"id": "fe28ba94-0872-4b4f-b61e-0f015161418c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bfd5190c-01a3-413d-bef6-d4e1819252cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-11T00:00:05.1497228+00:00"
},
"company_id": "902945a5-bfad-41f3-b7e9-15df47489994",
"company_code": "sample string 12",
"db_address_id": "6b870fcf-bc4b-42ea-bbe5-b1a6cf4aa294",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5bdc3790-e035-4908-b746-5d179ad698d1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "529e00db-bae0-4658-9f7b-7ff0441d2eaf",
"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-01-11T00:00:05.1497228+00:00",
"date_create": "2026-01-11T00:00:05.1497228+00:00",
"date_update": "2026-01-11T00:00:05.1497228+00:00",
"updated_by_user_id": "6bd51ea6-31d8-43b3-8384-e3540c81d809",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-11T00:00:05.1497228+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-01-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-11T00:00:05.1497228+00:00",
"date_last_job": "2026-01-11T00:00:05.1497228+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-11T00:00:05.1497228+00:00",
"modified_dateutc": "2026-01-11T00:00:05.1497228+00:00",
"is_mobile_installation": true
},
"job_type_id": "9e0b9cfa-7b7a-4db4-9e6b-1e3d94d4f7b9",
"job_type_code": "sample string 7",
"job_type": {
"id": "0a6021cf-7b94-4aeb-9077-1b367971b250",
"name": "sample string 2",
"sales_organization_id": "f733e5a8-a550-4a8b-901c-bdf53c6e2dc5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-11T00:00:05.1497228+00:00",
"code": "sample string 7"
},
"job_priority_id": "87f3c87f-b225-4f6a-a1b9-63982135e724",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "09055b10-c34e-460c-965b-3dfd2d76fd38",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ef52c0aa-7b13-476a-9aa8-e18b0abae306",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-11T00:00:05.1497228+00:00"
},
"job_status_id": "985f2614-2ed5-4816-9346-166ac7abcdb7",
"job_status_code": "sample string 11",
"db_address_id": "3615cae2-6f71-4494-a509-7a9cbee168b2",
"contact_id": "251589eb-999c-4c31-bd8f-4bdfa2b9a6a7",
"requested_by_company_id": "70192df3-4bfe-4f88-9966-21e878a0fa08",
"requested_by_contact_id": "b736f452-25fe-48a5-95f9-44f607a1e89e",
"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-01-11T00:00:05.1497228+00:00",
"due_date": "2026-01-11T00:00:05.1497228+00:00",
"date_create": "2026-01-11T00:00:05.1497228+00:00",
"date_update": "2026-01-11T00:00:05.1497228+00:00",
"date_closed": "2026-01-11T00:00:05.1497228+00:00",
"suggested_user_id": "7d8f9097-1d1e-4179-9f57-6420e613ee7d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1d8328fa-6309-4f90-b2bc-14f6bbfb5354",
"db_language_id": "966d7d0d-0bcb-4854-ad60-b1bc017df6c2",
"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-01-11T00:00:05.1497228+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89615d1f-5a4d-4d79-93d1-942b3beec38b",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e5adf4c5-93cc-4f13-a98d-ed214418386f",
"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": "3f2ae16e-26e0-479f-bc48-42a68e891ada",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-11T00:00:05.1497228+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ad844fcf-9819-44d2-8542-38350974a4dc"
},
"suggested_date_start": "2026-01-11T00:00:05.1497228+00:00",
"skill_id": "de7dd88f-e52d-423c-b8d0-3311c1871b79",
"skill_code": "sample string 32",
"skill": {
"id": "b6931884-cfb8-47ff-abd5-98d528e41f69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1a049e5a-2453-4936-82d5-d6bb78e2fca7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3ee7fc68-b97c-4e0c-80a1-02245e3c19bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a6fd898-1fc7-4be6-9eb5-d29e3c765be1",
"db_currency_id": "55ea1207-a960-443d-b374-cbb07acfb93d",
"db_language_id": "c25e4a89-4a4c-498e-9d3f-105ffe397072",
"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-01-11T00:00:05.1340996+00:00"
},
"modified_dateutc": "2026-01-11T00:00:05.1497228+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e7739110-ecd1-42c9-997c-5c070fb7767e",
"date_reported_by_company": "2026-01-11T00:00:05.1497228+00:00",
"id2": 36,
"company_id": "b085047e-be42-4b68-b5d0-db447336549a",
"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": "f7c5d3b9-407f-4467-883d-733a76c6b1e0",
"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-01-11T00:00:05.1497228+00:00"
},
"work_instruction_details_id": "74fbf53d-ea45-470a-8ee3-f98fa84d0b58",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1e90c3bc-1298-4c8b-ae03-af4a16b28357",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "118634d7-09a0-44ba-bd9b-a825c1e341fe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-11T00:00:05.1497228+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": "972b2db8-d169-4415-a0aa-32102c5e4f7d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-11T00:00:05.1497228+00:00"
}