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": "87401366-6ec6-4a2b-8d4c-d3bee116f197",
"jobs_id": "b673cf1c-ebff-4559-b202-b2f942213539",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6efd4e49-e7cc-4441-91ce-d02fe9d2777d",
"_parent_id": "1f78e9a1-6e18-4b9c-85b3-8348b6ff05e4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b0cce01a-3036-4b0e-8365-d7d02332dce6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "68778983-3de7-4baa-bcd5-9bcaf379798d",
"_parent_id": "ba606646-f7e6-48fc-bf5f-0fea711dbdb9",
"root_parent_id": "59d3aec8-4e5e-4442-a134-fa28079c4364",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d397c1d5-3474-448d-9eef-123d140bd2a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9f60d865-3216-4cb5-a8fb-d119d3663e93",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "48e96844-4c93-4bf0-9c92-cf39c4f8d5d3",
"_parent_code": "sample string 6",
"sales_organization_id": "d1abbcb3-5920-4dcf-bfea-164adbc8e8f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+00:00"
},
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00"
},
"equipment_model_id": "f16994cb-05e9-403e-bf72-466595936c2d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "91541711-2c14-40b0-9796-0f12cfe37988",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "851fc861-d376-41bf-9345-5837caa9c6f3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b8d6cab4-9af2-478e-81d3-2199a2c868e9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d12ac46a-51cf-4a79-b390-3f274b86999a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+00:00"
},
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00"
},
"equipment_family_id": "ebfe81d8-778b-4087-8449-9dadf14637d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9f60d865-3216-4cb5-a8fb-d119d3663e93",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "48e96844-4c93-4bf0-9c92-cf39c4f8d5d3",
"_parent_code": "sample string 6",
"sales_organization_id": "d1abbcb3-5920-4dcf-bfea-164adbc8e8f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+00:00"
},
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00"
},
"date_in_production_since": "2026-01-07T20:24:11.2229374+00:00",
"date_out_of_production_since": "2026-01-07T20:24:11.2229374+00:00",
"date_end_support": "2026-01-07T20:24:11.2229374+00:00",
"sales_organization_id": "596ec913-bc6d-4897-8d56-90c1c302db16",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+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-01-07T20:24:11.2229374+00:00"
},
"project_status_id": "9a0baa03-ebb6-421c-a933-f5259c0d78c3",
"project_status_code": "sample string 10",
"project_status": {
"id": "c172050b-b6ca-4d35-b776-b194cf0d7a26",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3e608b94-c4fa-49e9-812d-1d148a44e86c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00"
},
"company_id": "23a5f8b4-b12a-4eac-84fe-565c7dd00c39",
"company_code": "sample string 12",
"db_address_id": "676bddb0-3d94-46b4-bd62-31063c788e60",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d3fdf8f4-05cc-42ac-b615-506a56536f39",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9ae41f1a-db81-48ea-a6f7-9a5cce59636e",
"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-01-07T20:24:11.2229374+00:00",
"date_create": "2026-01-07T20:24:11.2229374+00:00",
"date_update": "2026-01-07T20:24:11.2229374+00:00",
"updated_by_user_id": "64666500-eb54-4741-9019-95da2c04a43f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-07T20:24:11.2229374+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-01-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-07T20:24:11.2229374+00:00",
"date_last_job": "2026-01-07T20:24:11.2229374+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-07T20:24:11.2229374+00:00",
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00",
"is_mobile_installation": true
},
"job_type_id": "b0dc7324-2efb-4e72-93f7-5a94e6f921ec",
"job_type_code": "sample string 7",
"job_type": {
"id": "1e32d1c1-2a12-4881-a69d-a1a03b4e316d",
"name": "sample string 2",
"sales_organization_id": "48179c52-d67c-44d0-97db-bc2cc8771069",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00",
"code": "sample string 7"
},
"job_priority_id": "c08a74db-a345-494a-a089-994da867c7e7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aa1a9f76-b44e-45b4-96df-0ea38c1c58be",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fda042b8-c159-4099-950a-4f4bf4d6b2fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00"
},
"job_status_id": "27aed17d-b432-4b10-ba55-efc3c48057fb",
"job_status_code": "sample string 11",
"db_address_id": "22b055da-f1c4-4b87-a8c5-c6b56e198403",
"contact_id": "5342f46d-2fe4-4225-ba15-406a9833394f",
"requested_by_company_id": "97167e4f-057d-4ffa-b590-dab8164aab4a",
"requested_by_contact_id": "9d6791a2-be50-4548-b77c-a9a514785731",
"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-01-07T20:24:11.2229374+00:00",
"due_date": "2026-01-07T20:24:11.2229374+00:00",
"date_create": "2026-01-07T20:24:11.2229374+00:00",
"date_update": "2026-01-07T20:24:11.2229374+00:00",
"date_closed": "2026-01-07T20:24:11.2229374+00:00",
"suggested_user_id": "26709aa7-9709-4b2b-a65a-150f2a94fd04",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f23a70fb-ee08-4934-b6a6-f07a9defa261",
"db_language_id": "2be0467b-95d6-4e03-88cd-1a72db97a514",
"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-01-07T20:24:11.2229374+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4f0c31c7-c874-442d-a5f1-c516a2203dc2",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "330b00de-1a39-49e7-bf65-f5b7157a8e6f",
"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": "275d8788-ed84-4cc8-8a69-77d401a70520",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c91b06a7-cd05-4fdb-8f5c-47ebbdf9e5f8"
},
"suggested_date_start": "2026-01-07T20:24:11.2229374+00:00",
"skill_id": "fdf07c5c-6b4e-4678-a10e-99a43d44d2b9",
"skill_code": "sample string 32",
"skill": {
"id": "9cb0cda7-2b09-47fa-adb9-c369bf85d755",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fd9973d6-28c3-454b-8a67-096eeaf48103",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "858787b8-7fac-463d-bb04-106cee2c934b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2394fc5c-4bb9-4fa6-874a-edfbf6fcb596",
"db_currency_id": "7fd014df-a58a-457f-b404-56c7d5bfb7c1",
"db_language_id": "f95546fd-a56f-4e8a-b06d-e42cb99cdbf8",
"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-01-07T20:24:11.2229374+00:00"
},
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0d97aff1-228e-4e33-a033-0cb744f05ac1",
"date_reported_by_company": "2026-01-07T20:24:11.2229374+00:00",
"id2": 36,
"company_id": "8c93ce1b-43da-449d-bf98-b46d9e9d6c8f",
"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": "d0037bbe-b62b-4c98-a220-b6196213ed1a",
"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-01-07T20:24:11.2229374+00:00"
},
"work_instruction_details_id": "ca936e02-5104-4553-a3d1-f264f15f2d87",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "24166dd4-0b38-45e7-aca6-fd123517009d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "491f0d67-32f1-4242-af01-b4200b61b794",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-07T20:24:11.2229374+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": "992a6fa8-1438-4afd-908b-14e0f72022b5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-07T20:24:11.2229374+00:00"
}