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": "a57537b6-43ff-438e-8caa-47fafb0f4f43",
"jobs_id": "541dfcb9-63c3-41ee-b226-04141a360adb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "34621584-99ce-4aa7-8fe3-59e23743c720",
"_parent_id": "40abbd33-58d5-49a0-820c-7d6cd0859ce2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "68ccd405-1beb-467b-839a-be063290f0bd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9ea8e3f9-50e4-41e7-acec-250be32ccfd8",
"_parent_id": "43a3cf15-d1b4-4284-af56-e9478b522fdf",
"root_parent_id": "fd928855-e8ee-4bb4-8edd-0ee3b079b5ee",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dd6b74d6-7449-43a2-86ba-fa181d3514b5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "893014ef-8f5e-45a7-b6fa-e9a34536f3f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c3e4613-0dc3-4bf5-bc9e-df605d66b7c3",
"_parent_code": "sample string 6",
"sales_organization_id": "ae798646-cfcd-4237-9461-c963dca078ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+00:00"
},
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00"
},
"equipment_model_id": "a51a9fff-f767-4717-befd-e9fd7e6c913b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c74b331c-f453-483e-a481-448eb10770bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bb1bf0dd-c7cd-46a1-acd4-b5f1a5cdff32",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a4065cb7-6d5c-4642-9a7f-a2276d1d97f1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f3c58261-1469-43a9-98fd-226d94aae8a2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+00:00"
},
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00"
},
"equipment_family_id": "da9bddf5-d413-4d6d-942c-2d5f3ab219aa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "893014ef-8f5e-45a7-b6fa-e9a34536f3f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c3e4613-0dc3-4bf5-bc9e-df605d66b7c3",
"_parent_code": "sample string 6",
"sales_organization_id": "ae798646-cfcd-4237-9461-c963dca078ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+00:00"
},
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00"
},
"date_in_production_since": "2026-08-06T19:59:57.6461816+00:00",
"date_out_of_production_since": "2026-08-06T19:59:57.6461816+00:00",
"date_end_support": "2026-08-06T19:59:57.6461816+00:00",
"sales_organization_id": "a30c22ec-1b19-4b81-a9ab-0f9173f79c17",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+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-08-06T19:59:57.6461816+00:00"
},
"project_status_id": "98bdb990-c7d7-4934-b19b-4a3ecd08e809",
"project_status_code": "sample string 10",
"project_status": {
"id": "49780fdd-55e1-4217-a353-6bcf8f49b66d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "093a83e2-4151-4490-bb9a-7a2792e00ef9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00"
},
"company_id": "0d30e643-4650-4719-ac14-452f6de49574",
"company_code": "sample string 12",
"db_address_id": "8cb32f3d-9f58-4b8e-8319-0accc80bc6e5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ad1c8d7f-ca71-4b7b-aaeb-3fd8ffea9a68",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c4307496-3af8-4b0d-93ff-4c02a8a74b77",
"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-08-06T19:59:57.6461816+00:00",
"date_create": "2026-08-06T19:59:57.6461816+00:00",
"date_update": "2026-08-06T19:59:57.6461816+00:00",
"updated_by_user_id": "17ee5061-026b-49bc-9926-ee75f5ed782f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-06T19:59:57.6461816+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-08-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-06T19:59:57.6461816+00:00",
"date_last_job": "2026-08-06T19:59:57.6461816+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-06T19:59:57.6461816+00:00",
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00",
"is_mobile_installation": true
},
"job_type_id": "243996db-8c29-41b2-8d09-bd01b631f19b",
"job_type_code": "sample string 7",
"job_type": {
"id": "61754c30-32f9-4f71-984f-1f96273e375e",
"name": "sample string 2",
"sales_organization_id": "61b08507-b847-4075-bbf5-b62759bf8180",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00",
"code": "sample string 7"
},
"job_priority_id": "a8c12bfc-43c5-4d63-be82-bc46eb8dd3e2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e3e2d5e7-2ef3-4148-9e7e-6dd9ff5ffce4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "058d01cc-6a6f-473f-bf69-b2a2ce940266",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00"
},
"job_status_id": "9d9ac09d-154f-48e4-8470-611487845713",
"job_status_code": "sample string 11",
"db_address_id": "f8d49e2e-0d1e-47fc-8e5a-8addc9011463",
"contact_id": "7bba7548-e9b2-4567-b049-21dd57c9c220",
"requested_by_company_id": "bb169489-a1b3-44cb-8e4e-095598ac8a68",
"requested_by_contact_id": "5eb981b6-8701-46d5-bf06-3d5198f437b7",
"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-08-06T19:59:57.6461816+00:00",
"due_date": "2026-08-06T19:59:57.6461816+00:00",
"date_create": "2026-08-06T19:59:57.6461816+00:00",
"date_update": "2026-08-06T19:59:57.6461816+00:00",
"date_closed": "2026-08-06T19:59:57.6461816+00:00",
"suggested_user_id": "029ab2ab-b7f5-4d8d-bfcd-c5566867edb0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7061586a-6991-4e89-b4ce-afcdc4e2b803",
"db_language_id": "0ae422ad-d5c4-48af-878b-192956014e8a",
"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-08-06T19:59:57.6461816+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "19e8f4d1-0140-458d-97f4-273841e9b409",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "64c1b8a0-6f05-470e-baf7-e4fcd773cddc",
"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": "66ce0b59-4dfd-44c5-b3c8-5a8be00c4564",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e092b097-bea6-4788-b221-d747ea591f36"
},
"suggested_date_start": "2026-08-06T19:59:57.6461816+00:00",
"skill_id": "db6a0030-2937-45c0-ae35-4dfd2fa281cc",
"skill_code": "sample string 32",
"skill": {
"id": "5e9f475c-2c4d-4e96-abaa-68f1ab0037fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a46f2937-37d2-4318-a63a-b2671d824d5c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b92f263b-6a93-4219-b39a-626f5ca001cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c5d801-9ebf-48c0-bc40-a9dc4a36dcd9",
"db_currency_id": "ff0d3e3a-de74-4cb4-a97f-76ca3e46a43a",
"db_language_id": "f976bafe-2a59-4658-a5c0-77c1ad071cdf",
"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-08-06T19:59:57.6461816+00:00"
},
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f73b76a2-d44d-4167-acd9-f8b86034298d",
"date_reported_by_company": "2026-08-06T19:59:57.6461816+00:00",
"id2": 36,
"company_id": "eb44f61f-c2a4-405c-93e9-9eec30277869",
"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": "f5b7457b-cb34-47d2-9261-f80ba2362525",
"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-08-06T19:59:57.6461816+00:00"
},
"work_instruction_details_id": "e66c731e-977e-4ebd-bdd7-32f1073269fd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d7019348-ff32-4ebc-8434-8843b0d14aee",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "94bb1c5d-039d-4108-a02f-baffa9adcbf1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-06T19:59:57.6461816+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": "9d82c37d-e7e6-4a1c-a40a-e122645be440",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-06T19:59:57.6461816+00:00"
}