GET Release Channel Options
Overview
The following table contains important information about the GET method in regards to receiving the release channel options.
| GET Release Channel Options | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/projects/projectId/players/options/release-channel |
| Headers | Authorization |
| Parameters | projectId |
| Body | Not Applicable |
The description of the URL parameter is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
Request Body
The request does not contain a request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 1,
"name": "v1.1",
"originalPath": "vpplayer/templates/v151/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v151/vp-player-dev.js"
},
{
"id": 2,
"name": "v1.2",
"originalPath": "vpplayer/templates/v151/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v151/vp-player-dev.js"
},
{
"id": 3,
"name": "v1.3",
"originalPath": "vpplayer/templates/v13/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v13/vp-player.js"
},
{
"id": 4,
"name": "v1.4",
"originalPath": "vpplayer/templates/v14/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v14/vp-player.js"
},
{
"id": 5,
"name": "v1.4.2",
"originalPath": "vpplayer/templates/v142/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v142/vp-player.js"
},
{
"id": 6,
"name": "v1.4.3",
"originalPath": "vpplayer/templates/v143/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v143/vp-player.js"
},
{
"id": 7,
"name": "v1.5",
"originalPath": "vpplayer/templates/v15/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v15/vp-player.js"
},
{
"id": 8,
"name": "v1.5.1",
"originalPath": "vpplayer/templates/v151/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v151/vp-player-dev.js"
},
{
"id": 9,
"name": "v1.5.2",
"originalPath": "vpplayer/templates/v152/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v152/vp-player-dev.js"
}
],
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| id | integer($int32) | The id of the release channel. |
| name | string | The name of the release channel. |
| originalPath | string | The original path of the release channel. |
| templateOriginalPath | string | The original path of the template release channel. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed