Output Groups
GET Output Groups#
Gell all output groups
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/outputgroups |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": "string", "name": "string", "customName": "string", "type": 0, "description": "string" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the list of requested output group | |
| id | string | "string" | Returns the id of the output group |
| name | string | "string" | Returns the default name of the output group |
| customName | string | "string" | Returns the custom name of the output group provided by the user |
| type | integer($int32) | 0 | Returns the type of the output group |
| description | string | "string" | Returns the description of the output group |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Output Group#
Get an output group
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/outputgroups/{id} |
| Headers | Authorization |
| Parameters | version, projectId, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| {id} | Yes | integer($int32) | 0 | Shows the id of the output group |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
| Id | Yes | integer($int32) | 0 | Shows the id of the output group |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "name": "string", "customName": "string", "segmentControl": 0, "segmentControlOptions": [ { "id": 0, "value": "string", "enabled": true } ], "segmentLength": 0, "minSegmentLength": 0, "type": 0, "outputGroupsTypes": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 }, "typeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "categoryOptions": [ { "id": 0, "value": "string", "enabled": true } ], "hasDRM": true, "drmList": { "providers": [ { "id": 0, "name": "string" } ], "widevineAlgorithm": { "widevineId": 0, "algorithms": [ { "id": 0, "type": "string" } ] }, "rawKey": { "rawKeyId": 0, "labels": [ "string" ] } }, "groupDRM": { "shakaPackagerKeyProviderType": 0, "protectionSchemaType": 0, "protectionSchemaOptions": [ { "id": 0, "value": "string", "enabled": true } ], "encryptionAlgorithmType": 0, "label": "string", "clearLead": 0 }, "description": "string", "emptyOutputModel": { "name": "string", "nameModifier": "string", "presetId": 0, "presetName": "string", "videoCodec": "string", "audioCodec": "string" }, "outputs": [ { "name": "string", "nameModifier": "string", "presetId": 0, "presetName": "string", "videoCodec": "string", "audioCodec": "string" } ] } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the requested presets | |
| name | string | "string" | Returns the default name of the output group |
| customName | string | "string" | Returns the custom name of the output group provided by the user. It will overwrite the default name. |
| segmentControl | integer($int32) | 0 | Returns the selected segment control for the requested output group |
| segmentControlOptions | array[object] | Returns the list of options for segment control for the requested output group | |
| id | integer($int32) | 0 | Returns the id of the segment control option |
| value | string | "string" | Returns the value of the segment control type option |
| enabled | bool | false | Returns whether the segment control type option is enabled |
| segmentLength | integer($int32) | 0 | Returns the segment length for the requested output group |
| minSegmentLength | integer($int32) | 0 | Returns the minimum segment length for the requested output group |
| type | integer($int32) | 0 | Returns the selected type for the requested output group |
| outputGroupsTypes | Dictionary<string, int> | {{"string", 0},{"string", 0}} | Returns the list of options for output group type and their correspoding type |
| typeOptions | array[object] | Returns the list of options for output group type | |
| id | integer($int32) | 0 | Returns the id of the output group type option |
| value | string | "string" | Returns the value of the output group type option |
| enabled | bool | false | Returns whether the output group type option is enabled |
| categoryOptions | array[object] | Returns the list of options for category options for the requested output group | |
| id | integer($int32) | 0 | Returns the id of the category option |
| value | string | "string" | Returns the value of the category option |
| enabled | bool | false | Returns whether the category option is enabled |
| hasDRM | bool | false | Returns whether the DRM option is enabled |
| drmList | object | Returns the DRM list for the requested output group | |
| providers | array[object] | Returns the DRM provider list for the requested output group | |
| id | integer($int32) | 0 | Returns the id of the DRM provider option for the requested output group |
| name | string | "string" | Returns the name of the DRM provider option for the requested output group |
| widevineAlgorithm | object | Returns the widevine algorithm for the requested output group | |
| widevineId | integer($int32) | 0 | Returns the widevine algorithm id for the requested output group |
| algorithms | array[object] | Returns the list of encryption models of widevine algorithm for the requested output group | |
| id | integer($int32) | 0 | Returns the id of the encryption model option |
| value | string | "string" | Returns the value of the encryption model option |
| rawKey | object | Returns the DRM raw key for the requested output group | |
| rawKeyId | integer($int32) | 0 | Returns the id of the DRM raw key for the requested output group |
| labels | args[string] | {"string", "string"} | Returns the labels of the DRM raw key for the requested output group |
| groupDRM | object | Returns the group DRM for the requested output group | |
| shakaPackagerKeyProviderType | integer($int32) | 0 | Returns the Shaka Packager key provider type for the requested output group |
| protectionSchemaType | integer($int32) | 0 | Returns the selected protection schema type for the requested output group |
| protectionSchemaOptions | array[object] | Returns the list of options for protection schema type for the requested output group | |
| id | integer($int32) | 0 | Returns the id of the protection schema type option |
| value | string | "string" | Returns the value of the protection schema type option |
| enabled | bool | false | Returns whether the protection schema type option is enabled |
| encryptionAlgorithmType | integer($int32) | 0 | Returns the encryption algorithm type for the requested output group |
| label | string | "string" | Returns the group DRM label for the requested output group |
| clearLead | integer($int32) | 0 | Returns the clear lead in seconds if encryption is enabled for the requested output group |
| description | string | "string" | Returns the description for the requested output group |
| emptyOutputModel | object | Returns the empty output model | |
| name | string | "string" | Returns the default name of the empty output model |
| nameModifier | string | "string" | Returns the name of the playlist of the empty output model |
| presetId | integer($int32) | 0 | Returns the id of the preset of the empty output model |
| presetName | string | "string" | Returns the name of the preset of the empty output model |
| videoCodec | string | "string" | Returns the video codec of the empty output model |
| audioCodec | string | "string" | Returns the audio codec of the empty output model |
| outputs | array[object] | Returns the list of outputs for the requested output group | |
| name | string | "string" | Returns the default name of the output option |
| nameModifier | string | "string" | Returns the name of the playlist of the output option |
| presetId | integer($int32) | 0 | Returns the id of the preset of the output option |
| presetName | string | "string" | Returns the name of the preset of the output option |
| videoCodec | string | "string" | Returns the video codec of the output option |
| audioCodec | string | "string" | Returns the audio codec of the output option |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found