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": "95f1c4f4-3d01-4bf2-95b4-0644ccf17c4e",
"jobs_id": "375fe791-0809-4689-bcbd-954a156626c1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "64bafeb7-7cd7-4e9c-8714-eb15f7c02fff",
"_parent_id": "b118d7ef-2ecb-4c10-930f-e16cc03c2407",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a2f7f481-33a5-41f5-b77a-d2b5ead77a17",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9f5c1266-cd43-4918-b9ea-70f95a93b593",
"_parent_id": "e372ec9e-5063-46dc-b1a0-8a3a77133ad4",
"root_parent_id": "57393ab1-2710-4c00-8a8c-f9275afdafc2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9d84d1fe-e920-4c4f-8d5c-151c0caa6702",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5238af51-3f4f-4a8e-8bac-4d04fb15a22e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e9c64911-f5c7-4373-93ad-1c4fb176e631",
"_parent_code": "sample string 6",
"sales_organization_id": "0ac43930-9c58-41d3-b8d7-05be77214534",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00"
},
"equipment_model_id": "11ef1881-ee45-4b26-ae00-8984ba771af1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e401effe-1aae-4be8-a6aa-62cec899563f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "701b2c23-adb7-4c3c-88fd-c5dc4d6349c6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2546c883-67bf-4f28-a4ae-35584669b407",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1c90fd3a-32ac-4148-8890-d534220a24e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00"
},
"equipment_family_id": "783e021a-3015-4f38-b0ff-00d69b51a18b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5238af51-3f4f-4a8e-8bac-4d04fb15a22e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e9c64911-f5c7-4373-93ad-1c4fb176e631",
"_parent_code": "sample string 6",
"sales_organization_id": "0ac43930-9c58-41d3-b8d7-05be77214534",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00"
},
"date_in_production_since": "2025-10-16T04:47:13.7567147+00:00",
"date_out_of_production_since": "2025-10-16T04:47:13.7567147+00:00",
"date_end_support": "2025-10-16T04:47:13.7567147+00:00",
"sales_organization_id": "a27c0ceb-ce30-4c14-8b51-60fce67d85a0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+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": "2025-10-16T04:47:13.7567147+00:00"
},
"project_status_id": "26ec4dec-6ae5-4b7d-940e-b143deb213bb",
"project_status_code": "sample string 10",
"project_status": {
"id": "2b6b0d17-3203-493f-b5c2-d355e8e4221d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6524d45c-5a6b-4179-a296-8ccb29f6f6c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00"
},
"company_id": "570073a0-0a78-4527-9f07-c67ffce5281a",
"company_code": "sample string 12",
"db_address_id": "09f0ba0e-4cf5-49b1-8c2c-2ec385555c67",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c217c739-0028-4a5f-9b23-3f6f4dcde1f9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "be3a4bc1-f17c-4fc4-b78b-6c46ba5907e5",
"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": "2025-10-16T04:47:13.7567147+00:00",
"date_create": "2025-10-16T04:47:13.7567147+00:00",
"date_update": "2025-10-16T04:47:13.7567147+00:00",
"updated_by_user_id": "d56a1ded-e5cb-43eb-bcf7-6a050fdecabd",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-16T04:47:13.7567147+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": "2025-10-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-16T04:47:13.7567147+00:00",
"date_last_job": "2025-10-16T04:47:13.7567147+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-16T04:47:13.7567147+00:00",
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00",
"is_mobile_installation": true
},
"job_type_id": "dedbc3de-4400-4ad6-8f45-4fcb34f81386",
"job_type_code": "sample string 7",
"job_type": {
"id": "59739e0a-d315-4a0f-9d51-910a89944baf",
"name": "sample string 2",
"sales_organization_id": "d459dfb1-bb49-4575-8b6d-966ecaa51bb2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00",
"code": "sample string 7"
},
"job_priority_id": "8a377b9d-8f73-4b23-9a4d-4fec654a9560",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "87930686-3147-4bc0-97e9-3aa047ee631a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5f69f4d2-9262-4a4e-9358-968ab66c06bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00"
},
"job_status_id": "3154cb78-12f6-4e7e-a67d-d3866f452e2d",
"job_status_code": "sample string 11",
"db_address_id": "b114259b-3f27-4c80-9944-bb789da62063",
"contact_id": "584f6fc1-632d-426f-99ec-cfa8f29d39e4",
"requested_by_company_id": "176de36b-85b5-43db-bbf2-101716000486",
"requested_by_contact_id": "8783bb59-4ac5-495f-a82d-18a3eaf81a7d",
"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": "2025-10-16T04:47:13.7567147+00:00",
"due_date": "2025-10-16T04:47:13.7567147+00:00",
"date_create": "2025-10-16T04:47:13.7567147+00:00",
"date_update": "2025-10-16T04:47:13.7567147+00:00",
"date_closed": "2025-10-16T04:47:13.7567147+00:00",
"suggested_user_id": "569e4e5d-395a-4449-bfeb-1d19e9ddc23c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c1cf8eb6-d0db-4867-a2b3-fbf39ae175b6",
"db_language_id": "e28289da-bbc6-4acd-8090-e1f53104aba9",
"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": "2025-10-16T04:47:13.7567147+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1b28ccd1-b655-42ca-bc3f-4e306e270ab8",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fe19d934-2f43-4d23-8af7-c5cbdd6562d5",
"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": "e2119322-da12-431e-b78f-82d8dc216b48",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2b2842bc-2c6e-4b4a-b0b5-b571d562d130"
},
"suggested_date_start": "2025-10-16T04:47:13.7567147+00:00",
"skill_id": "61ac1e6e-b7a5-402d-bc3c-2f4dd7cb9ac7",
"skill_code": "sample string 32",
"skill": {
"id": "fcc77a75-5695-49c8-9615-157ed06dc9df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c8f3f64b-22fb-40ee-87fe-393f31bf4ce8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d20c0a9-dcaa-40e9-acbb-fd79468433f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0576fa89-87ee-4b9c-8593-01c783ba7dac",
"db_currency_id": "20367ed8-669b-403a-8ccd-eec91d49eeda",
"db_language_id": "840e0676-f6e2-4ea1-97b9-a1f4440ee913",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aa188773-111b-471e-8324-f3fb7cbebcdd",
"date_reported_by_company": "2025-10-16T04:47:13.7567147+00:00",
"id2": 36,
"company_id": "6cf11da3-0fd5-4157-819a-7bced86f6bc1",
"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": "b0cbb566-0e4d-4214-b27f-35b21a72e409",
"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": "2025-10-16T04:47:13.7567147+00:00"
},
"work_instruction_details_id": "7860933f-60e2-4ab6-a9db-c1981591c746",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "474cf56e-13c2-4d04-a4a9-d7b60d0dd421",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f666cd7-e41e-4d39-8b60-53d383e0af2c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-16T04:47:13.7567147+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": "fccf1841-02f7-45b4-a13b-e0b687f7cf95",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-16T04:47:13.7567147+00:00"
}