Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Action class


Represents an activity to be performed (mostly automated) in response to a event in a context of specific target object.

Action class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the Action class.

Basic APIs

 

Name

HTTP
method

URI

Description

create

POST

Creates a Action object.

delete

DELETE

Deletes a Action object.

modify

PUT

Modifies a Action object.

search

POST

Searches for Action objects.

 

Operation APIs

 

Name

HTTP
method

URI

Description

execute

POST

Executes a proto-typical Action

prune

POST

Prunes Action older than specified date. This deletes the instance Actions only and not proto-typical Actions, which are in use.

 

Relationship APIs

The Action class has no relationship APIs.

Action class relationships and attributes

The following tables list the relationships and attributes of the Action class.

Relationships

 

Name

Type

Multi-
plicity

Description

actionGroup

1

 

actionInputParams

0..*

 

actions

0..*

 

actionSequence

0..1

 

actionSequenceMember

1

 

prototypeAction

1

 

referenceActionCatalogEntry

1

 

targetCloudObject

0..1

 

tickets

0..*

 

cloudClass

1

Fully-qualified name of the class to which the object belongs

provider

1

Provider that created the object

tags

0..*

Tags associated with the object

 

Attributes

 

Name

Type

Multi-
plicity

Description

isPrototype
Boolean

1

 

isSequenced
Boolean

1

 

lastUpdatedTime

1

 

status

1

 

userName
String

1

 

externalID
String

0..1

Identifier used for the object by an external provider

owner
String

0..1

Name of the owner of the object

reconciliationID
String

0..1

Reconciliation identity value for the object from the BMC Atrium CMDB

tokenID
String

0..1

Token identifier

description
String

0..1

Text that describes the object

guid
String

1

Globally unique identifier for the object

labels
String

0..*

 

modifiedDate

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*