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": "d69702b8-1ab5-4f63-925c-ed02fd2587ff",
"jobs_id": "4d56306e-d1da-47c8-8e10-232e873c2608",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "afe884a7-56ce-4607-845f-eec131efc89d",
"_parent_id": "a2151c79-843d-40f9-aa93-5efeec5f4e93",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "234dd628-58ba-44c8-80b3-825835e81e5f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "090d9485-39da-4b0b-8d2d-59e120866133",
"_parent_id": "4b6a9c58-c798-4070-b2a5-7936536af039",
"root_parent_id": "ca93b59a-bfcc-465a-84f8-fa86ac2ed1ad",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4e21649b-f20c-40d3-b050-a704ba966118",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bcdf104f-f610-443e-8779-f939f88444cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f9a34cc-28bb-4589-8886-c6865b3e3902",
"_parent_code": "sample string 6",
"sales_organization_id": "4310ac68-270e-497b-afe4-729812c545d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+00:00"
},
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00"
},
"equipment_model_id": "b5cf5fb7-655a-4ffa-a490-d3bd4480f236",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "70c69c8e-bb7b-4bc7-8ba3-adeb0d2ad7e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "948b558b-231d-4780-b1f4-67e482e27d0c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "79bf381f-2017-462b-bd99-385df777a90b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6ac71e3c-f45c-4098-a32f-35762e5115ed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+00:00"
},
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00"
},
"equipment_family_id": "0aa33e77-7e6d-4c4f-b81f-86d8df2bbb40",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bcdf104f-f610-443e-8779-f939f88444cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f9a34cc-28bb-4589-8886-c6865b3e3902",
"_parent_code": "sample string 6",
"sales_organization_id": "4310ac68-270e-497b-afe4-729812c545d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+00:00"
},
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00"
},
"date_in_production_since": "2026-11-06T08:52:14.1799541+00:00",
"date_out_of_production_since": "2026-11-06T08:52:14.1799541+00:00",
"date_end_support": "2026-11-06T08:52:14.1799541+00:00",
"sales_organization_id": "3d98f532-3fd4-4cf5-ba40-b7c711024c1d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+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-06T08:52:14.1799541+00:00"
},
"project_status_id": "edbd1924-c75d-4e74-be3e-d377f5ef70b8",
"project_status_code": "sample string 10",
"project_status": {
"id": "48580b36-9f47-41de-8052-e8e02c734cf6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c5e09dc3-7551-4875-bf9a-23b24d5ad6b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00"
},
"company_id": "d32cd045-7d64-4a97-9c8b-8a91dfec14ec",
"company_code": "sample string 12",
"db_address_id": "85d63cf4-1747-4e9a-a53d-a511e45eba38",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5918d690-36d3-4d5b-b1a7-4c541fa283cb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e2781111-d0ab-4230-a039-e373a03154d3",
"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-06T08:52:14.1799541+00:00",
"date_create": "2026-11-06T08:52:14.1799541+00:00",
"date_update": "2026-11-06T08:52:14.1799541+00:00",
"updated_by_user_id": "2d7eb97a-11fc-4e40-8d23-cce38935d42c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-06T08:52:14.1799541+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-06T08:52:14.1799541+00:00",
"date_last_job": "2026-11-06T08:52:14.1799541+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-06T08:52:14.1799541+00:00",
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00",
"is_mobile_installation": true
},
"job_type_id": "0942aca1-05cb-41e9-b0b6-54d2ad8c7377",
"job_type_code": "sample string 7",
"job_type": {
"id": "5824842e-d730-4827-b1df-b59b1d992bb8",
"name": "sample string 2",
"sales_organization_id": "bd83362f-1f91-4aa6-9b01-748091cfdd0e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00",
"code": "sample string 7"
},
"job_priority_id": "5a0075e9-5c67-4565-bfd6-274e22ebbba3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d67d7d37-2d43-4650-b266-425503cd5744",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7a17d867-d17d-440c-878f-5fa25f0677de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00"
},
"job_status_id": "2d724fdc-00f4-4af5-bd49-1e9ec2773e6d",
"job_status_code": "sample string 11",
"db_address_id": "2fb62c41-b768-4666-b6ba-fa6a7c7fbd2c",
"contact_id": "eee172b3-c2e2-4dd3-bc64-05c96804a037",
"requested_by_company_id": "40add420-2390-4b4f-88b9-b98f000fc7b7",
"requested_by_contact_id": "40466ccb-94f0-4df4-b31a-0fd733108576",
"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-06T08:52:14.1799541+00:00",
"due_date": "2026-11-06T08:52:14.1799541+00:00",
"date_create": "2026-11-06T08:52:14.1799541+00:00",
"date_update": "2026-11-06T08:52:14.1799541+00:00",
"date_closed": "2026-11-06T08:52:14.1799541+00:00",
"suggested_user_id": "9a9cc9a0-c0fe-463d-bb61-db70c0fcdcb4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4212e70d-656e-4efb-934a-6594fa81881f",
"db_language_id": "94633cba-a175-43cb-a43f-e03a59b0849d",
"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-06T08:52:14.1799541+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "27771973-5683-4029-ae9b-1639fccaeb96",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "99cba130-540e-4da3-96d3-aef24f8056b9",
"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": "19d22579-3102-4dab-a1ed-60102351cc5d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "69c16331-b3fd-4f4f-9413-299d5839b758"
},
"suggested_date_start": "2026-11-06T08:52:14.1799541+00:00",
"skill_id": "5704ec7b-8ba9-4930-9def-b754eb34e53d",
"skill_code": "sample string 32",
"skill": {
"id": "a988f27d-bf2a-4830-a7b5-fae1b157f7bb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d249997e-5e46-4c0a-9e9d-107de297439f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0cbf0122-9dd4-49b2-b1f8-742c3965f643",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7458578a-e853-4e00-a7b4-889a679b0918",
"db_currency_id": "c8ecffd4-6d11-47c9-90c0-9379bf02061e",
"db_language_id": "fa90a967-87a3-43ad-bc0e-21f0f0000735",
"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-06T08:52:14.1799541+00:00"
},
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6364a4fa-ca2b-4afc-b5d4-e29cb2f8ece1",
"date_reported_by_company": "2026-11-06T08:52:14.1799541+00:00",
"id2": 36,
"company_id": "f7e59841-c9ca-458e-a3ae-737b18f6add6",
"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": "19fb6adc-23a2-4354-bbb3-474db5974142",
"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-06T08:52:14.1799541+00:00"
},
"work_instruction_details_id": "0525d50d-f3ce-4cd2-9b58-cc38a87356db",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "19960bdf-1160-44af-9426-b18b6f74a49b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "19bb337e-70f9-40b6-aa7d-4603c531fcfd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-06T08:52:14.1799541+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": "2a11f529-9b3e-4a21-9f13-e4e0fb00726c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-06T08:52:14.1799541+00:00"
}