Enums

Enums (or enumerations) define a certain set of values or entries for a field. They help filter down your results and can contain alphanumeric characters and underscores. For example, AssetType defines the type of asset you'd like to query.

Assets

AssetPublishStatus

Available publish status for asset

Value	Description
COMPLETED
FAILED
WAITING

AssetStatus

Available status for asset

Value	Description
ACTIVE
DELETED
EXPIRED

AssetType

Available types for asset creation

Value	Description
IMAGE
VIDEO
SET
SPIN
DOCUMENT
TEXT

MagicEraseImageJobStatus

Value	Description
CREATED
PENDING
SUCCESS
FAILED

SearchableFields

Available fields to search

Value	Description
NAME
LABEL
FILENAME
TAGS
TAGS_CASE_SENSITIVE
MIME_TYPE
CONTENTS

SortDirection

The direction in which to sort a given field

Value	Description
ASC
DESC

CMS

CMSHubPermission

Value	Description
READ
UPDATE
CREATE_WORKFLOW_STATE
UPDATE_WORKFLOW_STATE
MANAGE_VSE_ACCESS
ASSIGN_MEMBER_ROLE
UNASSIGN_MEMBER_ROLE
ASSIGN_TEAM_ROLE
UNASSIGN_TEAM_ROLE
REGISTER_CONTENT_TYPE
UPDATE_CONTENT_TYPE
ARCHIVE_CONTENT_TYPE
UNARCHIVE_CONTENT_TYPE
DELETE_CONTENT_TYPE
CREATE_CONTENT_TYPE_SCHEMA
UPDATE_CONTENT_TYPE_SCHEMA
VALIDATE_CONTENT_TYPE_SCHEMA
ARCHIVE_CONTENT_TYPE_SCHEMA
UNARCHIVE_CONTENT_TYPE_SCHEMA
CREATE_WEBHOOK
UPDATE_WEBHOOK
DELETE_WEBHOOK
TRIGGER_WEBHOOK
READ_WEBHOOKS
CREATE_EXTENSION
UPDATE_EXTENSION
DELETE_EXTENSION
CREATE_ALGOLIA_INDEX
UPDATE_ALGOLIA_INDEX
DELETE_ALGOLIA_INDEX
LIST_INTEGRATION_TYPES
CREATE_SFCC_INTEGRATION
UPDATE_SFCC_INTEGRATION
DELETE_SFCC_INTEGRATION
LIST_SFCC_INTEGRATIONS
CREATE_SFMC_INTEGRATION
UPDATE_SFMC_INTEGRATION
DELETE_SFMC_INTEGRATION
CREATE_EVENT
UPDATE_EVENT
DELETE_EVENT
CREATE_EDITION
UPDATE_EDITION
DELETE_EDITION
SCHEDULE_EDITION
UNSCHEDULE_EDITION
CREATE_PREVIEW_EDITION
DELETE_PREVIEW_EDITION
RESOLVE_EDITION_CONFLICT
CREATE_EDITION_CONTENTS
UPDATE_EDITION_CONTENTS
UPDATE_EDITION_CONTENTS_CONTENT
UPDATE_EDITION_SLOT
UPDATE_EDITION_SLOT_CONTENT
DISASSOCIATE_SLOT_FROM_EDITION
ASSOCIATE_SLOT_TO_EDITION
COPY_EDITION_SLOT
UPDATE_PUBLISHING_JOB
CREATE_PUBLISHING_JOB
CREATE_SNAPSHOT
CREATE_SNAPSHOT_EDITION_LINK
UPDATE_SNAPSHOT_EDITION_LINK
DELETE_SNAPSHOT_EDITION_LINK
VALIDATE_CONTENT
CREATE_COMMERCE_REPOSITORY
UPDATE_COMMERCE_REPOSITORY
DELETE_COMMERCE_REPOSITORY
CREATE_CONTENT_GENERATION_ENTITY
DELETE_CONTENT_GENERATION_ENTITY
UPDATE_CONTENT_GENERATION_ENTITY
TOGGLE_CONTENT_GENERATION_MODEL
GENERATE_CONTENT
UPDATE_CONTENT_GENERATION_SESSION
DELETE_CONTENT_GENERATION_SESSION
CREATE_CONTENT_GENERATION_EXAMPLE
UPDATE_CONTENT_GENERATION_EXAMPLE
DELETE_CONTENT_GENERATION_EXAMPLE
CREATE_CONTENT_GENERATION_EXAMPLE_FOLDER
UPDATE_CONTENT_GENERATION_EXAMPLE_FOLDER
DELETE_CONTENT_GENERATION_EXAMPLE_FOLDER
CREATE_CONTENT_GENERATION_BRIEF_TEMPLATE
UPDATE_CONTENT_GENERATION_BRIEF_TEMPLATE
DELETE_CONTENT_GENERATION_BRIEF_TEMPLATE
CREATE_CONTENT_FLOW
UPDATE_CONTENT_FLOW
DELETE_CONTENT_FLOW
RUN_CONTENT_FLOW
TEST_CONTENT_FLOW
CREATE_CONTENT_REVIEW
CREATE_ACTION_EXTENSION
UPDATE_ACTION_EXTENSION
DELETE_ACTION_EXTENSION
PUBLISH_ACTION_EXTENSION
CREATE_ACTION_EXTENSION_RELEASE
UPDATE_ACTION_EXTENSION_RELEASE
DELETE_ACTION_EXTENSION_RELEASE
PUBLISH_ACTION_EXTENSION_RELEASE
CREATE_ACTION_EXTENSION_INSTANCE
UPDATE_ACTION_EXTENSION_INSTANCE
DELETE_ACTION_EXTENSION_INSTANCE

CMSHubRole

