OBJECT

Mutation

link GraphQL Schema definition

  • type Mutation {
  • # add a new item (eg, an asset or another playlist) to a playlist
  • #
  • # Arguments
  • # _id: The _id
  • # payload: item data & where to add
  • # teamId: current team Id
  • addPlaylistItems(
  • _id: String!,
  • payload: AddPlaylistItemsInput!,
  • teamId: String
  • ): [PlaylistItem!]
  • # add a new RRule (schedule item) to a schedule
  • #
  • # Arguments
  • # force: Force to add even there's an overlap time
  • # payload: input data to add
  • # teamId: current team Id
  • addScheduleItem(
  • force: Boolean,
  • payload: AddScheduleItemInput!,
  • teamId: String
  • ): ScheduleItems
  • # clone/duplicate a playlist to a new one
  • #
  • # Arguments
  • # _id: The _id
  • # teamId: current team Id
  • clonePlaylist(_id: String!, teamId: String): Playlist
  • # clone/duplicate a schedule to a new one
  • #
  • # Arguments
  • # _id: The _id
  • # teamId: current team Id
  • cloneSchedule(_id: String!, teamId: String): Schedule
  • # Delete the objects (eg, device/asset/playlist/schedule) or groups/folders by
  • # their ids
  • #
  • # Arguments
  • # payload: input data
  • # teamId: current team Id
  • deleteObjects(payload: DeleteObjectInput!, teamId: String): Boolean!
  • # Move/change playlist items position
  • #
  • # Arguments
  • # _id: The _id
  • # payload: input data specifying which to move & from position to
  • # new position
  • # teamId: current team Id
  • movePlaylistItems(
  • _id: String!,
  • payload: MovePlaylistItemsInput!,
  • teamId: String
  • ): [PlaylistItem!]
  • # Move objects or groups (by their ids) to a new group
  • #
  • # Arguments
  • # payload: input data
  • # teamId: current team Id
  • moveToGroup(payload: MoveToGroupInput!, teamId: String): Boolean!
  • # Arguments
  • # payload: [Not documented]
  • # teamId: current team Id
  • pairDevice(payload: PairDeviceInput!, teamId: String): Device!
  • # Remove playlist items at position from the playlist
  • #
  • # Arguments
  • # _id: The _id
  • # payload: input data specifying the positions to remove
  • # teamId: current team Id
  • removePlaylistItems(
  • _id: String!,
  • payload: RemovePlaylistItemsInput!,
  • teamId: String
  • ): [PlaylistItem!]
  • # Remove schedule itemfrom the schedule
  • #
  • # Arguments
  • # payload: schedule item to remove
  • # scope: Applying scopes, remove single item or all recurring
  • # items
  • # teamId: current team Id
  • removeScheduleItem(
  • payload: RemoveScheduleItemInput!,
  • scope: APPLY_SCHEDULE_ITEM_SCOPES!,
  • teamId: String
  • ): Int!
  • # Arguments
  • # payload: [Not documented]
  • # teamId: current team Id
  • saveAccessDevice(payload: JSONObject!, teamId: String): Boolean
  • # Create or Update a file/asset
  • #
  • # Arguments
  • # payload: input data to create or update, if _id is not
  • # provided, the new one will be created, otherwise updated
  • # teamId: current team Id
  • saveAsset(payload: AssetInput!, teamId: String): Asset
  • # Create or Update a group
  • #
  • # Arguments
  • # payload: input group data, if _id is not provided, the new one
  • # will be created, otherwise updated
  • # teamId: current team Id
  • saveGroup(payload: GroupInput!, teamId: String): Group
  • # Create or Update a playlist
  • #
  • # Arguments
  • # payload: input data to create or update, if _id is not
  • # provided, the new one will be created, otherwise updated
  • # teamId: current team Id
  • savePlaylist(payload: PlaylistInput!, teamId: String): Playlist
  • # Create or Update a schedule
  • #
  • # Arguments
  • # payload: input data to create or update, if _id is not
  • # provided, the new one will be created, otherwise updated
  • # teamId: current team Id
  • saveSchedule(payload: ScheduleInput!, teamId: String): Schedule
  • # Arguments
  • # payload: [Not documented]
  • # teamId: current team Id
  • unPairDevices(payload: UnPairDeviceInput!, teamId: String): Int!
  • # Arguments
  • # _id: The _id
  • # payload: [Not documented]
  • # teamId: current team Id
  • updateDevice(_id: String!, payload: UpdateDeviceInput!, teamId: String): Device!
  • # Update/Add/Remove tags to objects (eg, device/asset/playlist/schedule)
  • #
  • # Arguments
  • # payload: input data
  • # teamId: current team Id
  • updateObjectTags(payload: UpdateObjectTagsInput!, teamId: String): Boolean!
  • # update playlist item data such as duration, transition, zoom, ...
  • #
  • # Arguments
  • # _id: The _id
  • # payload: input data to update
  • # teamId: current team Id
  • updatePlaylistItems(
  • _id: String!,
  • payload: UpdatePlaylistItemsInput!,
  • teamId: String
  • ): [PlaylistItem!]
  • # To set the account schedule default or specific schedule default
  • #
  • # Arguments
  • # payload: input data for schedule default
  • # teamId: current team Id
  • updateScheduleDefault(
  • payload: ScheduleDefaultInput!,
  • teamId: String
  • ): Boolean!
  • # update an schedule item from a schedule
  • #
  • # Arguments
  • # force: Force to update even there's an overlap time
  • # payload: [Not documented]
  • # scope: Applying scopes, single item or all recurring items
  • # teamId: current team Id
  • updateScheduleItem(
  • force: Boolean,
  • payload: UpdateScheduleItemInput!,
  • scope: APPLY_SCHEDULE_ITEM_SCOPES!,
  • teamId: String
  • ): ScheduleItems
  • }

link Require by

This element is not required by anyone