OBJECT

Query

link GraphQL Schema definition

  • type Query {
  • _: Boolean
  • # The GraphQL API schema version.
  • version: String
  • # The GraphQL API build number.
  • build: String
  • # Gets all companies.
  • allCompanies: [Company]
  • # Gets a company by company ID.
  • #
  • # Arguments
  • # id: The company ID.
  • company(id: ID!): Company
  • # Gets a company by company name.
  • #
  • # Arguments
  • # name: The company name.
  • companyByName(name: String!): Company
  • # Gets all third-party stream targets associated with a provider key ID.
  • #
  • # Arguments
  • # providerKeyId: The provider key ID.
  • broadcastProviderStreamTargets(
  • providerKeyId: ID!
  • ): [BroadcastProviderStreamTargetAbreviated]
  • # Arguments
  • # providerKeyId: The provider key ID.
  • # providerId: The provider ID.
  • # providerType: The provider type.
  • broadcastProviderStreamTarget(
  • providerKeyId: ID!,
  • providerId: ID!,
  • providerType: ENUM_STREAMTARGET_PROVIDERTYPE!
  • ): BroadcastProviderStreamTarget
  • # Gets all broadcasts.
  • allBroadcasts: [Broadcast]
  • # Gets all broadcasts of a parent namespace.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • broadcastsByNamespace(namespaceId: ID!): [Broadcast]
  • # Gets a broadcast by name.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • # name: The broadcast name.
  • broadcastsByName(namespaceId: ID!, name: String!): [Broadcast]
  • # Gets all broadcasts with a given status.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • # status: Collection of broadcast statuses.
  • broadcastsByStatus(
  • namespaceId: ID!,
  • status: [ENUM_BROADCASTSTATUS]!
  • ): [Broadcast]
  • # Gets all broadcasts which are associated with a given encoder.
  • #
  • # Arguments
  • # encoderId: The encoder ID.
  • broadcastsByEncoder(encoderId: ID!): [Broadcast]
  • # Gets a broadcast by ID.
  • #
  • # Arguments
  • # id: The broadcast ID.
  • broadcast(id: ID!): Broadcast
  • # Gets all broadcast groups.
  • allBroadcastGroups: [BroadcastGroup]
  • # Gets all broadcast groups by namespace ID.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • broadcastGroupsByNamespace(namespaceId: ID!): [BroadcastGroup]
  • # Gets all broadcast groups to which the broadcast belongs.
  • #
  • # Arguments
  • # broadcastId: The broadcast ID.
  • broadcastGroupsByBroadcast(broadcastId: ID!): [BroadcastGroup]
  • # Gets a broadcast group by ID.
  • #
  • # Arguments
  • # id: The broadcast group ID.
  • broadcastGroup(id: ID!): BroadcastGroup
  • # Gets a broadcast group by name.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • # name: The broadcast group name.
  • broadcastGroupByName(namespaceId: ID!, name: String!): BroadcastGroup
  • # Gets all encoders.
  • allEncoders: [Encoder]
  • # Gets all encoders associated with a parent namespace.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • encodersByNamespace(namespaceId: ID!): [Encoder]
  • # Gets an encoder by name.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • # name: The encoder name.
  • encodersByName(namespaceId: ID!, name: String!): [Encoder]
  • # Gets all encoders with a given status.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • # status: Collection of encoder statuses.
  • encodersByStatus(namespaceId: ID!, status: [ENUM_ENCODERSTATUS]!): [Encoder]
  • # Gets an encoder by ID.
  • #
  • # Arguments
  • # id: The encoder ID.
  • encoder(id: ID!): Encoder
  • # Gets an encoder by unique device ID.
  • #
  • # Arguments
  • # deviceId: The encoder unique device ID.
  • encoderByDeviceId(deviceId: String!): Encoder
  • # Gets an encoder by serial number.
  • #
  • # Arguments
  • # serial: The encoder serial number.
  • encoderBySerial(serial: String!): Encoder
  • # Gets all encoder groups.
  • allEncoderGroups: [EncoderGroup]
  • # Gets all encoder groups by namespace ID.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • encoderGroupsByNamespace(namespaceId: ID!): [EncoderGroup]
  • # Gets all encoder groups to which an encoder belongs.
  • #
  • # Arguments
  • # encoderId: The encoder ID.
  • encoderGroupsByEncoder(encoderId: ID!): [EncoderGroup]
  • # Gets an encoder group by ID.
  • #
  • # Arguments
  • # id: The encoder group ID.
  • encoderGroup(id: ID!): EncoderGroup
  • # Gets an encoder group by name.
  • #
  • # Arguments
  • # namespaceId: The namespace ID.
  • # name: The encoder group name.
  • encoderGroupByName(namespaceId: ID!, name: String!): EncoderGroup
  • # Gets the status of an encoder command.
  • #
  • # Arguments
  • # correlationId: The correlation ID.
  • encoderCommandStatus(correlationId: 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
  • nearRealTimeDataByBroadcast(
  • broadcastId: ID!,
  • count: Int,
  • startDateTime: Long,
  • endDateTime: Long,
  • range: Int,
  • order: String
  • ): [NearRealTimeData]
  • # Gets all namespaces.
  • allNamespaces: [Namespace]
  • # Gets all namespaces of a parent company.
  • #
  • # Arguments
  • # companyId: The company ID.
  • namespacesByCompany(companyId: ID!): [Namespace]
  • # Gets a namespace by ID.
  • #
  • # Arguments
  • # id: The namespace ID.
  • namespace(id: ID!): Namespace
  • # Gets a namespace by name.
  • #
  • # Arguments
  • # companyId: The company ID.
  • # name: The name of the namespace.
  • namespaceByName(companyId: ID!, name: 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
  • broadcastGoLiveEventsByNamespace(
  • namespaceId: ID!,
  • count: Int,
  • order: String
  • ): [BroadcastGoLiveEvent]
  • # Get information about logged in identiity.
  • me: Me
  • }

link Require by

This element is not required by anyone