//SCHEMADocs
Console
Reference

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.

ValueMeaning
draftBeing authored through the API. Not part of the catalog.
pendingDelivered, but held back — files still missing, no cover art, or awaiting activation. Listed by blockedReleases.
activeIn the catalog.
withdrawnTaken down from this catalog.

Resource state#

Resource.state, DraftResource.state.

ValueMeaning
incomingKnown, but its file has not arrived.
storedThe file is stored and its checksum recorded.
analyzingStored; technical analysis is in progress.
failedThe file that arrived contradicts the checksum its message declared. A corrected delivery clears it.

Message status#

Message.status, StatusCount.status.

ValueMeaning
receivedArrived, not yet parsed.
parsingBeing parsed.
ingestedParsed and merged into the catalog.
partialIngested, but some referenced files have not arrived.
failedCould not be ingested; see failureReason. The original file is kept.

Delivered file outcome#

DeliveredFile.outcome. Note the camel case of hashMismatch.

ValueMeaning
promotedMatched a file a message was waiting for; the resource now has its bytes.
orphanStored, but no message is waiting for it — yet. It will match when its message arrives.
duplicateThese exact bytes had already been delivered at this path. Nothing changed.
hashMismatchMatched, but the bytes differ from the checksum the message declared. The resource is marked failed.

Viewer actor type#

Viewer.actorType.

ValueMeaning
api_keyThe request was made with an API key.
userThe 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.

ValueMeaning
ownerFull access, and may make others owners.
adminFull access.
memberEverything except config_write.

Member status#

OrgMember.status.

ValueMeaning
invitedAdded, has not signed in.
activeCan sign in.
suspendedCannot sign in until reinstated.
deactivatedCannot sign in; the account is closed.