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": "58c51d83-eee1-47b4-8147-a80cf9311f3d",
"jobs_id": "bcc3acdb-381f-4e03-8b20-9f3e545b2d2b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "90ceb8ce-d0d5-4734-ae66-95a0135a57ce",
"_parent_id": "3afa3f85-d4d3-467c-9abc-4944fd82a814",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f2b2d9b0-0853-4b31-9c45-a61aebe84026",
"project_reference_back_office": "sample string 5",
"project": {
"id": "94dd437c-5fa1-4a62-a913-80d88b7e41a1",
"_parent_id": "c43d575f-2995-4fbb-ae33-8cb91faad3ec",
"root_parent_id": "dd6c7d8d-34d8-4307-b3a1-593cac77335a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b90397f3-a1a2-45b6-a060-e818b945aa7c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "94aef268-4dff-4c6f-88fb-65ce034fb9bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7901a78c-20ab-45e2-96f1-fb06b1beb9b0",
"_parent_code": "sample string 6",
"sales_organization_id": "0ed7750a-9061-4588-87c9-6bd74ce31cc1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+00:00"
},
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00"
},
"equipment_model_id": "10f14c26-1ce8-4aee-b4fc-a4e4f380129d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8afd4e2b-f63e-4902-910a-1cb4cf95079b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a3aedaa2-982a-474f-a17a-ae8a556f50f7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f6cce9a9-5fad-49d4-a5a1-50ddd4c1057f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "af2ec004-ad80-43ff-9170-2a6aa2bfe303",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+00:00"
},
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00"
},
"equipment_family_id": "25157e0d-6f25-499d-9225-953ca74f4a85",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "94aef268-4dff-4c6f-88fb-65ce034fb9bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7901a78c-20ab-45e2-96f1-fb06b1beb9b0",
"_parent_code": "sample string 6",
"sales_organization_id": "0ed7750a-9061-4588-87c9-6bd74ce31cc1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+00:00"
},
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00"
},
"date_in_production_since": "2026-07-31T06:44:49.5928638+00:00",
"date_out_of_production_since": "2026-07-31T06:44:49.5928638+00:00",
"date_end_support": "2026-07-31T06:44:49.5928638+00:00",
"sales_organization_id": "7339b442-4dec-4fe9-935f-1e4989814898",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+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-07-31T06:44:49.5928638+00:00"
},
"project_status_id": "8964f1ed-bb12-4580-8b1b-15e4143b1569",
"project_status_code": "sample string 10",
"project_status": {
"id": "c5bf4a21-e9db-43a4-8d6e-ec3f1b9241a9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1b15ad58-7c73-44a9-8615-9673019ff532",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00"
},
"company_id": "039126dc-cd1f-4b12-965d-2ec5f21f572d",
"company_code": "sample string 12",
"db_address_id": "5d028c49-2a74-4f49-8511-e1e740fe530a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "568576d8-255f-42b3-a714-187f67f1691b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "43b6c223-bdab-44fc-9555-adb093360470",
"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-07-31T06:44:49.5928638+00:00",
"date_create": "2026-07-31T06:44:49.5928638+00:00",
"date_update": "2026-07-31T06:44:49.5928638+00:00",
"updated_by_user_id": "8e71ad83-ec6c-4afb-8ba9-bdcfd728c0e2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-31T06:44:49.5928638+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-07-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-31T06:44:49.5928638+00:00",
"date_last_job": "2026-07-31T06:44:49.5928638+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-31T06:44:49.5928638+00:00",
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00",
"is_mobile_installation": true
},
"job_type_id": "37ca5f28-cbb9-47aa-903d-e024f646828f",
"job_type_code": "sample string 7",
"job_type": {
"id": "9236c6bd-eb0b-4185-ad8d-87de9aaf8359",
"name": "sample string 2",
"sales_organization_id": "09066d34-de74-416e-bee5-e509e5d6d155",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00",
"code": "sample string 7"
},
"job_priority_id": "9b754417-74f3-4968-b202-1c8dc29fc1f1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "447b3235-d9aa-49b2-bef2-dc0e497a0268",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0f537b54-bc70-494b-a8d8-244d9019c750",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00"
},
"job_status_id": "598e2453-993b-48b3-b55b-2e5cc7e7e27c",
"job_status_code": "sample string 11",
"db_address_id": "d958cc36-7964-4901-87eb-d79c4382f4c8",
"contact_id": "bf54b200-5bd2-4d7f-b34f-5a09b1a0f90b",
"requested_by_company_id": "8e09004c-fa44-4a02-a060-4e6f663ccf8d",
"requested_by_contact_id": "95172759-fde2-476c-8f72-7cc7fb0fcf90",
"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-07-31T06:44:49.5928638+00:00",
"due_date": "2026-07-31T06:44:49.5928638+00:00",
"date_create": "2026-07-31T06:44:49.5928638+00:00",
"date_update": "2026-07-31T06:44:49.5928638+00:00",
"date_closed": "2026-07-31T06:44:49.5928638+00:00",
"suggested_user_id": "3ca49e79-a1ba-4e53-a6be-3eded360dcb0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d2252687-19a5-46a1-953d-b02773bfd189",
"db_language_id": "8cf05b32-110c-444a-9b98-3fb63eb76613",
"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-07-31T06:44:49.5928638+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "864dc3bb-c1c6-47c5-b0dd-843a9cfeeec1",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a0063ba-4b32-4246-9428-ff8b13d893e6",
"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": "cdb39041-a49e-4be2-9bd9-9c70725066d2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "df9ea2ac-5808-43bb-a874-a86c8481eb33"
},
"suggested_date_start": "2026-07-31T06:44:49.5928638+00:00",
"skill_id": "c0617556-0943-44ff-85c1-f8158aa6d922",
"skill_code": "sample string 32",
"skill": {
"id": "8e329a7b-eb61-4498-91eb-1dc8288983e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c3b1884e-a75e-4520-9cbd-48a9fec5872a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e9c94afe-1bd8-493b-b7ea-dd166e76b2fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "454312eb-bd4c-4daf-b2f2-dd176855feae",
"db_currency_id": "dd81beab-b4b8-49b4-8e07-526bba63b19b",
"db_language_id": "96b8bc64-2267-4934-bf4f-3ec929fc174a",
"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-07-31T06:44:49.5928638+00:00"
},
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aa1d9fe1-6b22-4b60-a198-95059f2dfc4b",
"date_reported_by_company": "2026-07-31T06:44:49.5928638+00:00",
"id2": 36,
"company_id": "295dadce-ca13-4d1e-92fc-021efbccc8e5",
"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": "e9c820b7-2646-4ed7-9c85-ec6542cd30da",
"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-07-31T06:44:49.5928638+00:00"
},
"work_instruction_details_id": "ecb4cec8-74f0-4111-bfd4-ed035524ccdc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2749c78a-f221-48b7-802e-86fdd045a9d5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "077e3c4a-6d90-4c0b-ba22-9a4942c8265c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-31T06:44:49.5928638+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": "e12ff486-d5d4-4954-b65e-fb36445ee725",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-31T06:44:49.5928638+00:00"
}