Updates 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 :
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 |
Request Formats :
application/json, text/json
Sample:
{
"id": "62169200-793a-449f-83c0-e2f6fe90a263",
"jobs_id": "151ba98c-45ae-4288-91e8-614f4827ba28",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "38a8a184-d909-4555-afad-3b4b0daf4074",
"_parent_id": "0ac26095-c86c-49f8-ae6f-3c7e3d5578ac",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4d74ba47-7021-46ec-bd48-096e7f6091f2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8b0520de-f985-401e-8f64-086853bf3e25",
"_parent_id": "f9d00043-9a7b-491b-8a33-8fa4c19bf879",
"root_parent_id": "83182afb-a007-43b9-a5d6-bbf1b8ecacfe",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d71ff874-dfcc-4865-b3f8-50b9070ccd25",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1f24a082-5835-4fac-b6ea-47fde2aaf8e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e543320d-7856-4fe9-bf86-c4fa3587072d",
"_parent_code": "sample string 6",
"sales_organization_id": "6071a929-a43b-4d6d-9f31-cd3154baa0b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+00:00"
},
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00"
},
"equipment_model_id": "4ffc6d44-6119-4cf1-a0f1-2a27f002f60c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1e544fca-497c-44c3-abb9-0d95545385cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6968e70d-6ce8-4645-9b1b-c23638f96dd8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "144c08d6-0bfe-4cd6-8734-768fce4bc6c8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b8a20c2c-b20e-49c8-af6f-58ecb74ca07b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+00:00"
},
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00"
},
"equipment_family_id": "80b364bb-802a-4710-b4c3-41f26e58294b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1f24a082-5835-4fac-b6ea-47fde2aaf8e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e543320d-7856-4fe9-bf86-c4fa3587072d",
"_parent_code": "sample string 6",
"sales_organization_id": "6071a929-a43b-4d6d-9f31-cd3154baa0b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+00:00"
},
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00"
},
"date_in_production_since": "2026-09-09T03:17:23.8174151+00:00",
"date_out_of_production_since": "2026-09-09T03:17:23.8174151+00:00",
"date_end_support": "2026-09-09T03:17:23.8174151+00:00",
"sales_organization_id": "90a19be5-686f-4377-b9eb-a0cf7fa31234",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+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-09T03:17:23.8174151+00:00"
},
"project_status_id": "6765d66d-c3f0-48f1-99c4-009aef01289c",
"project_status_code": "sample string 10",
"project_status": {
"id": "a0ae62ad-4a6c-4663-b110-63aa2981e3e2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ed43478c-cf86-4791-bd09-256ec39710a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00"
},
"company_id": "9d7a175c-52d6-4c50-9c7c-5fc12b1cb193",
"company_code": "sample string 12",
"db_address_id": "dc07511b-895a-45cd-a0ab-5e88e483b5b4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f403eca1-ce45-4efe-8cd2-f7b95ea248e6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0090aa10-aec6-4d2f-9679-626a73cc9a99",
"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-09T03:17:23.8174151+00:00",
"date_create": "2026-09-09T03:17:23.8174151+00:00",
"date_update": "2026-09-09T03:17:23.8174151+00:00",
"updated_by_user_id": "55362eb6-17b1-4c0e-ae83-28e75db6fb78",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-09T03:17:23.8174151+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-09T03:17:23.8174151+00:00",
"date_last_job": "2026-09-09T03:17:23.8174151+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-09T03:17:23.8174151+00:00",
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00",
"is_mobile_installation": true
},
"job_type_id": "4f8230cc-cca6-402f-ba4b-670acc8cb81f",
"job_type_code": "sample string 7",
"job_type": {
"id": "eda54e6f-ed0b-491b-8ed0-8631057d0351",
"name": "sample string 2",
"sales_organization_id": "86f3fab1-6e08-4ce8-a3e4-6528aa707fe3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00",
"code": "sample string 7"
},
"job_priority_id": "ea57f05c-9ecd-4209-beab-7fcd8383eb8b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bd8e6ac1-00d4-4e32-bbab-c89ca49631e6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1fff108f-fc59-4242-9a7b-1c2d7ff60b58",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00"
},
"job_status_id": "13330a97-1df2-4c6d-8740-1ee579a1a8a7",
"job_status_code": "sample string 11",
"db_address_id": "86bc823a-4cd8-4104-9acd-c2246292bdf5",
"contact_id": "750ee58c-5236-4cb9-936a-d8c6a7ca0f74",
"requested_by_company_id": "f844bdf8-d372-420a-b670-f65badd4f3db",
"requested_by_contact_id": "e6fb6944-42a8-4603-8242-5e8e99c45fef",
"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-09T03:17:23.8174151+00:00",
"due_date": "2026-09-09T03:17:23.8174151+00:00",
"date_create": "2026-09-09T03:17:23.8174151+00:00",
"date_update": "2026-09-09T03:17:23.8174151+00:00",
"date_closed": "2026-09-09T03:17:23.8174151+00:00",
"suggested_user_id": "465fef20-52a3-4721-a806-e72b63395411",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "be0b6956-96ca-4e37-8173-96ad1a62ff75",
"db_language_id": "78161bcf-2bdc-4a8f-9978-8a5301877421",
"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-09T03:17:23.8174151+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "297cbe10-3c71-44db-a6ee-5debb4e70a08",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "120b6a21-c7cc-44b7-acc1-b3cc2ccc4d2d",
"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": "49f02a85-19b9-4dcc-a96d-7399bfc85f54",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "599b5eb0-e68a-4b27-b11b-b3a0ee753991"
},
"suggested_date_start": "2026-09-09T03:17:23.8174151+00:00",
"skill_id": "7f6db273-db94-4d75-be50-f2a1037cdd65",
"skill_code": "sample string 32",
"skill": {
"id": "19e63c3b-3d16-4b14-95c3-ac54ac6e4170",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6b4eb776-e99b-42dc-b116-5938f87d62c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df0ad64e-619d-4c5b-bf31-61c7384416c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c43bd1d2-a727-4ca5-8639-46635cc3c7f3",
"db_currency_id": "98684100-27b2-4c82-b474-98c742656aaf",
"db_language_id": "0c741998-2168-41f6-a515-6bcd7c69540e",
"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-09T03:17:23.8174151+00:00"
},
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7c379898-692e-4e1c-8a27-2b19b7f75e08",
"date_reported_by_company": "2026-09-09T03:17:23.8174151+00:00",
"id2": 36,
"company_id": "57ee457d-b877-440d-9dfa-a7a78f6071c8",
"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": "33199a24-214c-47f4-a682-6a847d44dee6",
"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-09T03:17:23.8174151+00:00"
},
"work_instruction_details_id": "0faeced8-2a08-4637-9a0f-59bc816d7753",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e576dd55-4fd6-4dcf-ab7d-055c29767c6f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "95f77c6e-3f3f-4bac-9d83-6598d7c26ed1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-09T03:17:23.8174151+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": "a8e33880-309c-4a9c-8a5d-a3260958b613",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-09T03:17:23.8174151+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.