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": "4a75d17c-6812-4e52-b37c-6783b87a24d5",
"jobs_id": "3551d304-f290-49f5-a5c7-eb114b6c0d85",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e25607df-877c-4a88-9cc7-21c8e7309f28",
"_parent_id": "b8ffbdb7-d73d-4654-a7c0-e539c8623624",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b13014ae-e1e2-4ffe-8e22-75c48ed43dc7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8394e61c-a9c2-4f06-aff7-645e735b3feb",
"_parent_id": "df28b25c-8745-4c15-85c8-bc6344c9bdf5",
"root_parent_id": "10a9d644-be95-4148-9ca2-c30d30a474ef",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c0550747-50d4-432a-8e14-68dd92c3c38a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fb80707d-253e-41a4-94e7-7a54028e3fc2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2bebe010-873a-4677-a133-ecba8b5e5fca",
"_parent_code": "sample string 6",
"sales_organization_id": "d8270395-9781-4140-a785-b88f2516f8b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+00:00"
},
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00"
},
"equipment_model_id": "3eef685f-4202-4058-b9cb-9dbf0da8f3e4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bd255d98-2e17-4129-a902-747f42fce5e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5f18591a-2be0-4253-9a53-cac297ff541c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "df0083b7-c1b6-4310-bff6-c981a8311310",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a20b7796-5872-4d5a-a4fa-9316e51c2577",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+00:00"
},
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00"
},
"equipment_family_id": "d1c89cea-7d4f-4d37-a3ee-2f8d63771eab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fb80707d-253e-41a4-94e7-7a54028e3fc2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2bebe010-873a-4677-a133-ecba8b5e5fca",
"_parent_code": "sample string 6",
"sales_organization_id": "d8270395-9781-4140-a785-b88f2516f8b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+00:00"
},
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00"
},
"date_in_production_since": "2026-09-23T15:17:02.0557552+00:00",
"date_out_of_production_since": "2026-09-23T15:17:02.0557552+00:00",
"date_end_support": "2026-09-23T15:17:02.0557552+00:00",
"sales_organization_id": "c5695173-8c89-449e-99b5-1b96d197151e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+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-09-23T15:17:02.0557552+00:00"
},
"project_status_id": "9ae79e59-6d01-4847-907b-f8756d8f5d52",
"project_status_code": "sample string 10",
"project_status": {
"id": "d123eda3-ef02-478f-934a-0f6832b32afd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b68a6f3f-967d-4257-812f-8785adec4eb4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00"
},
"company_id": "e4ceae4f-0014-400a-a9f2-6c9e72cc57dc",
"company_code": "sample string 12",
"db_address_id": "0d3c9826-f950-4e5a-809d-d96f01d25f0f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "584a7b5b-3a0c-4fac-b872-8ce024df5721",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "94b21ee1-62ed-46ef-811c-5602741689ba",
"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-09-23T15:17:02.0557552+00:00",
"date_create": "2026-09-23T15:17:02.0557552+00:00",
"date_update": "2026-09-23T15:17:02.0557552+00:00",
"updated_by_user_id": "a2b1f987-f50a-4296-a9e7-98398fcdffa4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T15:17:02.0557552+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-09-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T15:17:02.0557552+00:00",
"date_last_job": "2026-09-23T15:17:02.0557552+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T15:17:02.0557552+00:00",
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00",
"is_mobile_installation": true
},
"job_type_id": "4c1b6b2b-3f44-4141-8b2a-b0f215bf5cb6",
"job_type_code": "sample string 7",
"job_type": {
"id": "cb8bf367-70ee-4d9b-8bf8-eca6bba928d8",
"name": "sample string 2",
"sales_organization_id": "809985ac-324d-4ae6-9d0f-bf1d1753b050",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00",
"code": "sample string 7"
},
"job_priority_id": "fc6127de-dc41-46f4-9f92-5cc82b78d5ec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7e9d5e0a-638a-44b9-8282-52d76db21e38",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "69b1cf6d-d499-47ad-ad22-553b95f3a2a4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00"
},
"job_status_id": "18d87533-bfd7-488e-9dba-a6a2f8e28c37",
"job_status_code": "sample string 11",
"db_address_id": "9b33ffdf-b981-4563-80e6-5df342150f5a",
"contact_id": "47a292f9-3152-4126-8cff-83271161a747",
"requested_by_company_id": "b961d1ae-f1d8-434c-96ec-d51348795034",
"requested_by_contact_id": "83e7a015-768d-4294-a9f6-415c6279d13e",
"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-09-23T15:17:02.0557552+00:00",
"due_date": "2026-09-23T15:17:02.0557552+00:00",
"date_create": "2026-09-23T15:17:02.0557552+00:00",
"date_update": "2026-09-23T15:17:02.0557552+00:00",
"date_closed": "2026-09-23T15:17:02.0557552+00:00",
"suggested_user_id": "5d366563-cb5a-4fa1-8fe6-0425c4bd4649",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "50225d1f-918c-4f0a-bef2-8bee07279629",
"db_language_id": "a1df0e22-175e-4393-8b3e-eaf7f55f72a5",
"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-09-23T15:17:02.0557552+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "42622899-6119-435d-92a7-d918405795e3",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "047881b5-6dc6-4155-8393-d5eec85f6b34",
"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": "7d945349-7798-4ded-8b81-e0cdb06f7701",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "af9e977e-d56d-4bed-9563-37df5cbd7f9c"
},
"suggested_date_start": "2026-09-23T15:17:02.0557552+00:00",
"skill_id": "bb0e922d-461c-4f11-a24b-02635d12cce9",
"skill_code": "sample string 32",
"skill": {
"id": "b27d3ad5-8a88-4a90-90a9-eb3455494316",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "228d7e77-250d-42d5-9f4d-1bf44f8e1fdd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6b2761c6-7b7c-4602-8497-40984105971c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89396ad2-b2a0-4c10-adaa-5ee55d7920b9",
"db_currency_id": "4e2eeb68-f25c-46c3-9cca-98314af16438",
"db_language_id": "d451dd45-fade-4a16-934a-f7b478c21ffd",
"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-09-23T15:17:02.0557552+00:00"
},
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a04524e0-80a5-4752-8a72-2d9b8eaf74dc",
"date_reported_by_company": "2026-09-23T15:17:02.0557552+00:00",
"id2": 36,
"company_id": "140c9cd1-c07b-4d17-ada7-8ef9ff515da1",
"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": "dd121656-63ff-4dd5-9572-49cba93e4172",
"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-09-23T15:17:02.0557552+00:00"
},
"work_instruction_details_id": "5df24b98-d4b4-4e6c-a2a4-75a04af35613",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d61256e1-bab9-4a77-b5ee-bd47b3690881",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "83b1fc8c-aa8e-4f10-96f1-b3a8780fbc66",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T15:17:02.0557552+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": "5dfe757f-52f3-44fa-83d8-3b9309366b8d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T15:17:02.0557552+00:00"
}