ClientGroup [VCon IG]

Represents a customized group in the User Interface.

Properties

Property

Possible Values

Example

Description

id

string

VCR-GE

External ID of the ClientGroup.

title

string

News Ingest

Custom title of the group. Will be displayed in groiup headers in the UI.

type

string (“Pool”, “Custom”)

Pool

Whether the custom group should represent an existing pool or consist of a customizable set of lanes.

foreignId

string

 VCR-aap

If type is set to “Pool”: The external ID of the attached pool.
Otherwise: null.

lanes

ClientGroupLane[]


List of attached ClientGroupLanes.

Example JSON Snippet

{
    "id": "VCR-xd",
    "title": "Recording Pool News 1",
    "type": "Pool",
    "foreignId": "VCR-aap",
    "lanes": []
  }