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
{
"id": "f962f430-50b2-45c2-847a-e69d90477c58",
"jobs_id": "a24a1f71-4e9c-4ff6-a408-1eef68b4b814",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0bc0f206-b54d-4ab2-9b90-4acb2241f7ce",
"_parent_id": "0b5d7eaf-a286-4e9e-b11d-02aeb4d7a61a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "133eb682-f71c-467b-a50f-9772384cf35e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "23e5026f-0fae-411f-89f8-7679d3399932",
"_parent_id": "f744c7ca-0e8e-462e-a509-9a08a595e580",
"root_parent_id": "0f64b7e2-761b-476d-8c9b-9e18ddf794a3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9a2deccb-be45-45ed-a0f4-9e14062ba4b7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ae0f02eb-58d5-46b1-8a29-283ada539c66",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "57800519-a154-4fbf-9bae-1f3600eb55d5",
"_parent_code": "sample string 6",
"sales_organization_id": "dcc735e6-69e8-415e-abb2-99ad3f3c0f60",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+00:00"
},
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00"
},
"equipment_model_id": "dd573b64-691f-4cc1-aa91-5d185ba2acf5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7d63a6cf-99ad-4859-a1ee-777f15f2d6c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "beae62ee-d7e5-439b-8218-b60284c0814a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "402408a6-dd97-4fdb-976b-bb8771af4f96",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e3605617-3ac4-43e8-b64c-0a5190183716",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+00:00"
},
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00"
},
"equipment_family_id": "f8da9a46-46be-4412-b4f1-c547c0e3812a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ae0f02eb-58d5-46b1-8a29-283ada539c66",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "57800519-a154-4fbf-9bae-1f3600eb55d5",
"_parent_code": "sample string 6",
"sales_organization_id": "dcc735e6-69e8-415e-abb2-99ad3f3c0f60",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+00:00"
},
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00"
},
"date_in_production_since": "2026-11-18T11:54:34.5316202+00:00",
"date_out_of_production_since": "2026-11-18T11:54:34.5316202+00:00",
"date_end_support": "2026-11-18T11:54:34.5316202+00:00",
"sales_organization_id": "55bdb92b-8dbf-4894-b95b-e4388bdf372f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+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-11-18T11:54:34.5316202+00:00"
},
"project_status_id": "36c03127-7f15-44ca-864e-6a3b3dc74e40",
"project_status_code": "sample string 10",
"project_status": {
"id": "70289f9a-bf58-44df-b429-9207a1435211",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "738dbff5-600e-41b1-8c07-61a888cb5827",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00"
},
"company_id": "26213298-32ee-44bc-811c-af16c4bd50b9",
"company_code": "sample string 12",
"db_address_id": "aee9e1f5-f603-4ae7-a3fb-a9917cb6be5b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9863f782-85bf-4df3-a259-7c1c8cff9a69",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c6886cf0-6c3a-457f-a28c-8c8599d7a23e",
"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-11-18T11:54:34.5316202+00:00",
"date_create": "2026-11-18T11:54:34.5316202+00:00",
"date_update": "2026-11-18T11:54:34.5316202+00:00",
"updated_by_user_id": "9381c410-98e0-4cf7-a8cc-1cf74dc7d87c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-18T11:54:34.5316202+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-11-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-18T11:54:34.5316202+00:00",
"date_last_job": "2026-11-18T11:54:34.5316202+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-18T11:54:34.5316202+00:00",
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00",
"is_mobile_installation": true
},
"job_type_id": "74eb6231-ff9c-4e2f-9e6f-29f418f4cf59",
"job_type_code": "sample string 7",
"job_type": {
"id": "89cb4386-ad1d-4906-a5b3-6b34b200d13a",
"name": "sample string 2",
"sales_organization_id": "6617e16b-4f11-4763-9393-067d14c2054e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00",
"code": "sample string 7"
},
"job_priority_id": "de7cbcc7-ab97-4fa8-b9b7-f29f3b61840c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f20a0fd0-61ff-43c8-92a8-8cc0af805938",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e83d6450-ba9a-4c94-8324-05fdcbb79816",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00"
},
"job_status_id": "bc095268-544c-45b4-9a22-04b2c7e325fa",
"job_status_code": "sample string 11",
"db_address_id": "9e5e36f4-6334-41d6-90dd-4814d7e49319",
"contact_id": "6476c66d-5860-41fb-9e33-0d98360593ae",
"requested_by_company_id": "2e30e53f-3bd1-493c-9766-7dee5b8842ff",
"requested_by_contact_id": "8a3ec525-fc54-48c3-bc15-66f7e653e864",
"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-11-18T11:54:34.5316202+00:00",
"due_date": "2026-11-18T11:54:34.5316202+00:00",
"date_create": "2026-11-18T11:54:34.5316202+00:00",
"date_update": "2026-11-18T11:54:34.5316202+00:00",
"date_closed": "2026-11-18T11:54:34.5316202+00:00",
"suggested_user_id": "c78d0162-4535-4feb-896a-54be8ec314dd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b4db4ee2-d80e-4f11-9bdb-2e1110fc0f44",
"db_language_id": "ae78fe0a-c4cd-401a-8684-ae20d16efded",
"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-11-18T11:54:34.5316202+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fbf54f1a-cba3-47fe-9fd3-bc72c9eb266c",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "83b41373-5de7-4177-b719-e6d3b26377e4",
"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": "50d4b241-faf3-4545-ae49-eb59a01db63a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "89a87003-49e4-43f9-8f07-1f187ea891a1"
},
"suggested_date_start": "2026-11-18T11:54:34.5316202+00:00",
"skill_id": "41ee84d2-42ac-4bf4-aaf2-04f59fd2d145",
"skill_code": "sample string 32",
"skill": {
"id": "7825d310-994a-4c5d-b60e-9bc01f32ec57",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4725bced-eb47-45fb-a2eb-4068799218d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8b9fb652-5fba-4975-bdff-62cee73333cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ff841d6-f12a-4916-8536-86233965953a",
"db_currency_id": "b039a49a-b80c-436a-9538-23fe3a358e85",
"db_language_id": "82598e71-5ae7-4ae2-a7c9-e3c4efc11a04",
"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-11-18T11:54:34.5316202+00:00"
},
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b5853b4e-de67-44ba-adf2-693fff0853fb",
"date_reported_by_company": "2026-11-18T11:54:34.5316202+00:00",
"id2": 36,
"company_id": "6f309645-8e7e-476b-8655-e9115f8ad1fc",
"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": "06b7acbc-63c8-449f-9b68-bbb9fa480555",
"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-11-18T11:54:34.5316202+00:00"
},
"work_instruction_details_id": "31d33818-6428-4932-9db4-27dd09e296c7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8a7e788b-af5e-490b-8d50-bcbf26d71c4c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "638ace12-6c19-4daa-be9e-b4121bee58b4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-18T11:54:34.5316202+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": "7fdc22c6-1315-4154-983f-c1ee833f950a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-18T11:54:34.5316202+00:00"
}