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": "43cd79d4-c32c-4c9a-8525-d6481f9e620b",
"jobs_id": "bb2a29f1-bf28-4417-bb30-4c175f5de352",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "701b6cfb-b750-4249-ae99-26daa52aff96",
"_parent_id": "8b83f2fd-0aae-4853-b800-abbf5b9dc2a4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c0bb7d68-e126-4c06-9f59-8fc8964bcb2d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "021f4c5b-9c21-43c5-a717-d60dc1a0642a",
"_parent_id": "c8db5add-eb1d-40e5-a4f1-f009db297ea5",
"root_parent_id": "1620f921-2ee9-45b0-818a-90147c5b1ea8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e666b74b-3fb0-4d28-8625-704ac4739e75",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "81f4c8f5-77bf-4593-a9bf-109733aa5436",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0166d35-5b50-414c-b05a-379ca7ea5141",
"_parent_code": "sample string 6",
"sales_organization_id": "314267b0-92bf-4f05-a199-286218af448b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+00:00"
},
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00"
},
"equipment_model_id": "794a427a-254a-4dfd-839a-7bee59a0cf4e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "60d48f6e-2381-433c-b748-b7a9a3cf65f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ec834bdc-dcd8-4ec4-a361-940fdc195a9c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8159dcc3-1fb0-4bcb-8513-913d2acd7b15",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4bb360fe-9ff5-4003-a6d3-604408d3ff4a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+00:00"
},
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00"
},
"equipment_family_id": "35be209e-4178-471b-abb4-0e3ad30f9982",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "81f4c8f5-77bf-4593-a9bf-109733aa5436",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0166d35-5b50-414c-b05a-379ca7ea5141",
"_parent_code": "sample string 6",
"sales_organization_id": "314267b0-92bf-4f05-a199-286218af448b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+00:00"
},
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00"
},
"date_in_production_since": "2026-03-08T01:34:22.8228288+00:00",
"date_out_of_production_since": "2026-03-08T01:34:22.8228288+00:00",
"date_end_support": "2026-03-08T01:34:22.8228288+00:00",
"sales_organization_id": "29ff7e03-3265-4dfd-aa5f-8ab05a44447a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+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-03-08T01:34:22.8228288+00:00"
},
"project_status_id": "a309dc16-bb51-4dc5-862a-ba07f1568830",
"project_status_code": "sample string 10",
"project_status": {
"id": "1a8c329d-bff2-45c6-9467-b30eb7f4ad89",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "789a5b1a-f4b2-429c-9443-ba7820e10c7f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00"
},
"company_id": "604fefd5-c393-4814-bf9f-c2d466e0f390",
"company_code": "sample string 12",
"db_address_id": "e5bcc0fa-a426-4b8d-af0f-04f1298a989c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7b85ccf4-0d41-4f40-9e09-f7dc36b53fd3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f2855d4c-59f9-4684-bf9c-69110d3587db",
"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-03-08T01:34:22.8228288+00:00",
"date_create": "2026-03-08T01:34:22.8228288+00:00",
"date_update": "2026-03-08T01:34:22.8228288+00:00",
"updated_by_user_id": "38eb1d27-04c2-4fcd-b1b5-85adbd9c5f46",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-08T01:34:22.8228288+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-03-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-08T01:34:22.8228288+00:00",
"date_last_job": "2026-03-08T01:34:22.8228288+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-08T01:34:22.8228288+00:00",
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00",
"is_mobile_installation": true
},
"job_type_id": "f7802cb2-b50c-41b8-895e-dc216acdeac8",
"job_type_code": "sample string 7",
"job_type": {
"id": "d702b334-075d-4d7d-8b9e-b047686b4f51",
"name": "sample string 2",
"sales_organization_id": "0244e743-bfc3-4d6b-8f31-4a3d5ffdc2f2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00",
"code": "sample string 7"
},
"job_priority_id": "9b811e89-1b08-4149-9653-02450b84cd80",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a7d3396d-02dd-4cf9-b7c4-670db30e33ef",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4eaa5cc1-f898-4291-a554-76af40eb7a49",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00"
},
"job_status_id": "70dbab60-c091-4633-933a-917de4126e7e",
"job_status_code": "sample string 11",
"db_address_id": "8de4bc4a-3b34-40d1-b22e-e9c2e901b3b0",
"contact_id": "4756d360-d9eb-4a8b-8378-0599a7ff5c70",
"requested_by_company_id": "c2bc766b-be69-474c-82ca-7b94acc77a22",
"requested_by_contact_id": "8b4f61a0-9799-4887-8f5c-6ff29165773d",
"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-03-08T01:34:22.8228288+00:00",
"due_date": "2026-03-08T01:34:22.8228288+00:00",
"date_create": "2026-03-08T01:34:22.8228288+00:00",
"date_update": "2026-03-08T01:34:22.8228288+00:00",
"date_closed": "2026-03-08T01:34:22.8228288+00:00",
"suggested_user_id": "9812aa1d-a524-406c-9c2f-f4c11c9c3e65",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dfe4a052-ab98-417e-b435-06c58939e40a",
"db_language_id": "08785cfe-2e6e-4b0a-9d1a-5f3e260f9e1f",
"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-03-08T01:34:22.8228288+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d9703d4b-5ad5-4d53-aa3e-ce661c39b925",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "211248ce-0aa4-4949-b62b-d8a56b2becdb",
"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": "6711829d-f5a1-4ecd-a6a7-e569feff7774",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d2f163b0-dc2b-4ff6-bb17-e2348c22a91f"
},
"suggested_date_start": "2026-03-08T01:34:22.8228288+00:00",
"skill_id": "0ef9374f-d3b6-4f0d-ac2c-b0b82fbe408b",
"skill_code": "sample string 32",
"skill": {
"id": "ee619c22-cbf6-4299-a9ff-0c29ee6bb5a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0f9ee7cf-289f-46f7-a46d-3530f7eda79f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ad722d54-566c-4272-a3fa-782ca2814e33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17f0f1fb-5a89-41e5-b4d4-e37ec4afc2a7",
"db_currency_id": "e129c22b-d3ad-4cab-8ec3-08774fa359af",
"db_language_id": "d4e366c1-4758-42c0-b998-6c73eaf96391",
"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-03-08T01:34:22.8228288+00:00"
},
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2ac5b1c2-a245-44ce-bc27-d0ea41b1d8f5",
"date_reported_by_company": "2026-03-08T01:34:22.8228288+00:00",
"id2": 36,
"company_id": "79b7e1b7-8929-4801-ac2a-9f9cda25407b",
"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": "3a687fd1-6619-4b5a-a101-c818cd5c40b3",
"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-03-08T01:34:22.8228288+00:00"
},
"work_instruction_details_id": "c9cd29ab-9a70-43ea-9dd7-1d490541e2db",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5fc65079-37e7-4bb1-b051-654df594c627",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "67327c68-8f06-4ab2-b07c-cb813b233531",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-08T01:34:22.8228288+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": "033c029e-36fa-4f1d-94a9-4c424eea18e3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-08T01:34:22.8228288+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.