Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. 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

csm/Action

Creates a Action object.

delete

DELETE

csm/Action/guid

Deletes a Action object.

modify

PUT

csm/Action/guid

Modifies a Action object.

search

POST

csm/Action/search

Searches for Action objects.

Operation APIs

Name

HTTP
method

URI

Description

execute

POST

csm/Action/guid/execute

Executes a proto-typical Action

prune

POST

csm/Action/prune

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

ActionGroup

1

actionInputParams

ActionInputParam

0..*

actions

Action

0..*

actionSequence

ActionSequence

0..1

actionSequenceMember

SimpleActionSequenceMember

1

prototypeAction

Action

1

referenceActionCatalogEntry

ReferenceActionCatalogEntry

1

targetCloudObject

CloudObject

0..1

cloudClass

CloudClass

1

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

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

isPrototype

Boolean

1

isSequenced

Boolean

1

lastUpdatedTime

Date

1

status

ActionStatus

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

name

String

1

Human-readable name of the object

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments