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": "83890fcb-76a2-44c8-acd9-23fb73b2de67",
"jobs_id": "e6147a0b-1654-427b-9233-8c2c8995c076",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2911b89f-3232-4968-b677-2b005bb89625",
"_parent_id": "a01335b8-176c-45b2-86a8-4cc8424cd2c1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f1ec831a-f4e9-4745-93a5-8ab8d6df5a1e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "47b90735-b838-4e23-8d3d-08dd3b6fba9b",
"_parent_id": "2a29f060-a361-435e-9dc6-268e8ec233fe",
"root_parent_id": "ec1cde67-cd12-43d3-a88d-30b6480a59ba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "173814e8-3c8c-4e73-8177-1c03a472b27b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "00f4a093-35be-40d8-846f-645e2bb23fb3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4a48431-830f-4720-89a7-aa8faaa2fc53",
"_parent_code": "sample string 6",
"sales_organization_id": "f9c582cf-8c5a-4a47-8609-e96ddf4d0697",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+00:00"
},
"modified_dateutc": "2025-11-23T09:37:41.4255631+00:00"
},
"equipment_model_id": "0eca413a-9625-4c22-8a95-a9c9ca497fb3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "87babd47-0707-4f8c-a8ae-da1b1215f24f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a9f9816d-edc0-499c-8f16-59c05344f825",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b0094538-a692-405a-8087-a2a8ebb7d5d1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ae543f32-24a7-4504-9527-e5cb7ae301ad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+00:00"
},
"modified_dateutc": "2025-11-23T09:37:41.4255631+00:00"
},
"equipment_family_id": "6579a681-115e-469c-a6a3-5d2bcdea67d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "00f4a093-35be-40d8-846f-645e2bb23fb3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4a48431-830f-4720-89a7-aa8faaa2fc53",
"_parent_code": "sample string 6",
"sales_organization_id": "f9c582cf-8c5a-4a47-8609-e96ddf4d0697",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+00:00"
},
"modified_dateutc": "2025-11-23T09:37:41.4255631+00:00"
},
"date_in_production_since": "2025-11-23T09:37:41.4255631+00:00",
"date_out_of_production_since": "2025-11-23T09:37:41.4255631+00:00",
"date_end_support": "2025-11-23T09:37:41.4255631+00:00",
"sales_organization_id": "74650f9d-596e-4356-92e3-75bbfcb52cd3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+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-23T09:37:41.4411966+00:00"
},
"project_status_id": "92e572c8-cf77-4728-b768-9ab1cfe5be5c",
"project_status_code": "sample string 10",
"project_status": {
"id": "c6f80449-634a-45e2-adf0-6078c7d23483",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "19b4df72-331d-4887-bc1d-283893db20c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-23T09:37:41.4411966+00:00"
},
"company_id": "d3cec44d-4fcf-4851-b274-e337c29e76f0",
"company_code": "sample string 12",
"db_address_id": "f080c418-dd25-46a9-bae4-b32430fd7983",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a5768f13-6022-49d4-9905-1cdf67df41fd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8fab27af-6e72-4965-af62-8c95bbb8c83e",
"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-23T09:37:41.4411966+00:00",
"date_create": "2025-11-23T09:37:41.4411966+00:00",
"date_update": "2025-11-23T09:37:41.4411966+00:00",
"updated_by_user_id": "24a5e4f2-8790-476f-802f-9d16931eb73d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-23T09:37:41.4411966+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-23T09:37:41.4411966+00:00",
"date_last_job": "2025-11-23T09:37:41.4411966+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-23T09:37:41.4411966+00:00",
"modified_dateutc": "2025-11-23T09:37:41.4411966+00:00",
"is_mobile_installation": true
},
"job_type_id": "a9d3d5e3-6189-4590-975a-8d1343c68b77",
"job_type_code": "sample string 7",
"job_type": {
"id": "4fc0dbbb-d728-4fd5-92bc-fdf1253b98ed",
"name": "sample string 2",
"sales_organization_id": "e105ac54-612b-46fb-8688-e359478e7d36",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-23T09:37:41.4411966+00:00",
"code": "sample string 7"
},
"job_priority_id": "9f31847a-c0be-419a-9699-23d094796b9e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0604e319-3f8e-448b-b35c-900a658dd92b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "53714414-cfba-4bc2-af24-af0b27bca178",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-23T09:37:41.4411966+00:00"
},
"job_status_id": "78faabce-63ed-4461-b675-48b13b1e08b1",
"job_status_code": "sample string 11",
"db_address_id": "4e3955c4-8982-4c79-8abb-c82d664499bf",
"contact_id": "7f51ecee-21e5-4018-93e4-963c85eec581",
"requested_by_company_id": "33b5108e-1672-41ae-ba6d-3330f39fa14f",
"requested_by_contact_id": "8c557b76-4b20-4411-9f9f-b338cd3f9b81",
"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-23T09:37:41.4411966+00:00",
"due_date": "2025-11-23T09:37:41.4411966+00:00",
"date_create": "2025-11-23T09:37:41.4411966+00:00",
"date_update": "2025-11-23T09:37:41.4411966+00:00",
"date_closed": "2025-11-23T09:37:41.4411966+00:00",
"suggested_user_id": "f0c6c117-7f5b-48ea-af6d-b30b90e4b147",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dc77095a-9663-49a8-98b6-1a2361fe45a5",
"db_language_id": "517784ec-51ad-46c8-84db-da7c7a1495ea",
"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-23T09:37:41.4411966+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "062ea413-c81a-4d12-9d3b-5f189891e339",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "eb1fe086-09a4-42a6-9d8b-c4ce2dfdec47",
"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": "147fefba-9c74-438c-b466-ed7a0132e053",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-23T09:37:41.4411966+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5f7e3c44-3fa4-46af-bc96-de7eb762d95c"
},
"suggested_date_start": "2025-11-23T09:37:41.4411966+00:00",
"skill_id": "466c568b-0eb2-4d5d-8799-fc9654823d48",
"skill_code": "sample string 32",
"skill": {
"id": "0bab6d23-9f35-4e2e-b468-7b28154e4077",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c10f0f65-6b57-40c6-90e3-46296385c867",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e2f29cb8-5147-4238-ba2e-28267de5a260",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfc38063-8622-42fd-83f9-0bb55b06be5c",
"db_currency_id": "ad48bd7a-0c6e-470e-9ab0-322d472f9291",
"db_language_id": "c7fe0db5-8042-4736-a0fa-dd626cb001bd",
"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-23T09:37:41.4255631+00:00"
},
"modified_dateutc": "2025-11-23T09:37:41.4411966+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6f88c5e5-dd3c-49da-9b23-5ea929f60808",
"date_reported_by_company": "2025-11-23T09:37:41.4411966+00:00",
"id2": 36,
"company_id": "379af7e0-08ec-4446-987d-929cf1dd7d48",
"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": "2d26dfc0-e0fe-4a39-9410-af254d435d64",
"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-23T09:37:41.4411966+00:00"
},
"work_instruction_details_id": "3730d3d7-a9d4-4db0-9cde-3d1fd439815b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1642bdc1-e89c-49b0-b28d-77962a0b7bab",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c4b9f6c5-d56f-44e9-aa34-16d220b04cbe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-23T09:37:41.4411966+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": "a2c68b35-3204-4d1c-a76e-e3fdc5bade3f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-23T09:37:41.4411966+00:00"
}