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": "675fea6e-ec7e-43e7-bdaf-c91c81432114",
"jobs_id": "0688327b-a865-48ef-b6e8-0dbfa04e0f16",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bbff4e5e-462b-4341-8c1d-d7d9a27c7504",
"_parent_id": "442d8ef5-1562-4aec-b654-4935903d4963",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "73bf9f68-8404-4682-a050-90afa9836531",
"project_reference_back_office": "sample string 5",
"project": {
"id": "571cd58b-77fc-4996-a70b-6b969be20432",
"_parent_id": "859cd3d2-1c7b-4c36-a1b3-8490a1bbfd63",
"root_parent_id": "3876d15a-3f79-4b48-a771-a69d399dd784",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "22314f1c-814c-40a2-a345-39872a4f5764",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aef716ee-4b2d-434f-826d-37a838a183e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b45f906f-7d84-4f4e-8e41-3827aab4e7ed",
"_parent_code": "sample string 6",
"sales_organization_id": "0540ea57-362f-4a68-b0b5-60364555fbb8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+00:00"
},
"modified_dateutc": "2026-02-08T22:58:13.1463673+00:00"
},
"equipment_model_id": "eff8edef-7f56-4e55-bf0c-73d54cadab26",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "68dbaf86-8532-4d12-ae1c-772599452a5b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "768dd38d-c85f-4eae-9a3a-f35e70e03e6c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c6296e85-3cc9-4afd-ac0d-9cffcef29ef7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a189d76e-e8d2-4699-94fb-24fed1068b8a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+00:00"
},
"modified_dateutc": "2026-02-08T22:58:13.1463673+00:00"
},
"equipment_family_id": "5d3b1e08-57fb-452b-bf3f-761aa680e3cb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aef716ee-4b2d-434f-826d-37a838a183e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b45f906f-7d84-4f4e-8e41-3827aab4e7ed",
"_parent_code": "sample string 6",
"sales_organization_id": "0540ea57-362f-4a68-b0b5-60364555fbb8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+00:00"
},
"modified_dateutc": "2026-02-08T22:58:13.1463673+00:00"
},
"date_in_production_since": "2026-02-08T22:58:13.1463673+00:00",
"date_out_of_production_since": "2026-02-08T22:58:13.1463673+00:00",
"date_end_support": "2026-02-08T22:58:13.1463673+00:00",
"sales_organization_id": "f394161e-6b98-4def-bc80-8bd46acce816",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+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-02-08T22:58:13.1776111+00:00"
},
"project_status_id": "fe614378-daa8-40ca-b7c8-714e8734e5be",
"project_status_code": "sample string 10",
"project_status": {
"id": "46afc912-e7a0-4283-bcc2-ade3f60f6ca7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5d39365a-95d2-4bd3-8fba-0f6aad30c77d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T22:58:13.1776111+00:00"
},
"company_id": "62f90f86-d14d-42a5-9166-241ffac41d1e",
"company_code": "sample string 12",
"db_address_id": "62cbcfa1-07f2-4d65-a76e-ac1fcaf79690",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d71fda16-f327-4c36-9fa8-8af5b5d1b3d2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "878806d5-23c4-4b80-8d90-b43aa9b04fa7",
"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-02-08T22:58:13.1776111+00:00",
"date_create": "2026-02-08T22:58:13.1776111+00:00",
"date_update": "2026-02-08T22:58:13.1776111+00:00",
"updated_by_user_id": "75e51d2b-4fb2-4a94-a08c-393891671352",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-08T22:58:13.1776111+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-02-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-08T22:58:13.1776111+00:00",
"date_last_job": "2026-02-08T22:58:13.1776111+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-08T22:58:13.1776111+00:00",
"modified_dateutc": "2026-02-08T22:58:13.1776111+00:00",
"is_mobile_installation": true
},
"job_type_id": "bd7c5901-8885-4ab4-92fa-dba22909677f",
"job_type_code": "sample string 7",
"job_type": {
"id": "4135270c-d6a5-4bef-a38c-1c41c235ad59",
"name": "sample string 2",
"sales_organization_id": "0f1fc6d7-c0f0-41a5-a635-365c9fd3442d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-08T22:58:13.1776111+00:00",
"code": "sample string 7"
},
"job_priority_id": "977b170f-d3c5-4703-a143-d381f2e0dd73",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5d2c2ac0-cfa5-496b-9b2d-27450dab3fb0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c6125ba6-79b6-45f3-9c81-51a169fd1dba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T22:58:13.1776111+00:00"
},
"job_status_id": "66cefb3d-9dd6-4c41-b169-e03cec55a317",
"job_status_code": "sample string 11",
"db_address_id": "fa6ccebd-74f3-4c8b-883e-f1c584727b80",
"contact_id": "6ab9acc5-d404-4276-9a96-a03f7103f74b",
"requested_by_company_id": "a39a07a4-d882-4a30-90ea-c79a2af1e4a2",
"requested_by_contact_id": "4c997ccb-29c1-455c-824c-e08ddb72ce35",
"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-02-08T22:58:13.1776111+00:00",
"due_date": "2026-02-08T22:58:13.1776111+00:00",
"date_create": "2026-02-08T22:58:13.1776111+00:00",
"date_update": "2026-02-08T22:58:13.1776111+00:00",
"date_closed": "2026-02-08T22:58:13.1776111+00:00",
"suggested_user_id": "aec074fe-2a75-4541-b9b2-753d262772f6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "341f0715-8260-4d2f-831b-2ae02a22292a",
"db_language_id": "84e99adc-d9aa-41a1-9fbe-33e57f12a1f4",
"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-02-08T22:58:13.1776111+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "73190ef3-d95e-4add-add6-c2ada2c12276",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f7f728cb-2bd3-4e3d-9ccb-fe3a47419209",
"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": "bb2484c6-5fb4-4f25-bd7b-776b73a7dd32",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-08T22:58:13.1776111+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ae1f3571-f7d0-46c7-9374-7f8613669127"
},
"suggested_date_start": "2026-02-08T22:58:13.1776111+00:00",
"skill_id": "d5d89a6f-201e-4df2-af7d-39ed72ce0cfc",
"skill_code": "sample string 32",
"skill": {
"id": "5fb8a2e7-6298-4091-bb58-85d62704a8e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "948d2a00-939a-4622-b494-66fad2a4a1f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b8ec88cb-c8b3-41e1-8c65-b281bd6bd657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf0290f0-1d32-4af3-bf2f-0036f6c08f97",
"db_currency_id": "ff3b5486-0955-4930-981b-fe0c86617846",
"db_language_id": "8945afdb-4710-4b76-9230-e18795f2fe1e",
"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-02-08T22:58:13.1463673+00:00"
},
"modified_dateutc": "2026-02-08T22:58:13.1776111+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "292208e5-73f6-46c2-8ee4-cb24e2db7e33",
"date_reported_by_company": "2026-02-08T22:58:13.1776111+00:00",
"id2": 36,
"company_id": "f10738a2-2c75-4929-b366-57cb5a27d788",
"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": "849aef57-750d-4715-8b2f-18e577481061",
"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-02-08T22:58:13.1776111+00:00"
},
"work_instruction_details_id": "6dd4726f-29ca-4980-9fa5-ce7048011b81",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "53753abc-fc5a-4910-a89d-73b70056f902",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5608bbf4-cb5f-47cd-a630-887efe475421",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-08T22:58:13.1776111+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": "4a5f2861-e50a-4161-9df5-00ca0b760704",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-08T22:58:13.1776111+00:00"
}