CdpActivation Class

Get, create, update, and delete Data 360 activations.

Namespace

ConnectApi

CdpActivation Methods

These methods are for CdpActivation. All methods are static.

getActivations()

Get activations.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.ActivationCollection getActivations()

Return Value

Type: ConnectApi.ActivationCollection

getActivationsPaginated(batchSize, offset, orderBy, filters)

Get a paginated list of activations.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.ActivationCollection getActivationsPaginated(Integer batchSize, Integer offset, String orderBy, String filters)

Parameters

batchSize
Type: Integer
Number of results to return. Values are from 1 through 200. If unspecified, the default value is 20.
offset
Type: Integer
Number of rows to skip before returning results. Must be greater than or equal to 0. If unspecified, no rows are skipped.
orderBy
Type: String
Specify createdDate to sort results by creation date. If unspecified, items are returned by ID in ascending order.
filters
Type: String
Filter the result set to a more narrow scope or specific type. These filters are supported:
  • name (field name: name; description: name of the activation)
  • marketSegmentId (field name: segmentId; description: segment ID of the activation)
  • activationTargetId (field name: activationTarget.id; description: activation target ID of the activation)
  • activationRefreshType (field name: refreshType; description: refresh type of the activation; example: incremental)
  • activationStatus (field name: status; description: status of the activation, which accepts only the values in the status response field; example: active)

Return Value

Type: ConnectApi.ActivationCollection

createActivation(input)

Create an activation.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.Activation createActivation(ConnectApi.ActivationDefinitionInput input)

Parameters

input
Type: ConnectApi.ActivationDefinitionInput
Input representation for an activation.

Return Value

Type: ConnectApi.Activation

deleteActivation(activationId)

Delete an activation.

API Version

Before deleting an activation, ensure there are no downstream systems that expect data from it. After you delete an activation, Data 360 stops sending data to any downstream systems that are associated with the deleted activation. To identify the downstream system (activation target) that's associated with the activation, use the getActivation(activationId) resource. It provides the activation target details needed to evaluate the impact before deleting the activation.

Note

60.0

Requires Chatter

No

Signature

public static Void deleteActivation(String activationId)

Parameters

activationId
Type: String
The unique identifier (ID) or developer name of a specific activation target.

Return Value

Type: Void

getActivation(activationId)

Get an activation by ID.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.Activation getActivation(String activationId)

Parameters

activationId
Type: String
The unique identifier (ID) or developer name of a specific activation target.

Return Value

Type: ConnectApi.Activation

updateActivation(activationId, input)

Update an activation by ID.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.Activation updateActivation(String activationId, ConnectApi.ActivationDefinitionInput input)

Parameters

activationId
Type: String
The unique identifier (ID) or developer name of a specific activation target.
input
Type: ConnectApi.ActivationDefinitionInput
Input representation for an activation.

Return Value

Type: ConnectApi.Activation