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": "b91e0161-04b4-4fe6-b7ea-7a727331d7bc",
"jobs_id": "5c501ba8-e815-40b3-9020-5d22f93ad60f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "af0ffa6f-dfb6-4540-8274-5e9820406726",
"_parent_id": "6de9824b-a38a-4139-8954-ef181dfdcd63",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c800db06-a5fb-4fb4-963b-59c6e48862dc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c672e73d-dbae-43e9-96ff-e80568e95676",
"_parent_id": "4ac90057-bc16-4622-8d47-4173527df66e",
"root_parent_id": "c2493b70-fa35-4ff3-a8e2-e43e6e89b385",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bf1481f0-4f87-4d01-a9f0-d84e949f482f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "663fb27a-263e-41f1-8bb5-207961cc33aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "33ae2024-ae7c-4a13-8552-8c80cd86f261",
"_parent_code": "sample string 6",
"sales_organization_id": "2811c084-04c0-4481-9b9b-26193f896939",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+00:00"
},
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00"
},
"equipment_model_id": "962a6d21-dd40-4464-9bbd-79ff441e1445",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "24c85bd0-2cee-42a5-9513-79a81e0e6ce6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "44cde8d7-3a69-4a2b-9b11-7ea4be7e66f0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f2d3e350-3552-4adf-8485-742c337d4aea",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "46d50511-775a-45e0-a756-cfe09d45f8fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+00:00"
},
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00"
},
"equipment_family_id": "bf7aa98a-4fc1-4698-9eda-90dea1844338",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "663fb27a-263e-41f1-8bb5-207961cc33aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "33ae2024-ae7c-4a13-8552-8c80cd86f261",
"_parent_code": "sample string 6",
"sales_organization_id": "2811c084-04c0-4481-9b9b-26193f896939",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+00:00"
},
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00"
},
"date_in_production_since": "2026-09-30T10:16:12.4534459+00:00",
"date_out_of_production_since": "2026-09-30T10:16:12.4534459+00:00",
"date_end_support": "2026-09-30T10:16:12.4534459+00:00",
"sales_organization_id": "66f22024-bf70-40ca-89eb-23fc2fbd179e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+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-09-30T10:16:12.4534459+00:00"
},
"project_status_id": "b56ab118-921b-4bee-9e10-700a4b8ae0ed",
"project_status_code": "sample string 10",
"project_status": {
"id": "a8b961b6-36eb-4bb7-b3aa-01e8790a1a9c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5b09d641-0b91-4d3d-944d-111a68fdddcb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00"
},
"company_id": "8b7e1cf5-1d47-418a-821b-2aa1b108c8f1",
"company_code": "sample string 12",
"db_address_id": "cac17b0c-ad7e-408b-a3c7-01bfecd9dd1c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "43e09a69-d7c0-4c25-aae4-16e8b43fb498",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0a9844d3-8411-481b-8d25-e56fb91a4b36",
"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-09-30T10:16:12.4534459+00:00",
"date_create": "2026-09-30T10:16:12.4534459+00:00",
"date_update": "2026-09-30T10:16:12.4534459+00:00",
"updated_by_user_id": "3730a9f8-30f8-426a-9365-afccffd49177",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T10:16:12.4534459+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-09-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T10:16:12.4534459+00:00",
"date_last_job": "2026-09-30T10:16:12.4534459+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T10:16:12.4534459+00:00",
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00",
"is_mobile_installation": true
},
"job_type_id": "abfc2cc5-7ea2-4501-80d3-d3663ecca2bd",
"job_type_code": "sample string 7",
"job_type": {
"id": "bfdd3b62-24f3-415a-aafd-229d9523cbe5",
"name": "sample string 2",
"sales_organization_id": "b4d71145-f524-47dc-a33b-abcc03f9e185",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00",
"code": "sample string 7"
},
"job_priority_id": "c1426b4f-4254-4426-b947-a61da8400c6f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d607b066-0977-455e-a3f9-70a0135f2f1b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "33103c9b-95c5-4b7a-ad73-4ec3afbe2f7b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00"
},
"job_status_id": "ca559561-4397-44cd-ba96-e2384d4f06ea",
"job_status_code": "sample string 11",
"db_address_id": "7f931352-99e2-4bd7-958a-ee1241858d61",
"contact_id": "6678c2fb-f1fa-4464-b0f1-3e2d6c857dc9",
"requested_by_company_id": "3d66e184-a74d-4a63-87dd-0cd4d3dabf62",
"requested_by_contact_id": "df9fe585-80aa-46ad-98b1-f7ab49487c39",
"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-09-30T10:16:12.4534459+00:00",
"due_date": "2026-09-30T10:16:12.4534459+00:00",
"date_create": "2026-09-30T10:16:12.4534459+00:00",
"date_update": "2026-09-30T10:16:12.4534459+00:00",
"date_closed": "2026-09-30T10:16:12.4534459+00:00",
"suggested_user_id": "e032ca28-74ef-46a2-b982-0cc1d44325c8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5d84ca75-1880-4230-bd54-1f1aaab4ea7b",
"db_language_id": "fab7efe7-fb66-4260-a776-487e2fcf7db7",
"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-09-30T10:16:12.4534459+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7c9a52b2-b65b-46d1-baeb-1ab47cc197d8",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8c6ea3b8-9e84-4c78-9cf1-4c32b6d8b4b0",
"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": "553792dc-b869-4639-8a8b-443d90c67dde",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "32b74ea0-926d-4e7a-878f-1ed4b742332b"
},
"suggested_date_start": "2026-09-30T10:16:12.4534459+00:00",
"skill_id": "0617d30d-14db-4bab-bc6d-22178af30cc2",
"skill_code": "sample string 32",
"skill": {
"id": "181e18ab-acff-4c50-a52d-c6c1bda078a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2ca058b7-7545-45e7-828f-19e853d0753d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cdfbb7d6-c3e6-44cf-a7ea-b2af864918cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0164bb23-5ab8-4f5e-a159-08cd77f914d8",
"db_currency_id": "dcc3160d-ec2f-4023-a048-1ba8536f9688",
"db_language_id": "3f4a39dd-7721-461e-8506-6c4e56f5ce81",
"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-09-30T10:16:12.4534459+00:00"
},
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6989ac8e-b6c7-404e-9acd-2fe981987b40",
"date_reported_by_company": "2026-09-30T10:16:12.4534459+00:00",
"id2": 36,
"company_id": "0a1491d4-b397-4cf0-b851-6d59a2104f9f",
"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": "ba9a5046-7a7e-401b-be0f-511a62bc974a",
"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-09-30T10:16:12.4534459+00:00"
},
"work_instruction_details_id": "061e28d7-277c-43e5-ad1e-2f716e7ce25f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ac806c4d-baea-4a5b-b025-03652ea07378",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "09fe152a-5ae3-46e8-8f0f-5f946fc3e9d0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T10:16:12.4534459+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": "5d081cb8-7b83-41f6-ba9a-e0bc275bd2df",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T10:16:12.4534459+00:00"
}