List Use Cases

Retrieve a list of campaign use cases as defined by The Campaign Registry (TCR). A use case represents the purpose of a campaign.

Endpoint

GET /v1/collections/usecases

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Request Body

None

Returns

Returns an array of use cases. The following fields are returned for each use case.

string (UUID)

Unique ID for the use case.

usecaseName

string

Use case name. Provide this as the usecase when creating a campaign.

description

string

Use case description.

displayName

string

Use case display name.

maxSubUsecases

integer (int32)

Maximum number of sub use cases required.

minSubUsecases

integer (int32)

Minimum number of sub use cases required.

validSubUsecase

boolean

Whether the use case has sub use cases.

classification

string enum, values: Standard, Special

Use case classification.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": [
    {
      "id": "7fa0db6a-bdaf-4448-baac-ed92a61accd8",
      "usecaseName": "string",
      "description": "string",
      "displayName": "string",
      "maxSubUsecases": 0,
      "minSubUsecases": 0,
      "validSubUsecase": true,
      "classification": "string"
    },
    {...},
    {...}
  ]
}