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": "ebd87ea5-b3d1-4dbf-ab50-5a1fbb6f4de0",
"jobs_id": "96d42275-8843-4133-b452-1c312a373df0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a36fc4bb-086f-4b0d-8323-966907a1b7d9",
"_parent_id": "65ce1a22-eb7e-4cab-b7ad-ad8bf7495276",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c76724b4-f50f-4644-9dd1-e936e4f29a74",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b38ae918-51ef-45fc-966f-e4c529c5d88e",
"_parent_id": "b356a174-4dfd-4a13-a775-e294d0e0308e",
"root_parent_id": "82aa2cb2-e2bd-405e-b357-ab1f25fff197",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3c5ddb93-4825-40e7-a7ec-ca9ba6db95ae",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e87e1cd9-a992-46a8-98e3-f8150f200a19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f02dec1d-8c54-49f9-b5ab-629cbcda0c64",
"_parent_code": "sample string 6",
"sales_organization_id": "514e93c6-fc21-49a8-bebb-baf9e0eb9e69",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+00:00"
},
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00"
},
"equipment_model_id": "a29829a3-f1e4-4086-b5f6-cf48c1855271",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3d37d2a2-62c6-493f-bfa1-778062e8b26b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1fb53f8f-05a6-4c17-b6fa-9ef71e4d29ec",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f8a9570d-a1e1-4841-9ef3-bf6c896423e2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "807b5875-7707-40ee-9420-efad9db553e8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+00:00"
},
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00"
},
"equipment_family_id": "5d4a8cf6-4ab0-4443-9e44-b319971b4d73",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e87e1cd9-a992-46a8-98e3-f8150f200a19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f02dec1d-8c54-49f9-b5ab-629cbcda0c64",
"_parent_code": "sample string 6",
"sales_organization_id": "514e93c6-fc21-49a8-bebb-baf9e0eb9e69",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+00:00"
},
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00"
},
"date_in_production_since": "2026-09-24T01:51:08.1156472+00:00",
"date_out_of_production_since": "2026-09-24T01:51:08.1156472+00:00",
"date_end_support": "2026-09-24T01:51:08.1156472+00:00",
"sales_organization_id": "097c0ab9-a54c-4527-9951-d79e6cd593b6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+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-24T01:51:08.1156472+00:00"
},
"project_status_id": "f6084153-6a04-4e5e-b9a3-e7b10e79f94a",
"project_status_code": "sample string 10",
"project_status": {
"id": "267fbe07-6ea6-496b-8d99-440292b6fb4b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "899034ca-fe7b-42d1-b5c4-df32a009b4e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00"
},
"company_id": "705bb5e2-4ea4-4584-b73e-92f7e4c2ac57",
"company_code": "sample string 12",
"db_address_id": "d6cd8d43-c77d-4807-a38d-904a872b023b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b1cb1ce0-aee3-4fe5-ab4d-e10e6cf8607d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e41329b8-f3f2-445b-a110-642343546efd",
"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-24T01:51:08.1156472+00:00",
"date_create": "2026-09-24T01:51:08.1156472+00:00",
"date_update": "2026-09-24T01:51:08.1156472+00:00",
"updated_by_user_id": "daa74ce3-a884-4e3d-a358-59a35a5de9b0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-24T01:51:08.1156472+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-24T01:51:08.1156472+00:00",
"date_last_job": "2026-09-24T01:51:08.1156472+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-24T01:51:08.1156472+00:00",
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00",
"is_mobile_installation": true
},
"job_type_id": "f46d6b29-c364-4a75-ae57-c4d4d94c9b44",
"job_type_code": "sample string 7",
"job_type": {
"id": "de349574-02f0-4f76-a0b5-46bbd9e6c6f9",
"name": "sample string 2",
"sales_organization_id": "5e98b575-92b7-4aa5-b23e-bd2881a62007",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00",
"code": "sample string 7"
},
"job_priority_id": "a4cf4b9a-dddb-427d-8851-4d285590ebd0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8c5b51b3-8a01-4c89-88e8-994308c354e6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "62a53a08-21a0-488f-b249-caf009705401",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00"
},
"job_status_id": "9788a692-404b-4d77-a370-b20e2d60c7fe",
"job_status_code": "sample string 11",
"db_address_id": "0514ba66-660c-4bbe-8f8f-047b2c674983",
"contact_id": "64a6cbfe-381c-4fea-8eac-49019e1a3371",
"requested_by_company_id": "f8d75d07-3694-49e1-9829-d87eec43a2f0",
"requested_by_contact_id": "269f90bd-bf82-47f5-b744-916df3f4d462",
"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-24T01:51:08.1156472+00:00",
"due_date": "2026-09-24T01:51:08.1156472+00:00",
"date_create": "2026-09-24T01:51:08.1156472+00:00",
"date_update": "2026-09-24T01:51:08.1156472+00:00",
"date_closed": "2026-09-24T01:51:08.1156472+00:00",
"suggested_user_id": "e8c2ebe1-2630-47b3-b0f8-7a708243bb44",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cce420fc-fbce-43e4-97fe-a20740c9a7df",
"db_language_id": "20f96398-89ac-4476-857c-6bd16c85cead",
"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-24T01:51:08.1156472+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2a2e322c-2a36-486a-9dcb-b360b7da8ac2",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4d83a349-f0fe-489e-8f23-28b4f96e288c",
"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": "db61215a-b95e-485f-b584-b359dbe96be1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0eaafb4d-9e5d-4c2f-b39e-284fbd106b44"
},
"suggested_date_start": "2026-09-24T01:51:08.1156472+00:00",
"skill_id": "7eeaa98e-8eb1-4c56-b974-15d017a94981",
"skill_code": "sample string 32",
"skill": {
"id": "4b4382eb-3fd3-4509-974c-c8bc02d72964",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "45046f85-13b9-47b9-bb68-927b97be1372",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee483c0d-8f68-4f87-a583-d6e68651a6ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16068d16-2ff2-4107-91cc-accf7a6d47c5",
"db_currency_id": "edbc7a65-d29b-49e4-a430-05d37e00d1d5",
"db_language_id": "77ceda27-8ffb-4593-abda-69c155f63718",
"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-24T01:51:08.1000236+00:00"
},
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "80e644fa-70e0-4a2a-bbdf-5fe036b9b023",
"date_reported_by_company": "2026-09-24T01:51:08.1156472+00:00",
"id2": 36,
"company_id": "e55bc047-e63e-464e-87ce-b510e3a86909",
"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": "eae3d2a2-1b9e-4358-b0d5-8e4ea2c9b488",
"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-24T01:51:08.1156472+00:00"
},
"work_instruction_details_id": "f79fd7d5-abc2-4d99-b8e1-055912d93f12",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "981f89e7-4a30-47cb-aa16-eab37b9385e4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a62ecb03-bbbf-461f-a1f7-d1d39ac0f3ec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-24T01:51:08.1156472+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": "df7021d3-0df1-425a-8138-941521b9e05d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-24T01:51:08.1156472+00:00"
}