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": "eb1a1a7e-8b63-47f6-a7a0-7eb3d0214ace",
"jobs_id": "99446681-0abe-4b1e-99d3-4138d8ac8b2a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "00f905ef-77e7-49b8-b3e6-26e12b80fc75",
"_parent_id": "383dff46-c9c7-40ec-b4fc-62061608940a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a8893f95-7b9f-4218-9c52-fba24b857728",
"project_reference_back_office": "sample string 5",
"project": {
"id": "06051298-8505-479a-be9c-ed24e362a773",
"_parent_id": "b47e66d8-8a34-40e5-a1fa-b36a8e08af26",
"root_parent_id": "e44c3189-7e36-4369-b531-7a8188b620c3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5a231dd2-83f3-4778-a58a-18f38f648127",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bab1dcc1-b09a-46aa-b0ba-7ef131ede23e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9f858d31-73a6-44d6-a610-a24db3e22873",
"_parent_code": "sample string 6",
"sales_organization_id": "ab06de88-c5cc-4f3a-95c2-00e09fa59c2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+00:00"
},
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00"
},
"equipment_model_id": "794fb611-bb5a-4ae7-9cc9-2fcf29fae9d3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2c36bece-e7ce-4584-b1a6-2e17f4fd86c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5b7d61c3-51bf-4ebf-8bf9-5340f8e3973c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9ca72102-baa5-42b1-8251-9f86860814e4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dc3371f4-cfc0-44b4-bdc0-314a86e06f54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+00:00"
},
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00"
},
"equipment_family_id": "21232683-a225-4c4d-8b42-d2032199cb3b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bab1dcc1-b09a-46aa-b0ba-7ef131ede23e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9f858d31-73a6-44d6-a610-a24db3e22873",
"_parent_code": "sample string 6",
"sales_organization_id": "ab06de88-c5cc-4f3a-95c2-00e09fa59c2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+00:00"
},
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00"
},
"date_in_production_since": "2026-05-31T02:33:11.8299082+00:00",
"date_out_of_production_since": "2026-05-31T02:33:11.8299082+00:00",
"date_end_support": "2026-05-31T02:33:11.8299082+00:00",
"sales_organization_id": "598839ab-3d5d-4e95-a4d7-2d41882592a9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+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-05-31T02:33:11.8299082+00:00"
},
"project_status_id": "2e2eab38-d309-40b6-bf95-cad7f156593c",
"project_status_code": "sample string 10",
"project_status": {
"id": "edfe608f-8eb0-4d3c-8693-a21f6823047a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "621c2ea7-dd50-4b27-a146-c777ccd6681e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00"
},
"company_id": "517111ec-6689-405f-95b2-9569f896448a",
"company_code": "sample string 12",
"db_address_id": "0afbbd82-54db-429d-9eaa-9b78c10d9e92",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8d4dbd8a-1baf-4ff1-b029-48e643d604ed",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "917fdb24-3211-4354-ac22-1d460d246d8a",
"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-05-31T02:33:11.8299082+00:00",
"date_create": "2026-05-31T02:33:11.8299082+00:00",
"date_update": "2026-05-31T02:33:11.8299082+00:00",
"updated_by_user_id": "baf0b834-2a1e-4be9-8b42-c79a116e548b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-31T02:33:11.8299082+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-05-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-31T02:33:11.8299082+00:00",
"date_last_job": "2026-05-31T02:33:11.8299082+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-31T02:33:11.8299082+00:00",
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00",
"is_mobile_installation": true
},
"job_type_id": "e7dd12cb-5473-4ab8-80b5-dea680e49ff2",
"job_type_code": "sample string 7",
"job_type": {
"id": "3554765a-bfc1-44d7-a155-8a3c470500f2",
"name": "sample string 2",
"sales_organization_id": "48d2afcc-8b92-492f-867b-42662b556d92",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00",
"code": "sample string 7"
},
"job_priority_id": "a5886345-c64b-4ff0-a3ec-87058cde1b16",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f876b81b-840b-48a6-b16b-1bd5b39ebe2d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "36cc11d3-dc3c-4376-b782-f095afaedd79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00"
},
"job_status_id": "f7ca3a2b-8edd-490e-9ba2-c55b4c263369",
"job_status_code": "sample string 11",
"db_address_id": "d46e8c5e-228c-4327-80bf-1b8b8446b89d",
"contact_id": "484a2a89-a96f-40b5-918e-52878d237dbd",
"requested_by_company_id": "0dd88ac4-7d7e-40e9-a57a-fe116558ac8c",
"requested_by_contact_id": "37376253-5405-44c5-b623-9e26a57ba0ea",
"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-05-31T02:33:11.8299082+00:00",
"due_date": "2026-05-31T02:33:11.8299082+00:00",
"date_create": "2026-05-31T02:33:11.8299082+00:00",
"date_update": "2026-05-31T02:33:11.8299082+00:00",
"date_closed": "2026-05-31T02:33:11.8299082+00:00",
"suggested_user_id": "655ba4b6-dcd9-4c67-a0e1-56bead2275fd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0b790163-d5df-4150-bd5f-140946e198ed",
"db_language_id": "35ca51c7-c83f-48ca-9466-a64a65739e27",
"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-05-31T02:33:11.8299082+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c49bb28a-c9ce-4486-b9c8-c0dea3ea3a95",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0823dab4-4064-4ddb-ab95-a8f3e462c362",
"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": "bbc36a67-242c-4e55-98b0-8d446a439e84",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1333c297-fb09-4d7a-8b28-22e21072493f"
},
"suggested_date_start": "2026-05-31T02:33:11.8299082+00:00",
"skill_id": "b5aee122-e33b-4cce-86f9-5b0cf80df39b",
"skill_code": "sample string 32",
"skill": {
"id": "cd2708d4-77bd-4087-a250-d70fdf6a6d62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5d1b00c7-cbcd-4e03-ba87-045a3ec99463",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2bb7ef4-c277-4244-bc96-b7c17f174dff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25d24883-a2cc-40e8-9a73-33a345698756",
"db_currency_id": "f6184309-b742-4196-9309-fae91d3f72e9",
"db_language_id": "4a60acd2-0afc-4a1b-b25b-70217876a9a2",
"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-05-31T02:33:11.814281+00:00"
},
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e86b3654-49f6-4927-ab32-2895c3754ed4",
"date_reported_by_company": "2026-05-31T02:33:11.8299082+00:00",
"id2": 36,
"company_id": "5d187b0d-15ad-4a42-b316-3e2baed98aa7",
"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": "1d8a3861-5e6b-49d1-b3ed-4f2e63387df2",
"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-05-31T02:33:11.8299082+00:00"
},
"work_instruction_details_id": "d5fd4333-0f11-4c34-8f5f-c348fcdc2a13",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b85bf235-7e88-4be2-81f2-0f23db1b98d3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "27686f2a-e2c2-4e7a-9d52-3067f037c73b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-31T02:33:11.8299082+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": "3381bf27-9c36-4a2b-8f0d-68a308d4577e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-31T02:33:11.8299082+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.