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": "2fb46038-cbfe-4984-8cfa-66e63d049778",
"jobs_id": "00cd356f-704e-4d7d-bc88-7ffcfa5a48a1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "671d3d38-c21f-4308-9361-c04fc165ac29",
"_parent_id": "58ec3da7-4f92-4dd6-b99c-ed270b9e45a9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dab15bb1-5b07-4273-9cab-1677679f2a45",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8817a3ce-84f6-4ece-bb9c-c7c89a288bf8",
"_parent_id": "1adfa89f-6989-43ad-ac9b-9e6c0a3f5a0e",
"root_parent_id": "9153dcb5-07d4-47c9-9ab1-1a0b4cb9251b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "23a6f1ed-2dd7-465c-abe8-d094891d2e06",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0099320f-8aba-4560-a04e-639cd6c29b49",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "23c61655-a821-4c65-ab56-78807516de10",
"_parent_code": "sample string 6",
"sales_organization_id": "b99b77c1-09a9-46e2-9e4c-d0a8a137e6b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+00:00"
},
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00"
},
"equipment_model_id": "986dd1de-c01e-401c-ac16-119a1809c5bd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bc4979c4-18ab-4ed4-ab6c-c7b9e1e4c8c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3a17e6c7-8ab8-48bb-81bc-2eecb5b7786b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "195028cd-e976-4ffe-9ac7-561b4215dca2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "36d0ddac-9463-4b7d-a8b0-767ca92bd8af",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+00:00"
},
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00"
},
"equipment_family_id": "6183d876-42e7-45c5-a979-91cb99066e9c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0099320f-8aba-4560-a04e-639cd6c29b49",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "23c61655-a821-4c65-ab56-78807516de10",
"_parent_code": "sample string 6",
"sales_organization_id": "b99b77c1-09a9-46e2-9e4c-d0a8a137e6b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+00:00"
},
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00"
},
"date_in_production_since": "2026-08-28T15:24:25.9567408+00:00",
"date_out_of_production_since": "2026-08-28T15:24:25.9567408+00:00",
"date_end_support": "2026-08-28T15:24:25.9567408+00:00",
"sales_organization_id": "b8c857ef-c496-4fcf-8010-c15f6d96f84a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+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-28T15:24:25.9567408+00:00"
},
"project_status_id": "23bf7bb4-379b-4898-a055-0f96b5616def",
"project_status_code": "sample string 10",
"project_status": {
"id": "e44cefe4-578a-4b72-8cf9-ce49ecba4873",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4cf5babb-9753-4b53-bee4-ad8af13334ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00"
},
"company_id": "47d6a380-3b50-4649-b5b0-a942a2534c55",
"company_code": "sample string 12",
"db_address_id": "14008b66-bec8-4e86-aa4e-6680c312c07d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fc7fc357-79b3-42f0-8069-2b1c159f9e82",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0e594d6a-2eb2-4740-b6e9-7c36b2d476cc",
"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-28T15:24:25.9567408+00:00",
"date_create": "2026-08-28T15:24:25.9567408+00:00",
"date_update": "2026-08-28T15:24:25.9567408+00:00",
"updated_by_user_id": "13da3074-16cd-4720-bb30-8eaea6618998",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-28T15:24:25.9567408+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-28T15:24:25.9567408+00:00",
"date_last_job": "2026-08-28T15:24:25.9567408+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-28T15:24:25.9567408+00:00",
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00",
"is_mobile_installation": true
},
"job_type_id": "55ff1f1d-7ec5-4640-bcd9-dc917fa66671",
"job_type_code": "sample string 7",
"job_type": {
"id": "714eae55-954b-41fe-85f6-a85fdeddeb7f",
"name": "sample string 2",
"sales_organization_id": "88ad54fc-48d1-4568-805b-c4e3f77f3b39",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00",
"code": "sample string 7"
},
"job_priority_id": "e076c4f1-7c8e-4ad6-9aee-643bdc5ea626",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "49d977cf-0a45-4792-9205-54b686881e7a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9ef26b8a-4ef5-45f3-a07c-1cf868aeb5ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00"
},
"job_status_id": "6bab0c3e-b59e-4b3d-8222-f45a6d1d0630",
"job_status_code": "sample string 11",
"db_address_id": "1ab14119-2056-4731-862a-fcd7a3fe98ff",
"contact_id": "d497c483-9ca6-46ea-a74c-33b25b254335",
"requested_by_company_id": "70982262-b036-4565-bd4e-6f2b72740146",
"requested_by_contact_id": "6b67c7dd-91fb-4b1a-8b54-7aacef6104ff",
"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-28T15:24:25.9567408+00:00",
"due_date": "2026-08-28T15:24:25.9567408+00:00",
"date_create": "2026-08-28T15:24:25.9567408+00:00",
"date_update": "2026-08-28T15:24:25.9567408+00:00",
"date_closed": "2026-08-28T15:24:25.9567408+00:00",
"suggested_user_id": "d78cb4af-5af4-43a3-9b97-e346267a7c16",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "25a9bfa2-01f0-4d29-a9b0-d40908d651c9",
"db_language_id": "2a1acbbb-06a4-4ad6-80f5-5730a4ced252",
"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-28T15:24:25.9567408+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "570cce31-64d6-4f9f-91ab-cb93e321127f",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dd270aa1-8b33-49fe-a45f-b9df64110e08",
"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": "e66ceb26-f0f0-402a-a5ed-938fc2cd27cd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "30aece01-22f3-4172-8818-db35f0742e5b"
},
"suggested_date_start": "2026-08-28T15:24:25.9567408+00:00",
"skill_id": "06ed6869-e113-4fcc-ab7a-b8bba091cecd",
"skill_code": "sample string 32",
"skill": {
"id": "7b7cae5d-e383-48bb-8f06-292342b36626",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bea59dd7-b426-4e97-b947-e0320ecff431",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24b88ace-90bf-40d5-9c39-fd886e9d1465",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be68a6da-ff5a-4117-b91f-c03581ff4015",
"db_currency_id": "702bfebc-f689-4f91-acea-b014f2812e56",
"db_language_id": "7ffcac64-65b9-49db-b35f-981c9251a0fd",
"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-28T15:24:25.9567408+00:00"
},
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "88b0111a-1d1a-4be6-b132-a90d64879b55",
"date_reported_by_company": "2026-08-28T15:24:25.9567408+00:00",
"id2": 36,
"company_id": "5ee21d42-8f44-483f-98df-c266fdd647d0",
"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": "4bb22bce-9359-4d7e-aae0-5f9dabce0359",
"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-28T15:24:25.9567408+00:00"
},
"work_instruction_details_id": "c26dd52e-523c-4687-9b2b-473be98061b6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "833dc4fe-9cee-4139-8e0d-84a07327ccca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4826225f-d2c1-49c2-96e2-51abc99ca0b1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-28T15:24:25.9567408+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": "4679fcde-ba5e-4dbe-9545-c1214c8adfb2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-28T15:24:25.9567408+00:00"
}