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": "2f52f7d6-336c-4d4c-b37e-ed2b24094b41",
"jobs_id": "b8e0f84e-daf3-4e9e-adbf-f44282c2d889",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cb685001-35c8-4f7b-9c3e-deb88566641c",
"_parent_id": "b86fe2f5-0d0f-4b1e-b44f-4586d6ace05e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "49028a37-7d99-4390-ae07-47eb6fcec55d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0fe5ff71-7a7f-4fd3-b38b-2f959f42d3cd",
"_parent_id": "53db691f-bdb8-46cc-a858-133c5cf9e250",
"root_parent_id": "ff734b64-7d17-46e3-be8d-87c7c11e6587",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "430e4df1-0ace-4cd5-8ce7-04c8bd5341c1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "830e64bd-2db0-4e23-ba57-cc7fe4a9bafc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "252e39c7-e741-4414-87c8-87952c0bd06d",
"_parent_code": "sample string 6",
"sales_organization_id": "f636e396-2bea-47d1-a211-135d768f5b86",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+00:00"
},
"modified_dateutc": "2026-06-05T09:49:59.1278432+00:00"
},
"equipment_model_id": "8f16c148-a0c5-4824-b531-84889ab85595",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ab5a50c2-df1b-4df3-b800-23b058072588",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "17fdb547-bdd0-4296-a25f-e39c03462e68",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ba0883e8-e465-4b7b-b8a7-d12a50373e54",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "827af468-45b6-4836-b845-db8bbbd23a19",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+00:00"
},
"modified_dateutc": "2026-06-05T09:49:59.1278432+00:00"
},
"equipment_family_id": "ff470291-a14d-415d-bf39-31fad5737c9e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "830e64bd-2db0-4e23-ba57-cc7fe4a9bafc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "252e39c7-e741-4414-87c8-87952c0bd06d",
"_parent_code": "sample string 6",
"sales_organization_id": "f636e396-2bea-47d1-a211-135d768f5b86",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+00:00"
},
"modified_dateutc": "2026-06-05T09:49:59.1278432+00:00"
},
"date_in_production_since": "2026-06-05T09:49:59.1278432+00:00",
"date_out_of_production_since": "2026-06-05T09:49:59.1278432+00:00",
"date_end_support": "2026-06-05T09:49:59.1278432+00:00",
"sales_organization_id": "37d2666d-57c4-45ef-b1ed-8817df065d82",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+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-06-05T09:49:59.1278432+00:00"
},
"project_status_id": "12cc5244-c33d-40ce-9b12-73282b98a24b",
"project_status_code": "sample string 10",
"project_status": {
"id": "21b77569-5d46-4451-b664-0f2cc8c3b46a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3c3ad99d-0ed9-4347-b5d2-05681e01a1a4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T09:49:59.1278432+00:00"
},
"company_id": "afcb1b97-c5e7-4198-9992-f2b35987c0b0",
"company_code": "sample string 12",
"db_address_id": "1d52c0c4-069d-47e7-ba55-c763045325da",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "36be9db1-6640-407f-9497-06d8ad59091d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "85c59725-e9ab-46aa-bce3-81c3f9e92eb0",
"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-06-05T09:49:59.1278432+00:00",
"date_create": "2026-06-05T09:49:59.1278432+00:00",
"date_update": "2026-06-05T09:49:59.1278432+00:00",
"updated_by_user_id": "5f57d93d-2f9c-46f9-9314-ae99b39c9373",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-05T09:49:59.1278432+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-06-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-05T09:49:59.1278432+00:00",
"date_last_job": "2026-06-05T09:49:59.1278432+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-05T09:49:59.1278432+00:00",
"modified_dateutc": "2026-06-05T09:49:59.1278432+00:00",
"is_mobile_installation": true
},
"job_type_id": "f26ebf87-6205-4526-8795-c98fc26a6c25",
"job_type_code": "sample string 7",
"job_type": {
"id": "d26ffd34-9c1a-4423-b2c9-86820a571110",
"name": "sample string 2",
"sales_organization_id": "eaf09272-9a57-48bd-9d88-2193058c9192",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-05T09:49:59.1278432+00:00",
"code": "sample string 7"
},
"job_priority_id": "48a65a42-f47c-4977-9757-3f9212734e27",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cd767823-c4e3-4f90-9b19-41ff6910abb0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cd685f20-affe-49db-8a3d-6b295de187a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T09:49:59.1278432+00:00"
},
"job_status_id": "08f0b8a8-b310-4550-b15b-1ea935f2a88c",
"job_status_code": "sample string 11",
"db_address_id": "8ceb99af-0a4f-4a69-8296-1e06f836bd0d",
"contact_id": "750a8c4a-d4c6-45c8-a871-5c912d09267c",
"requested_by_company_id": "5934db4d-d42f-4e1c-b6a9-e1289df6d667",
"requested_by_contact_id": "cec02586-9580-4343-ae78-87688aa9258d",
"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-06-05T09:49:59.143463+00:00",
"due_date": "2026-06-05T09:49:59.143463+00:00",
"date_create": "2026-06-05T09:49:59.143463+00:00",
"date_update": "2026-06-05T09:49:59.143463+00:00",
"date_closed": "2026-06-05T09:49:59.143463+00:00",
"suggested_user_id": "6d9dc8aa-744f-4e9c-b42c-4510894dfdcc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "88b09507-4f06-462d-b69c-176b20dcdab7",
"db_language_id": "ab0a0ea4-83f6-4046-8b76-06d39634c6aa",
"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-06-05T09:49:59.143463+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "30540fe9-e6d2-4917-bccd-1a9ab11d9208",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "17864670-ec4f-4706-8c92-b7ddbced8907",
"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": "eec8857e-67e8-4770-a528-50e03d522cd6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-05T09:49:59.143463+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cae8301b-1f83-425d-88a0-c84ab460c2f8"
},
"suggested_date_start": "2026-06-05T09:49:59.143463+00:00",
"skill_id": "9550953c-e564-4e7c-9a4d-56d3800c9df2",
"skill_code": "sample string 32",
"skill": {
"id": "32cef765-ef42-4a99-93a0-9080f9a0c913",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "36909a36-4e51-43fa-a5e4-35e41f2f4a23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d5e32995-88e0-4775-b5ad-8b0c8b7e8e04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c732ae5-e603-4eaa-aba2-b3eba3b5a01d",
"db_currency_id": "79e4eb17-7b56-48ee-aea4-d63f8e85d697",
"db_language_id": "cb617f52-e896-400e-89e0-76d4967cb21c",
"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-06-05T09:49:59.1278432+00:00"
},
"modified_dateutc": "2026-06-05T09:49:59.143463+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a4edba17-b8a8-4041-b732-e7d065ac0141",
"date_reported_by_company": "2026-06-05T09:49:59.143463+00:00",
"id2": 36,
"company_id": "2a658733-c331-4c91-9fea-f990edde6a6e",
"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": "57d7c0d5-94d5-4295-9e60-af0183644248",
"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-06-05T09:49:59.143463+00:00"
},
"work_instruction_details_id": "f309acb2-9203-439f-92d0-b10d29dbd6e9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8dbbbf81-b964-4883-9c46-710af7c6c316",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7c739725-dfd7-4f93-acec-7932ca810790",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-05T09:49:59.143463+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": "545d2933-c6a0-450a-b299-86946dcf4393",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-05T09:49:59.143463+00:00"
}