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.

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

Creates a Callout object.

delete

DELETE

Deletes a Callout object.

get

GET

Retrieves a Callout object.

update

POST

Updates a Callout object.

search

POST

Searches for Callout objects.


Operation APIs

The Callout class has no operation APIs.

Relationship APIs


Name

HTTP
method

URI

Description

relation

GET

Retrieves the accessValues relationship.

relation

GET

Retrieves the calloutType relationship.

relation

GET

Retrieves the parameters relationship.

relation

GET

Retrieves the postOperation relationship.

relation

GET

Retrieves the preOperation relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

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

0..*

Access attribute values

calloutType

1

Type of callout

parameters

0..*

Parameters for the callout

postOperation

0..*

Operations that run this callout after the operation executes

preOperation

0..*

Operations that run this callout before the operation executes

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

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

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*