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": "1733a1d7-d50e-4111-8914-dd440d53be75",
"jobs_id": "4d2161d5-7c65-4d85-8b33-df9fa62e19a5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f6c8e9bb-ec3d-4cd2-83cf-e09ee0c632d2",
"_parent_id": "49f20358-ff0c-4e6a-9dc5-812fb6253094",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3f8c6000-7c7e-4090-8752-b3e10cffd1af",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8de2efea-5d78-40ca-b4b3-19feb7b0cd22",
"_parent_id": "930759ba-4da0-4cad-8505-6515d001e289",
"root_parent_id": "9ce1196d-667f-4b15-8e1d-cbd1e9e6eeb1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "83c0a173-0cbc-4c5e-82e0-cbc284d11fb2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "74b17d01-9986-4d9c-9aa7-98bbcf95b535",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf95ba1e-cc1f-43b2-a3cf-defa65c27f99",
"_parent_code": "sample string 6",
"sales_organization_id": "be88fdd0-2ad7-488b-ba92-d1b02b3e6725",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+00:00"
},
"modified_dateutc": "2025-11-16T21:55:47.2065011+00:00"
},
"equipment_model_id": "6ee7e2d0-1c5a-4144-9689-a6be55f57752",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "52923580-bd5c-468e-a17b-6de2b567ce5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e0244a88-5be5-4dfe-a3eb-7eb0803d3428",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "97fda6f9-e0fc-405e-901f-c14ac3ed31d8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3f717e4e-fac0-4df9-bb84-556827114e3f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+00:00"
},
"modified_dateutc": "2025-11-16T21:55:47.2065011+00:00"
},
"equipment_family_id": "6fc81a4f-ebaa-42bc-a2cc-6981a871e9aa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "74b17d01-9986-4d9c-9aa7-98bbcf95b535",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf95ba1e-cc1f-43b2-a3cf-defa65c27f99",
"_parent_code": "sample string 6",
"sales_organization_id": "be88fdd0-2ad7-488b-ba92-d1b02b3e6725",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+00:00"
},
"modified_dateutc": "2025-11-16T21:55:47.2065011+00:00"
},
"date_in_production_since": "2025-11-16T21:55:47.2065011+00:00",
"date_out_of_production_since": "2025-11-16T21:55:47.2065011+00:00",
"date_end_support": "2025-11-16T21:55:47.2065011+00:00",
"sales_organization_id": "867b6954-9f0f-4856-851f-b92a8f703a07",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+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-11-16T21:55:47.2221224+00:00"
},
"project_status_id": "883dcc76-d3c8-4526-b248-463d5a459a14",
"project_status_code": "sample string 10",
"project_status": {
"id": "34614dc2-b7cd-4bd0-a69a-9248a4004e3d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "15c3ca43-0ff6-45a9-a827-f1bfc1a3833d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T21:55:47.2221224+00:00"
},
"company_id": "335b25d1-5f45-4cd6-921e-34c70706091d",
"company_code": "sample string 12",
"db_address_id": "692bb446-b07d-4634-a1f7-4e870144b0ee",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "84a48f92-4ea1-48d2-89b3-94ca998a8f77",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6f2f3f06-f360-4bf6-abfe-70e67ab1f226",
"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-11-16T21:55:47.2221224+00:00",
"date_create": "2025-11-16T21:55:47.2221224+00:00",
"date_update": "2025-11-16T21:55:47.2221224+00:00",
"updated_by_user_id": "7896abb5-d133-4d04-b762-90feecc9957c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-16T21:55:47.2221224+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-11-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-16T21:55:47.2221224+00:00",
"date_last_job": "2025-11-16T21:55:47.2221224+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-16T21:55:47.2221224+00:00",
"modified_dateutc": "2025-11-16T21:55:47.2221224+00:00",
"is_mobile_installation": true
},
"job_type_id": "136ae41e-b647-4b26-b6be-47ed44368ff2",
"job_type_code": "sample string 7",
"job_type": {
"id": "dace049f-4993-4209-9862-2aa412ba9e99",
"name": "sample string 2",
"sales_organization_id": "101adec9-d6aa-43e4-a29c-f0e8f95ea4fe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-16T21:55:47.2221224+00:00",
"code": "sample string 7"
},
"job_priority_id": "e7dc71e1-b607-473c-a7d7-787239a7f2c2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a79cff10-8329-4771-bebe-274e26786f10",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b38c85ff-cbf0-4c7d-b1ff-7d20c5e23de8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T21:55:47.2221224+00:00"
},
"job_status_id": "83d62161-d17c-4b6d-af16-c82278bb8cd4",
"job_status_code": "sample string 11",
"db_address_id": "e2c08d49-3113-48a9-9f7e-df4f4608767a",
"contact_id": "8135c09d-6bbe-45ca-a4f7-3d5a143c1fe9",
"requested_by_company_id": "a749d284-68d5-4e28-91a8-83dddf9d5fc0",
"requested_by_contact_id": "e96c248a-66ec-400b-8439-b1085a763d8b",
"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-11-16T21:55:47.2221224+00:00",
"due_date": "2025-11-16T21:55:47.2221224+00:00",
"date_create": "2025-11-16T21:55:47.2221224+00:00",
"date_update": "2025-11-16T21:55:47.2221224+00:00",
"date_closed": "2025-11-16T21:55:47.2221224+00:00",
"suggested_user_id": "1a920ab3-83dd-4c2e-a25e-b778c5a174c6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c27b11e6-005e-4416-895f-4a459153798a",
"db_language_id": "b448afe6-f9b9-4e76-ada9-8a93a7f60eb5",
"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-11-16T21:55:47.2221224+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c890ad9c-3261-4450-bc99-411845e8ca60",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "84e4cea9-4305-499a-9278-9b4146054deb",
"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": "bb813684-ec39-427a-9f24-44a2fcef5d4e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-16T21:55:47.2221224+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d91f8dd0-a61d-4707-9b72-e3d8efa6a332"
},
"suggested_date_start": "2025-11-16T21:55:47.2221224+00:00",
"skill_id": "26108ef5-2176-44ef-af83-813191285ac8",
"skill_code": "sample string 32",
"skill": {
"id": "18000f8e-70f5-4f1f-b1ad-00bd46fe922d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bb1bccb4-7658-49d6-b908-5c3d619e9aa9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "383a36a6-9db7-4754-8684-56e7a6c0648d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "918c9f2e-f3e3-400b-9bad-2c3a0431e694",
"db_currency_id": "ba4adc47-f758-495c-915e-d32e1c247d3a",
"db_language_id": "149c6718-7701-4e8f-b2bf-8e65b23a486d",
"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-11-16T21:55:47.2065011+00:00"
},
"modified_dateutc": "2025-11-16T21:55:47.2221224+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f5bfdd2a-ffa6-45fe-90e6-2c309fbfd2da",
"date_reported_by_company": "2025-11-16T21:55:47.2221224+00:00",
"id2": 36,
"company_id": "ec872c0c-886d-4a59-bf08-80a2a4529408",
"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": "8fef2b54-cee2-442f-b85e-d09c64f24595",
"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-11-16T21:55:47.2221224+00:00"
},
"work_instruction_details_id": "c2f284c6-08b6-4cf6-b474-992fce735f84",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "91919222-3489-4c61-a01e-8d268837e4b5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "79ffcabe-16e9-40d9-86fc-07d245b95963",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-16T21:55:47.2221224+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": "dc71f3ba-2cc4-40aa-a6dc-05ac64fbb1a6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-16T21:55:47.2221224+00:00"
}