Value	Description
MEMBER
ADMIN
DEVELOPER
PUBLISHER
AUTHOR
NONE

CMSHubStatus

Value	Description
ACTIVE
ARCHIVED
DELETED

CMSRepositoryPermission

Value	Description
READ
READ_CONTENT
ASSIGN_MEMBER_ROLE
UNASSIGN_MEMBER_ROLE
ASSIGN_TEAM_ROLE
UNASSIGN_TEAM_ROLE
ASSIGN_CONTENT_TYPE
UNASSIGN_CONTENT_TYPE
UPDATE
ADD_FEATURE
REMOVE_FEATURE
SET_ITEM_LOCALES
JOIN_LOCALIZATION_GROUP
PUBLISH_CONTENT
CREATE_DELIVERY_KEY
CREATE_CONTENT
UPDATE_CONTENT
RESTORE_CONTENT
UNARCHIVE_CONTENT
ARCHIVE_CONTENT
LOCALIZE_CONTENT
CREATE_LOCALIZATION
UPDATE_CONTENT_ITEM_WORKFLOW
CREATE_FOLDER
DELETE_FOLDER
UPDATE_FOLDER

CMSRepositoryRole

Value	Description
MEMBER
ADMIN
DEVELOPER
PUBLISHER
AUTHOR
NONE

CMSRepositoryStatus

Value	Description
ACTIVE
ARCHIVED
DELETED

HubRole

Value	Description
MEMBER
ADMIN
DEVELOPER
PUBLISHER
AUTHOR
NONE

RepositoryRole

Value	Description
MEMBER
ADMIN
DEVELOPER
PUBLISHER
AUTHOR
NONE

Content generation

ContentGenerationBrandVoiceLocale

Value	Description
en_US
en_GB
fr_FR
de_DE
es_ES
it_IT
pt_PT

ContentGenerationBriefTemplateStatus

Value	Description
ACTIVE
PREVIEW

ContentGenerationBriefTemplateTextFieldFormat

Value	Description
SINGLE_LINE
MULTI_LINE
MARKDOWN

ContentGenerationJobStatusCode

Value	Description
SUBMITTED
INSUFFICIENT_CREDITS
ERROR
COMPLETE

ContentGenerationModelLifecycleStage

Value	Description
LABS
SUPPORTED
LEGACY
RETIRED

ContentGenerationSessionMessageAuthorRole

Value	Description
SYSTEM
USER
ASSISTANT

ContentGenerationSessionMessageScore

Value	Description
POSITIVE
NEGATIVE

ContentGenerationSessionMessageStatus

Value	Description
PENDING
GENERATING
COMPLETED
INTERRUPTED
SUBMITTED

GenerateImagesFromTextModel

Value	Description
DALL_E_2
DALL_E_3

RichTextGenerationRole

Value	Description
USER
ASSISTANT
SYSTEM
FUNCTION

Content flow

ContentFlowRunStatus

Value	Description
QUEUED
RUNNING
PAUSED
COMPLETE
ABORTED
EXPIRED
FAILED

WorkflowStatus

Asset workflow status

Value	Description
DRAFT
ARCHIVED
IN_REVIEW
REJECTED
APPROVED

ContentFlowStatus

Value	Description
ENABLED
DISABLED
QUARANTINED

Content review

ContentReviewTaskStatus

Value	Description
OPEN
COMPLETED
CANCELLED
EXPIRED

ContentReviewType

Value	Description
APPROVAL
REJECTED
COMMENT
SUGGESTION

ContentReviewTaskSortKey

Primary sort keys for ContentReviewTask listings, used in conjunction with SortOrder to define the sort order of the listing. Secondary sorts are applied for id ascending to ensure a stable sort

Value	Description
CREATED_DATE
EXPIRY_DATE
DUE_DATE

ContentReviewTaskFacetName

Value	Description
STATUS
REVIEWER
ATTRIBUTE

SortOrder

The direction to sort results in. Used in conjunction with a service-specific sort key enum.

Value	Description
ASC	Sort results in ascending order (A→Z, oldest→newest, lowest→highest).
DESC	Sort results in descending order (Z→A, newest→oldest, highest→lowest).

Extensions

ExtensionVisibility

Value	Description
PRIVATE
PUBLIC
UNLISTED

Organization & users

EntitlementValueType

Value	Description
boolean
string
number
date

OrganizationPermission

Value	Description
READ
INVITE_USER
REMOVE_USER
ASSIGN_MEMBER_ROLE
UNASSIGN_MEMBER_ROLE
UPDATE_INVITATION
REVOKE_INVITATION
CREATE_TEAM
CREATE_DEFAULT_TEAM
UPDATE_DEFAULT_TEAM
UPDATE_TEAM
DELETE_TEAM
ASSIGN_TEAM_ROLE
UNASSIGN_TEAM_ROLE
ADD_USER_TO_TEAM
REMOVE_USER_FROM_TEAM
CREATE_PERSONAL_ACCESS_TOKEN
APPROVE_PERSONAL_ACCESS_TOKEN
REQUEST_PERSONAL_ACCESS_TOKEN
DELETE_PERSONAL_ACCESS_TOKEN
READ_PERSONAL_ACCESS_TOKEN
CREATE_VSE_PREVIEW_KEY
READ_VSE_PREVIEW_KEY
UPDATE_VSE_PREVIEW_KEY
DELETE_VSE_PREVIEW_KEY

OrganizationRole

Value	Description
MEMBER
ADMIN

Webhooks

WebhookListenerSecurityHMACAlgorithm

Value	Description
SHA1
SHA256
SHA384
SHA512

WebhookListenerSecurityHMACEncoding

Value	Description
HEX
BASE64

Other

ReportFormat

Value	Description
CSV
JSON