Wire values
Fields that hold one of a fixed set of values are typed String rather than as GraphQL enums. These are the values each can take.
Compare these case-sensitively, exactly as written here. New values may be added over time — handle one you do not recognize gracefully.
DDEX values — roles, resource types, territories, commercial models — are not listed here: they come from DDEX's allowed-value sets, and vocabValues returns them. See DDEX vocabularies.
Release state#
Release.state. See Release lifecycle.
| Value | Meaning |
|---|---|
draft | Being authored through the API. Not part of the catalog. |
pending | Delivered, but held back — files still missing, no cover art, or awaiting activation. Listed by blockedReleases. |
active | In the catalog. |
withdrawn | Taken down from this catalog. |
Resource state#
Resource.state, DraftResource.state.
| Value | Meaning |
|---|---|
incoming | Known, but its file has not arrived. |
stored | The file is stored and its checksum recorded. |
analyzing | Stored; technical analysis is in progress. |
failed | The file that arrived contradicts the checksum its message declared. A corrected delivery clears it. |
Message status#
Message.status, StatusCount.status.
| Value | Meaning |
|---|---|
received | Arrived, not yet parsed. |
parsing | Being parsed. |
ingested | Parsed and merged into the catalog. |
partial | Ingested, but some referenced files have not arrived. |
failed | Could not be ingested; see failureReason. The original file is kept. |
Delivered file outcome#
DeliveredFile.outcome. Note the camel case of
hashMismatch.
| Value | Meaning |
|---|---|
promoted | Matched a file a message was waiting for; the resource now has its bytes. |
orphan | Stored, but no message is waiting for it — yet. It will match when its message arrives. |
duplicate | These exact bytes had already been delivered at this path. Nothing changed. |
hashMismatch | Matched, but the bytes differ from the checksum the message declared. The resource is marked failed. |
Viewer actor type#
| Value | Meaning |
|---|---|
api_key | The request was made with an API key. |
user | The request was made by a signed-in person. |
Scopes#
Sent to mintApiKey; returned by ApiKey.scopes and grantableScopes.
catalog_read · catalog_write · config_read · config_write ·
media_read · media_preview · media_lossless · media_write ·
usage_read · billing_read · billing_write
Viewer.scopes returns the same set spelled CatalogRead,
CatalogWrite, ConfigRead, ConfigWrite, MediaRead, MediaPreview,
MediaLossless, MediaWrite,
UsageRead, BillingRead, BillingWrite.
Member role#
OrgMember.role, AddedMember.role, grantableRoles.
| Value | Meaning |
|---|---|
owner | Full access, and may make others owners. |
admin | Full access. |
member | Everything except config_write. |
Member status#
| Value | Meaning |
|---|---|
invited | Added, has not signed in. |
active | Can sign in. |
suspended | Cannot sign in until reinstated. |
deactivated | Cannot sign in; the account is closed. |