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": "a722d3cd-1d51-48fe-9551-68379e3b9c2f",
"jobs_id": "28c753c1-eab3-4711-86a8-3d1e7da2d1be",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d77b0a99-17bb-4564-85ea-ae49b5cc4a3c",
"_parent_id": "5f4f86cf-f6db-4c87-8a19-bf67f675223f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7e965199-3429-49d1-9889-7c2e1a1975da",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0327b8f4-4c35-4ac3-a153-ec6dc1bc3354",
"_parent_id": "87bc47bc-5e17-4394-8b38-ee66a0dc7a37",
"root_parent_id": "88cddef7-1fbc-42e1-ae75-759147aca66c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b3e12d53-b14c-407a-b04e-feb9467df981",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e96fc3ef-7e32-460f-8f89-30ff50b3e280",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e16361d-79e9-4ce1-9832-5b0901013b63",
"_parent_code": "sample string 6",
"sales_organization_id": "e4935a48-4192-4c7d-ba55-5899543fb276",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+00:00"
},
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00"
},
"equipment_model_id": "28cb22e6-0857-4b90-977f-0607a9b2f2bd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "928f895a-a66e-4bec-91ec-f06c452f601a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b2900f36-2e5c-401b-81fe-c6dec1503866",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "78944d14-d421-4424-8cd4-1c6d7f5ee19f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9f5ab679-6e46-4ffb-8edd-784636797f58",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+00:00"
},
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00"
},
"equipment_family_id": "1791821b-1d7c-4752-afcb-6caa2dbd5c44",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e96fc3ef-7e32-460f-8f89-30ff50b3e280",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e16361d-79e9-4ce1-9832-5b0901013b63",
"_parent_code": "sample string 6",
"sales_organization_id": "e4935a48-4192-4c7d-ba55-5899543fb276",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+00:00"
},
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00"
},
"date_in_production_since": "2026-07-14T08:35:28.2910833+00:00",
"date_out_of_production_since": "2026-07-14T08:35:28.2910833+00:00",
"date_end_support": "2026-07-14T08:35:28.2910833+00:00",
"sales_organization_id": "a6495df7-88e4-4ac2-a872-0cfd1d32c126",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+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-07-14T08:35:28.2910833+00:00"
},
"project_status_id": "243a7296-dbe6-4f82-b413-b3deac561acb",
"project_status_code": "sample string 10",
"project_status": {
"id": "4fec4ff9-a687-4429-961e-501f1027d639",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "914953c1-3eab-4f66-bdd3-42571b166ad3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00"
},
"company_id": "14b0a953-1c9a-4b90-b495-2f3ac2417d90",
"company_code": "sample string 12",
"db_address_id": "ae43826d-ae88-47f9-8eb4-25c039d30936",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "15cd17f2-36c4-4261-b98a-635913fe5daa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cc836fe1-34cf-457d-8547-d02e6b65c2d7",
"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-07-14T08:35:28.2910833+00:00",
"date_create": "2026-07-14T08:35:28.2910833+00:00",
"date_update": "2026-07-14T08:35:28.2910833+00:00",
"updated_by_user_id": "2d111242-a515-442c-a638-9452d8bb178e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-14T08:35:28.2910833+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-07-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-14T08:35:28.2910833+00:00",
"date_last_job": "2026-07-14T08:35:28.2910833+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-14T08:35:28.2910833+00:00",
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00",
"is_mobile_installation": true
},
"job_type_id": "0e9d83ec-6b1d-49c6-8cd2-3e6f6883cb0d",
"job_type_code": "sample string 7",
"job_type": {
"id": "77c1b35d-dc4d-4221-b177-bb940e222132",
"name": "sample string 2",
"sales_organization_id": "c30b23d8-359a-4aa7-801e-2e80b8737068",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00",
"code": "sample string 7"
},
"job_priority_id": "54c01667-51ff-4a80-a0fa-71b8abc4c8bb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f59176b7-7cac-4474-9070-85abca7b7399",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bda9d477-d7f5-428c-a94a-617a76e94c2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00"
},
"job_status_id": "de6e977f-6d5d-44b7-bb40-b7d9d64a7f8d",
"job_status_code": "sample string 11",
"db_address_id": "08a1b40b-f21c-4179-b9e7-e6c85a23dd0a",
"contact_id": "5e2858ee-d512-42e4-8ebf-e789f9e44537",
"requested_by_company_id": "080d89dd-9152-478b-892b-5a20a85eaaf8",
"requested_by_contact_id": "f013a764-30fc-47e5-801a-867ec022d1e3",
"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-07-14T08:35:28.2910833+00:00",
"due_date": "2026-07-14T08:35:28.2910833+00:00",
"date_create": "2026-07-14T08:35:28.2910833+00:00",
"date_update": "2026-07-14T08:35:28.2910833+00:00",
"date_closed": "2026-07-14T08:35:28.2910833+00:00",
"suggested_user_id": "ed6750e7-f53f-414a-98b2-711b6c418e1f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a4f70ee6-b851-45d8-a2a2-3fb04943f4da",
"db_language_id": "cc668d53-e9ba-43fa-8362-2f5e8bf055b0",
"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-07-14T08:35:28.2910833+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8795804c-2f13-4c04-aee7-cb69bce1a83b",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a5eb3860-d8ec-4bae-85d6-304c15c14a30",
"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": "404484de-4351-41da-8e4d-5f05ceff8e5a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "43bb10f4-e0aa-41ac-8e3d-cd42276b4129"
},
"suggested_date_start": "2026-07-14T08:35:28.2910833+00:00",
"skill_id": "3ec348c4-e7fa-4e00-afdf-327af3b75c22",
"skill_code": "sample string 32",
"skill": {
"id": "23e41aaf-a0d3-48be-a515-b47c46527a26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "93d64458-0830-433c-b44e-6813b28e0455",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "688b6607-fa91-4229-87e6-e2ebad904d3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334f0bb9-fbbe-4291-8a5e-d77858b19c9d",
"db_currency_id": "b32de939-a5d4-4cc5-99a4-47c0bf77e165",
"db_language_id": "6a9328c6-a1e3-4c6c-afe8-7baa6814c91c",
"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-07-14T08:35:28.2910833+00:00"
},
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "174dd131-332d-4097-8bdd-f0565fe4e176",
"date_reported_by_company": "2026-07-14T08:35:28.2910833+00:00",
"id2": 36,
"company_id": "27667183-0fa9-4d26-9fe2-21c186372cad",
"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": "903811df-0e72-48dc-9ccf-8d7284b9c0b7",
"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-07-14T08:35:28.2910833+00:00"
},
"work_instruction_details_id": "13544199-c73c-4255-a350-fbd26971206c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6dc1768a-72d0-4e1c-bf7e-124d4c99dd2e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "88e045fa-1933-484c-b64a-cba51be4aae2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-14T08:35:28.2910833+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": "d1cf05e4-ef62-44e7-8fdd-752e2adc09da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-14T08:35:28.2910833+00:00"
}