Resource Operation

Introduction

Configuration Vector messages pass between the ManageApp and any other application (including itself) to request that the application update a configuration vector, by performing an insert/update/delete action.

The target application itself chooses which of its configuration vectors are published via the management messages interface, and which of those vector rows may be deleted or updated, and which fields within that row may be updated (or inserted, if row inserts are supported).

The target application is responsible for performing validation checks on the submitted values, and may decline to honor the request. It may decide to apply adjusted values, and (for inserts) may apply defaults to fields which have no requested value. The target application must report back the final row values which were updated or inserted.

The target application is responsible for applying the effects of the change, which may include immediate updates, or delayed updates.

Note that the change affects the running configuration only. The change is ephemeral, and will be lost if the application is restarted.

!MANAGEMENT-RESOURCE-OPERATION-REQUEST

The !MANAGEMENT-RESOURCE-OPERATION-REQUEST message is sent by ManageApp to any application (including itself and the WatchdogApp) in order to request an operation to be performed on a row from the application’s resource vector table.

The request fields are:

Field Type Description
resource_key String [Required] A value which matches the key of a resource vector.
operation_key String [Required] The key value of the operation to be updated.
This is the key for the column in the resource drilldown with type = operation.
resource_row_key Scalar The row key on which to perform the action.

!MANAGEMENT-RESOURCE-OPERATION-RESPONSE

The !MANAGEMENT-RESOURCE-OPERATION-RESPONSE message is returned to the ManageApp by the application to confirm or decline the requested resource row operation.

The response fields are:

Field Type Description
success 0/1 [Required] Indicates if the resource operation request was successful.
error String When success = 0, describes the reason that the request was not successful, and all subsequent fields are not present.
resource_key String [Required] Confirms the resource vector key which was provided in the request.
operation_key String [Required] Confirms the key value of the operation which was performed.
resource_row_key Scalar [Required] Confirms the resource row key on which the operation was performed.
note String An optional note that should be displayed to the administrator, e.g. describing partial success, or describing other actions which are recommended to be performed.