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": "1ef878d6-0ece-459c-a6ac-b03ddadb8bda",
"jobs_id": "c5556311-26e8-4362-b947-63d55b81f8ec",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "398c9878-824f-46c4-ac4a-11d20f32a5fc",
"_parent_id": "fb78c92c-8c7c-4f4c-b4c6-2efd61382941",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bb36e561-9075-4d8e-a65c-e7079b202d01",
"project_reference_back_office": "sample string 5",
"project": {
"id": "29def43a-c4e6-4e06-8178-4cf2fdf8fcd8",
"_parent_id": "85400506-4371-4475-8436-9db873a2ffd9",
"root_parent_id": "47fdf18c-1b93-47ac-ae08-4781113f7b73",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e8fbdb7-3bac-4f45-a1c1-cca755ec60a1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0574d79e-1120-4a65-a043-65834ade5b35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fede89e3-7f15-4798-9acf-166eff76780f",
"_parent_code": "sample string 6",
"sales_organization_id": "299564f1-ce73-4278-906b-4c38c1240a6c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+00:00"
},
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00"
},
"equipment_model_id": "4f51bfb1-c0da-4112-a60c-9ee1d7bb9331",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c6f69585-0b2b-4887-b876-71d590b3b921",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "34059a7a-dde7-4229-89fe-08008d409758",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8740fb94-003e-40ac-9e99-254fbd8716ee",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c7c3b14f-6564-458e-8aef-1a2b7869c43c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+00:00"
},
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00"
},
"equipment_family_id": "fdafd2cf-bd31-46e1-85fa-206317b6c7fb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0574d79e-1120-4a65-a043-65834ade5b35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fede89e3-7f15-4798-9acf-166eff76780f",
"_parent_code": "sample string 6",
"sales_organization_id": "299564f1-ce73-4278-906b-4c38c1240a6c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+00:00"
},
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00"
},
"date_in_production_since": "2026-09-12T16:53:09.2745135+00:00",
"date_out_of_production_since": "2026-09-12T16:53:09.2745135+00:00",
"date_end_support": "2026-09-12T16:53:09.2745135+00:00",
"sales_organization_id": "8caa8ad1-bceb-4896-a3b7-5dc0d4619b3d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+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-12T16:53:09.2745135+00:00"
},
"project_status_id": "b45f02f9-c7b3-4cd4-9071-0691880fe1fc",
"project_status_code": "sample string 10",
"project_status": {
"id": "98cc0d61-a4b9-49b1-8f6a-aa5581a77043",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d90dbd22-98a9-4ec2-abc4-221176291acc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00"
},
"company_id": "bba95d05-05a7-4737-9b90-41ca706ddd91",
"company_code": "sample string 12",
"db_address_id": "19054437-b377-4232-ba7f-fda0d1058895",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4950d6bd-a7b2-4b22-bbc8-ae8a35102c7b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d5da2b4-b882-4e44-972d-435e032e2b8e",
"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-12T16:53:09.2745135+00:00",
"date_create": "2026-09-12T16:53:09.2745135+00:00",
"date_update": "2026-09-12T16:53:09.2745135+00:00",
"updated_by_user_id": "e71014d3-7486-48a0-a7ef-db9bbcb1fa6f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-12T16:53:09.2745135+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-12T16:53:09.2745135+00:00",
"date_last_job": "2026-09-12T16:53:09.2745135+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-12T16:53:09.2745135+00:00",
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00",
"is_mobile_installation": true
},
"job_type_id": "0d52ce0f-c8d2-4f8d-a48c-59a62f922e91",
"job_type_code": "sample string 7",
"job_type": {
"id": "f146b8e9-91ba-48f7-9e1e-207dc6d1ee16",
"name": "sample string 2",
"sales_organization_id": "9af3f0ae-9950-4bf1-9345-a2d3d1cf147a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00",
"code": "sample string 7"
},
"job_priority_id": "5c41af5d-b0e0-4715-bbc3-be2f8f30c436",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "55ffad34-42cc-4d13-a759-e949d5f035da",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fd25748b-d3c6-453f-87e9-bb971f775f81",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00"
},
"job_status_id": "f407a8c7-9bc1-48a2-aa88-fcaa51585153",
"job_status_code": "sample string 11",
"db_address_id": "f2bfb121-72c7-460a-be84-e7828e335719",
"contact_id": "1dfd0dac-bfdf-4f48-92bc-10cfac05bb7f",
"requested_by_company_id": "022a973b-95d5-4b58-91d9-ddd9497d9b4e",
"requested_by_contact_id": "47c2911b-cb93-4ea9-9c01-53b3f3af56d7",
"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-12T16:53:09.2745135+00:00",
"due_date": "2026-09-12T16:53:09.2745135+00:00",
"date_create": "2026-09-12T16:53:09.2745135+00:00",
"date_update": "2026-09-12T16:53:09.2745135+00:00",
"date_closed": "2026-09-12T16:53:09.2745135+00:00",
"suggested_user_id": "43685917-ed9b-445b-8b67-a44581286eaf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3790f7ae-1d3d-4608-9ea9-dfacd794d532",
"db_language_id": "76133dd7-ea69-420e-bd31-013592fd1da5",
"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-12T16:53:09.2745135+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d4f5c7d3-128f-4876-9f4f-c3ce1126b858",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "40bb507e-9945-46f2-a108-2df0d4109448",
"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": "b52fe256-987a-43ce-850c-3d51156684d9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f98e0c1b-d739-4fca-9370-c40f64f00a56"
},
"suggested_date_start": "2026-09-12T16:53:09.2745135+00:00",
"skill_id": "087cf95a-49df-4af9-af26-296d0b62b506",
"skill_code": "sample string 32",
"skill": {
"id": "29c1929d-c5f0-4bc1-a84c-7eeb2eb7a8f7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0c038d7a-9be9-44a6-9f35-8ce3ee95b98f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c1c5293-6b01-49a1-8bf7-0f840e3dc2cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bf2b9dc-8a9a-4d56-a01a-52aaf7d787cb",
"db_currency_id": "40eb16fb-15be-4850-b74c-b01b43cebf2c",
"db_language_id": "1143e9ce-747a-4f8c-b733-5a7bdb9bf0ae",
"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-12T16:53:09.2745135+00:00"
},
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fe0e994d-40bc-4ab6-bcd6-b64b24d9efd5",
"date_reported_by_company": "2026-09-12T16:53:09.2745135+00:00",
"id2": 36,
"company_id": "cba6b452-9700-4ecf-a884-62eb28a9b6d9",
"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": "0250d941-a318-4266-9682-7dfd20d6e298",
"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-12T16:53:09.2745135+00:00"
},
"work_instruction_details_id": "9baccfa1-3b4f-46ae-b7d7-bc61f726435b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "256ac95b-2eaa-41be-91c4-4fd6ed77494f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "187e238d-25ff-4846-a101-1c57e52ace62",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-12T16:53:09.2745135+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": "f06cb159-a0df-46f3-9274-5f3f4a7f044b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-12T16:53:09.2745135+00:00"
}