Skip to main content
Skip table of contents

Action

The action object stores a circumstance that requires user action. Currently, it is used for problems during the pre check of recurrences' virtual chunks (see Recurrence). But in the near future, other cases will follow.

Properties

Property

Possible Values

Example

Description

id

String

0B

External ID of the action

affectedObjectId

String

vid/Jr/ynP3w2

External ID of the object a user action is required for

affectedObjectType

String

(“VirtualChunk”)

VirtualChunk

Type of the object referred by affectedObjectId

resolved

String

(“NotResolved”, “ResolvedByUser”, “ResolvedAutomatically”)

NotResolved

Indicates weather this problem is resolved (a.k.a. no user action is needed anymore) and if it is resolved by a user action or by an automatic action of the system

actionCode

Integer

460

Status code that describes the reason, user action is necessary. For example in case of a virtual chunk collision the error code thrown by the pre check is stored here.

actionMessage

String

Commands cannot be scheduled due to blocked devices

Message that describes the reason, user action is necessary. For example in case of virtual chunk collision the error message thrown by the pre check is stored here.

Example JSON Snippet

JSON
  {
    "id": "GD",
    "affectedObjectId": "vid/Jr/ynP3w2",
    "affectedObjectType": "VirtualChunk",
    "actionType": "VirtualChunkCollision",
    "resolved": "NotResolved",
    "actionCode": 460,
    "actionMessage": "Commands cannot be scheduled due to blocked devices!"
  }

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.