Callout class

The Callout class represents a remote execution that can take place before or after an operation.

Callout class APIs

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

Basic APIs


Name

HTTP
method

URI

Description

create

POST

csm/Callout

Creates a Callout object.

delete

DELETE

csm/Callout/guid

Deletes a Callout object.

get

GET

csm/Callout/guid

Retrieves a Callout object.

update

POST

csm/Callout/guid/update

Updates a Callout object.

search

POST

csm/Callout/search

Searches for Callout objects.


Operation APIs

The Callout class has no operation APIs.

Relationship APIs


Name

HTTP
method

URI

Description

relation

GET

csm/Callout/guid/accessValues

Retrieves the accessValues relationship.

relation

GET

csm/Callout/guid/calloutType

Retrieves the calloutType relationship.

relation

GET

csm/Callout/guid/parameters

Retrieves the parameters relationship.

relation

GET

csm/Callout/guid/postOperation

Retrieves the postOperation relationship.

relation

GET

csm/Callout/guid/preOperation

Retrieves the preOperation relationship.

relation

GET

csm/Callout/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Callout/guid/tags

Retrieves the tags relationship.


Callout class relationships and attributes

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

Relationships


Name

Type

Multi-
plicity

Description

accessValues

AccessAttributeValue

0..*

Access attribute values

calloutType

CalloutType

1

Type of callout

parameters

Parameter

0..*

Parameters for the callout

postOperation

ProvidedOperation

0..*

Operations that run this callout after the operation executes

preOperation

ProvidedOperation

0..*

Operations that run this callout before the operation executes

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

isNotification

Boolean

0..1

Indicates whether the callout is a notification-style callout

weight

Integer

0..1

Callout execution order weighting. Callouts execute in weight order, from highest to lowest. If an operation has multiple callouts associated with it, the callouts with lower weight values execute later in the sequence.

description

String

0..1

Text that describes the object

guid

String

1

Globally unique identifier for the object

labels

String

0..*

modifiedDate

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object


Was this page helpful? Yes No Submitting... Thank you

Comments