GraphQL Repositoriesmedia

`entities.media`

Read media records with the media repository, and change them with the media mutations. Same records as the REST Medias entity.

5 queries
3 mutations
REST: Medias

Example: first three media recordsGraphQLcURL

query FirstMedias {
  entities {
    media {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstMedias { entities { media { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { media { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	MediaEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[MediaEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: MediaFilterInput, orderBy: [MediaOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[MediaEntity!]!
QUERY	`getByCriteria`(filter: MediaFilterInput, orderBy: [MediaOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	MediaEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`updateMedia`(input: UpdateMediaInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateMediaPayload
MUTATION	`bulkUpdateMedia`(input: [CreateOrUpdateMediaInput!]!, deleteInput: [DeleteMediaInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateMediaPayload
MUTATION	`deleteMedia`(input: DeleteMediaInput!)	Soft-delete	DeleteMediaPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

MediaEntity object 25 fields: isDeleteProtected, id, isDeleted, …

Recording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`appointment`	AppointmentEntity	Appointment this media is attached to. Set when activityId resolves to an Appointment.
`task`	TaskEntity	Task this media is attached to. Set when activityId resolves to a Task.
`call`	CallEntity	Call this media belongs to (e.g. a recording or transcription).
`activityId`	ID	Id of the linked appointment or task, or empty when not linked to an activity.
`callId`	ID	Id of the linked call, or empty when not linked.
`data`	JSONString	Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object.
`description`	String	Free-text description of the media.
`errorCode`	Int	Error code reported by the calling/recording provider when processing failed; empty on success.
`status`	MediaStatusEnum	Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode.
`type`	MediaTypeEnum	Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set.
`revision`	Int	Revision when entity was lastly changed.
`audioId`	UUID	Id of the cloud object holding the audio recording, when available.
`transcriptionFileId`	UUID	Id of the cloud object holding the transcription payload, when available.
`transcriptionId`	String	External transcription identifier from the calling provider.
`transcriptionLanguage`	String	Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US", "de-DE"). Set when the transcription was requested.
`transcriptionSummary`	String	AI-generated summary of the transcription content.
`getTranscriptionViewerToken`	String!	Short-lived token for opening the transcription in the calling provider's viewer. Empty when no transcription is available.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.
`audio`	CloudObjectEntity	Audio recording (MP3 file) of the media or of the call it belongs to; empty when none is stored.
`transcriptionFile`	CloudObjectEntity	Transcription (JSON file) of the media or of the call it belongs to; empty when none is stored.

MediaEntityConnection object pageInfo: PageInfo!, edges: [MediaEntityEdge]!, totalCount: Int

Paginated list of Media records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[MediaEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

MediaEntityEdge object node: MediaEntity, cursor: String!

A Relay edge containing a MediaEntity and its cursor.

Field	Type	Description
`node`	MediaEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

MediaFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for Media records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[MediaFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[MediaFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	MediaFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`activityId`	EntityFilterStringField	Id of the linked appointment or task, or empty when not linked to an activity.
`callId`	EntityFilterStringField	Id of the linked call, or empty when not linked.
`description`	EntityFilterStringField	Free-text description of the media.
`errorCode`	EntityFilterNumberField	Error code reported by the calling/recording provider when processing failed; empty on success.
`status`	MediaStatusEnumFilterInput	Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode.
`type`	MediaTypeEnumFilterInput	Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`appointment`	AppointmentFilterInput	Appointment this media is attached to. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions.
`task`	TaskFilterInput	Task this media is attached to. Set when activityId resolves to a Task. Matches records where a related record meets these conditions.
`call`	CallFilterInput	Call this media belongs to (e.g. a recording or transcription). Matches records where a related record meets these conditions.

MediaOrderByInput input Asc or Desc per field

Sorting of Media records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`appointment`	[AppointmentOrderByNestedInput!]	Appointment this media is attached to. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority.
`task`	[TaskOrderByNestedInput!]	Task this media is attached to. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority.
`call`	[CallOrderByNestedInput!]	Call this media belongs to (e.g. a recording or transcription). Sorts by fields of the related record, listed in order of priority.
`activityId`	OrderByEnum	Id of the linked appointment or task, or empty when not linked to an activity.
`callId`	OrderByEnum	Id of the linked call, or empty when not linked.
`description`	OrderByEnum	Free-text description of the media.
`errorCode`	OrderByEnum	Error code reported by the calling/recording provider when processing failed; empty on success.
`revision`	OrderByEnum	Revision when entity was lastly changed.

MediaStatusEnumFilterInput input eq: [MediaStatusEnum!], NOT: MediaStatusEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[MediaStatusEnum!]	Matches any of the listed values.
`NOT`	MediaStatusEnumFilterInput	Matches values that do not meet this condition.

MediaTypeEnumFilterInput input eq: [MediaTypeEnum!], NOT: MediaTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[MediaTypeEnum!]	Matches any of the listed values.
`NOT`	MediaTypeEnumFilterInput	Matches values that do not meet this condition.

CreateOrUpdateMediaInput input 12 fields: clientMutationId, id, modified, …

Field values of a Media record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`activityId`	ID	Id of the linked appointment or task, or empty when not linked to an activity.
`callId`	ID	Id of the linked call, or empty when not linked.
`data`	JSONString	Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object.
`description`	String	Free-text description of the media.
`errorCode`	Int	Error code reported by the calling/recording provider when processing failed; empty on success.
`status`	MediaStatusEnum	Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode.
`type`	MediaTypeEnum	Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set.
`revision`	Int	Revision when entity was lastly changed.

DeleteMediaInput input clientMutationId: String, id: ID!, activityId: ID

Id of the Media record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`activityId`	ID	Id of the linked appointment or task, or empty when not linked to an activity.

UpdateMediaInput input 12 fields: clientMutationId, id, modified, …

Id of a Media record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`activityId`	ID	Id of the linked appointment or task, or empty when not linked to an activity.
`callId`	ID	Id of the linked call, or empty when not linked.
`data`	JSONString	Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object.
`description`	String	Free-text description of the media.
`errorCode`	Int	Error code reported by the calling/recording provider when processing failed; empty on success.
`status`	MediaStatusEnum	Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check errorCode.
`type`	MediaTypeEnum	Kind of media. Recordings created by the application, uploaded or from calls, are Transcription: an audio or video recording transcribed to text; Audio and Video are currently not set.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateMediaPayload object result: BulkUpdateResults!

Result of the bulkUpdateMedia mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

DeleteMediaPayload object media: MediaEntity, clientMutationId: String

Result of the deleteMedia mutation.

Field	Type	Description
`media`	MediaEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateMediaPayload object media: MediaEntity, clientMutationId: String

Result of the updateMedia mutation.

Field	Type	Description
`media`	MediaEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

MediaStatusEnum enum NoRecording, Uploading, Uploaded, Transcoding, TranscriptionInProgress, TranscriptionCompleted

Processing status of a media recording and its transcription.

Value	Description
`NoRecording`	No recording is attached yet.
`Uploading`	The recording is being uploaded.
`Uploaded`	The recording is available and waiting for transcription.
`Transcoding`	The recording is being converted to a format suitable for transcription.
`TranscriptionInProgress`	The recording is being transcribed.
`TranscriptionCompleted`	Transcription finished; check errorCode to see whether it failed.

MediaTypeEnum enum Audio, Video, Transcription

Kind of media record.

Value	Description
`Audio`	Audio recording.
`Video`	Video recording.
`Transcription`	Recording that is transcribed to text.