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": "6f9ba792-f43a-42e0-b202-3cde24c31fc4",
"jobs_id": "ec3e1450-6669-43fd-9783-948e2fc54fa3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "16d38fd2-a231-420a-b14c-edeb0f86ea53",
"_parent_id": "be823b9d-1916-4793-8fe7-a34dd323538b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a65bd34d-6c75-4ed1-a6a2-d101d25590d2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0c50a5f2-c146-4970-894c-5856e6e5baf3",
"_parent_id": "08e515ef-5f6d-4008-806d-621d4b53d206",
"root_parent_id": "0d3292c5-4c3c-4962-b3ac-2b34f2f5c176",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a1359506-7978-40b1-82bd-fb9c09934515",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "90f240d3-77b0-41c0-8b56-9d2536c09b6d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9560d35e-201f-4110-bf77-95bd2f346317",
"_parent_code": "sample string 6",
"sales_organization_id": "cbe1d248-a0bd-467e-97ad-84f1ca62faba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+00:00"
},
"modified_dateutc": "2026-08-04T13:28:51.5740548+00:00"
},
"equipment_model_id": "61bc384c-7101-4a44-82d6-7882e63327c2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "110c9b20-dd1c-4371-b3b8-8913b16ce242",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f68fc63b-89fc-4964-8260-089b09e125a8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "989b24dd-ec10-4bad-919d-7c96b1aa22c9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "028dd501-feae-4887-b008-a512b290c609",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+00:00"
},
"modified_dateutc": "2026-08-04T13:28:51.5740548+00:00"
},
"equipment_family_id": "19e71e87-3676-48a0-882b-4b2b671ff468",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "90f240d3-77b0-41c0-8b56-9d2536c09b6d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9560d35e-201f-4110-bf77-95bd2f346317",
"_parent_code": "sample string 6",
"sales_organization_id": "cbe1d248-a0bd-467e-97ad-84f1ca62faba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+00:00"
},
"modified_dateutc": "2026-08-04T13:28:51.5740548+00:00"
},
"date_in_production_since": "2026-08-04T13:28:51.5740548+00:00",
"date_out_of_production_since": "2026-08-04T13:28:51.5740548+00:00",
"date_end_support": "2026-08-04T13:28:51.5740548+00:00",
"sales_organization_id": "40de7b8b-fe74-42a2-8eb9-3ef391ee1ef4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+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-04T13:28:51.5896686+00:00"
},
"project_status_id": "1184c4cb-ade5-415f-91a7-7da56002d5dd",
"project_status_code": "sample string 10",
"project_status": {
"id": "9d5e269d-2237-4cfb-a3b5-db10419f939c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0047d7b8-8246-48af-8ebe-45123b402a3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T13:28:51.5896686+00:00"
},
"company_id": "23e0983e-1501-4afe-b07e-4da546b5f72d",
"company_code": "sample string 12",
"db_address_id": "c908fd97-c952-4329-9c33-6b9baaf38b50",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cad8c8c1-7334-47f7-88d6-b2bcd60ccd05",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f716d04f-6ad3-4cd6-b534-23d9d80b3d73",
"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-04T13:28:51.5896686+00:00",
"date_create": "2026-08-04T13:28:51.5896686+00:00",
"date_update": "2026-08-04T13:28:51.5896686+00:00",
"updated_by_user_id": "2716b646-4552-47db-9b51-0df2ce40f4b9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-04T13:28:51.5896686+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-04T13:28:51.5896686+00:00",
"date_last_job": "2026-08-04T13:28:51.5896686+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-04T13:28:51.5896686+00:00",
"modified_dateutc": "2026-08-04T13:28:51.5896686+00:00",
"is_mobile_installation": true
},
"job_type_id": "229c96c1-2732-4c8f-a274-de287e639c6f",
"job_type_code": "sample string 7",
"job_type": {
"id": "bf536b2b-11ea-4c39-a19d-1d22d604f222",
"name": "sample string 2",
"sales_organization_id": "c785a929-42d8-449d-9d19-3085cea1e9d6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-04T13:28:51.5896686+00:00",
"code": "sample string 7"
},
"job_priority_id": "b7693a89-2f63-4f12-acad-e286b4a09f88",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "897bfa2d-07e1-4e10-9ac2-60f45f329651",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "408f84dc-04b3-4f13-bb2c-a0b5d7ae68d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T13:28:51.5896686+00:00"
},
"job_status_id": "2763330f-d3b8-49ee-ab3b-d2cdbe12ac89",
"job_status_code": "sample string 11",
"db_address_id": "3c3f9d51-eb2f-48ee-b685-0d37abfdc68f",
"contact_id": "05c4c592-8502-4f6a-8d74-b56502d97f7d",
"requested_by_company_id": "9d933cde-1d30-4bad-a9a1-1af2977a669a",
"requested_by_contact_id": "b2b1b66d-f475-4979-b86d-4f3fd64deafb",
"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-04T13:28:51.5896686+00:00",
"due_date": "2026-08-04T13:28:51.5896686+00:00",
"date_create": "2026-08-04T13:28:51.5896686+00:00",
"date_update": "2026-08-04T13:28:51.5896686+00:00",
"date_closed": "2026-08-04T13:28:51.5896686+00:00",
"suggested_user_id": "69e33941-995f-4ad1-802c-96365355e173",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "56f550c2-09d1-4c67-9fd7-4f81d3c86560",
"db_language_id": "f6d3023d-2136-4a74-af52-0923a6ca8f54",
"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-04T13:28:51.5896686+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c9edd52d-c3f1-42a8-bb74-1d9cc65b3b52",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "023967d7-34eb-45a9-8292-18c1cf503018",
"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": "e207ca44-2802-4b33-a62e-74f4d2c708e3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-04T13:28:51.5896686+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7bae88a5-54b7-4ee0-a331-35f20bf890d8"
},
"suggested_date_start": "2026-08-04T13:28:51.5896686+00:00",
"skill_id": "21331c81-e8a6-47ff-9e5b-7239cd7bfce5",
"skill_code": "sample string 32",
"skill": {
"id": "5760adec-08e9-4404-8d8c-f63303d2ddc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b969b195-6dc1-4947-b4ab-213572d2ccf0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "53bd59f2-8c6b-4a9b-8aed-18455549b1af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "390398d1-52f8-41ca-8831-4a85ffafb912",
"db_currency_id": "fb038c13-106d-4566-8de8-d3bfa6f9a24e",
"db_language_id": "1fbc80ec-6666-4183-856b-1f949100597d",
"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-04T13:28:51.5740548+00:00"
},
"modified_dateutc": "2026-08-04T13:28:51.5896686+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5b1ffae1-d59f-4edc-9717-ffe12c14b98e",
"date_reported_by_company": "2026-08-04T13:28:51.5896686+00:00",
"id2": 36,
"company_id": "1101e0fe-400b-45db-9cfc-a8c99fae5057",
"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": "1f307ec4-518d-4644-b72f-d342d3fc4138",
"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-04T13:28:51.5896686+00:00"
},
"work_instruction_details_id": "e2635a75-3bd0-44df-bf40-71a423d01ff0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9161369f-9d43-41b6-ab17-7d06291fbabc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "931b353a-e271-41e6-978f-502de1896e27",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-04T13:28:51.5896686+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": "6994f665-9e34-4f89-9ee5-81263d660b4a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-04T13:28:51.5896686+00:00"
}