OBJECT
Query
link GraphQL Schema definition
- type Query {
- Boolean :
- # The GraphQL API schema version.
- String :
- # The GraphQL API build number.
- String :
- # Gets all companies.
- Company] : [
- # Gets a company by company ID.
- #
- # Arguments
- # id: The company ID.
- ID!): Company ( :
- # Gets a company by company name.
- #
- # Arguments
- # name: The company name.
- String!): Company ( :
- # Gets all third-party stream targets associated with a provider key ID.
- #
- # Arguments
- # providerKeyId: The provider key ID.
- (
- ID! :
- ): [BroadcastProviderStreamTargetAbreviated]
- # Arguments
- # providerKeyId: The provider key ID.
- # providerId: The provider ID.
- # providerType: The provider type.
- (
- ID!, :
- ID!, :
- ENUM_STREAMTARGET_PROVIDERTYPE! :
- ): BroadcastProviderStreamTarget
- # Gets all broadcasts.
- Broadcast] : [
- # Gets all broadcasts of a parent namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- ID!): [Broadcast] ( :
- # Gets a broadcast by name.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # name: The broadcast name.
- ID!, : String!): [Broadcast] ( :
- # Gets all broadcasts with a given status.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # status: Collection of broadcast statuses.
- (
- ID!, :
- ENUM_BROADCASTSTATUS]! : [
- ): [Broadcast]
- # Gets all broadcasts which are associated with a given encoder.
- #
- # Arguments
- # encoderId: The encoder ID.
- ID!): [Broadcast] ( :
- # Gets a broadcast by ID.
- #
- # Arguments
- # id: The broadcast ID.
- ID!): Broadcast ( :
- # Gets all broadcast groups.
- BroadcastGroup] : [
- # Gets all broadcast groups by namespace ID.
- #
- # Arguments
- # namespaceId: The namespace ID.
- ID!): [BroadcastGroup] ( :
- # Gets all broadcast groups to which the broadcast belongs.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- ID!): [BroadcastGroup] ( :
- # Gets a broadcast group by ID.
- #
- # Arguments
- # id: The broadcast group ID.
- ID!): BroadcastGroup ( :
- # Gets a broadcast group by name.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # name: The broadcast group name.
- ID!, : String!): BroadcastGroup ( :
- # Gets all encoders.
- Encoder] : [
- # Gets all encoders associated with a parent namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- ID!): [Encoder] ( :
- # Gets an encoder by name.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # name: The encoder name.
- ID!, : String!): [Encoder] ( :
- # Gets all encoders with a given status.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # status: Collection of encoder statuses.
- ID!, : [ENUM_ENCODERSTATUS]!): [Encoder] ( :
- # Gets an encoder by ID.
- #
- # Arguments
- # id: The encoder ID.
- ID!): Encoder ( :
- # Gets an encoder by unique device ID.
- #
- # Arguments
- # deviceId: The encoder unique device ID.
- String!): Encoder ( :
- # Gets an encoder by serial number.
- #
- # Arguments
- # serial: The encoder serial number.
- String!): Encoder ( :
- # Gets all encoder groups.
- EncoderGroup] : [
- # Gets all encoder groups by namespace ID.
- #
- # Arguments
- # namespaceId: The namespace ID.
- ID!): [EncoderGroup] ( :
- # Gets all encoder groups to which an encoder belongs.
- #
- # Arguments
- # encoderId: The encoder ID.
- ID!): [EncoderGroup] ( :
- # Gets an encoder group by ID.
- #
- # Arguments
- # id: The encoder group ID.
- ID!): EncoderGroup ( :
- # Gets an encoder group by name.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # name: The encoder group name.
- ID!, : String!): EncoderGroup ( :
- # Gets the status of an encoder command.
- #
- # Arguments
- # correlationId: The correlation ID.
- String!): EncoderCommandStatus ( :
- # Gets five minutes of near real-time data by broadcast.
- #
- # Arguments
- # broadcastId: The broadcast ID.
- # count: The number of near real-time data records returned. The
- # default value is 30. Valid values range from 1 to 30.
- # startDateTime: The start date and time for near real-time data
- # records, in milliseconds since the EPOCH.
- # endDateTime: The end date and time for near real-time data
- # records, in milliseconds since the EPOCH.
- # range: The time range of near real-time data records, in
- # milliseconds. The default value is 300000 (5 minutes). Valid values range from 1
- # to 300000.
- # order: The order of the nearRealTimeData collection, sorted by
- # eventTime. The default value is desc. Valid values: desc, asc
- (
- ID!, :
- Int, :
- Long, :
- Long, :
- Int, :
- String :
- ): [NearRealTimeData]
- # Gets all namespaces.
- Namespace] : [
- # Gets all namespaces of a parent company.
- #
- # Arguments
- # companyId: The company ID.
- ID!): [Namespace] ( :
- # Gets a namespace by ID.
- #
- # Arguments
- # id: The namespace ID.
- ID!): Namespace ( :
- # Gets a namespace by name.
- #
- # Arguments
- # companyId: The company ID.
- # name: The name of the namespace.
- ID!, : String!): Namespace ( :
- # Gets all broadcast go live events by namespace.
- #
- # Arguments
- # namespaceId: The namespace ID.
- # count: The number of events to return. The default value is
- # 100.
- # order: The order of broadcast go live events, sorted by start
- # time. The default value is desc. Valid values: desc, asc
- (
- ID!, :
- Int, :
- String :
- ): [BroadcastGoLiveEvent]
- # Get information about logged in identiity.
- Me :
- }
link Require by
This element is not required by anyone