Returns an assignment.

Prev Next
Get
/assignments/{assignmentId}

A content item assigned to a specific audience to be completed within a set time period (recurring) from the point it is assigned

Security
HTTP
Type basic

To pass the authentication step you will need to provide the following:

Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received

Path parameters
assignmentId
stringRequired

The assignment ID

Example63f57d805d8ecbf46f5b5278
Responses
200

The assignment

object

A content item assigned to a specific audience

id
string

The assignment ID

Example63f8c5361b9c80d3274be7ca
audienceId
string

The audience ID

Example63f8c546a05716c51210ac81
primaryContentId
string

The content ID for the primary content

Example63f8c54a8cb9790c99de077a
alternativeContentIds
Array of string

The content IDs which can cause the assigned content to be completed

string
Example63f8c54f6f68ab3a2d60e5de
hideAlternativeContent
boolean

Whether to show or hide the alternative content

Examplefalse
completionPeriod
integer

The number of days required to complete the assignment

Example30
recurrence
integer | null

The number of days until the assignment will reoccur

Example365
isActive
boolean

Defines whether the assignment is active

Exampletrue
isDeleted
boolean

Defines whether the assignment is deleted

Examplefalse
createdAt
string (date-time) | null

An ISO8601 for the timestamp when the assignment was created

Example2021-01-01T09:00:00Z
deletedAt
string (date-time) | null

An ISO8601 for the timestamp when the assignment was deleted

Example2021-01-01T09:00:00Z
updatedAt
string (date-time) | null

An ISO8601 for the timestamp when the assignment was last modified

Example2021-01-01T09:00:00Z
401

Unauthorized

object

Unauthorized

status
number
Example401.0
error
string
ExampleUnauthorized
message
string
403

Forbidden

object

Forbidden

status
number
Example403.0
error
string
ExampleForbidden
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
404

Not Found

object

Not found

status
number
Example404.0
error
string
ExampleNot Found
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
422

Unprocessable Content

object

Unprocessable Content

status
number
Example422.0
error
string
ExampleUnprocessable Content
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
default

Internal Server Error

object

Internal Server Error

status
number
Example500.0
error
string
ExampleInternal Server Error
message
string