GET Encoded Video by ID

Overview

---

The following table contains important information about the GET method in regards to the encode process.

POST Method
Method	GET
URL or Endpoint	/api/projects/projectId/encodes/id
Headers	Authorization
Parameters	projectId, id
Body	Not applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.
id	Yes	string	Unique id of the encoded video.

Request Body

The request does not have a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "name",
    "callBackUrl": "string",
    "PublishStatus": "Ready",
    "videoFile": {
      "downloadUrl": null,
      "uploadPath": null,
      "progress": null,
      "jobPercentComplete": 0,
      "destination": "destination",
      "filePath": "filePath",
      "encoderStatus": "Complete",
      "outputGroups": [
        {
          "videoFileId": 21,
          "customName": "hls",
          "name": "AppleHLS",
          "uploadedPath": "hls",
          "type": 0,
          "typeDescription": null,
          "outputs": [
            {
              "name": "360p",
              "nameModifier": "index",
              "uploadedPath": "360p",
              "progress": 100,
              "status": null,
              "statusDescription": "Complete",
              "isCancelable": false,
              "outputGroupId": 41,
              "videoCodexType": null,
              "videoWidth": 0,
              "videoHeight": 0,
              "videoBitrate": 0,
              "audioCodexType": null,
              "audioBitrate": 0,
              "audioSampleRate": 0
            }
          ]
        }
      ],
      "status": null
    }
  },
  "resultInfo": null,
  "statusCode": 200
}

The description to the fields in the code are written in the table below.

Parameter Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise will return false.
errors	array[string]	Indicates whether or not there was an error.
messages	array[string]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
name	string	The unique name for the video that is being encoded.
callbackUrl	string	URL to call when encoding is finsihed.
PublishStatus	string	Status of the publishing process.
videoFile	Object	Video File Object.
downloadUrl	string	The URL of the endcoded video.
uploadPath	string	Path where video encodings are taken from.
progress	string	Progress of the process.
jobPercentComplete	integer($int32)	Percentage of the completed job.
destination	string	URL of the destination.
filePath	string	URL of the file.
encoderStatus	string	Status of encoder.
outputGroups	array[Object]	Output group array.
videoFileId	integer($int32)	Id of the video file.
customName	string	Custom name of the output group.
name	string	Name of the video.
uploadedPath	string	Uploaded Path.
type	integer($int32)	Type of the video.
typeDescription	string	Description of the type.
outputs	array[Object]	Returns the outputs as an array of objects.
name	string	Name of the output.
nameModifier	string	Modifier of the name.
uploadedPath	string	Path where uploaded.
progress	integer($int32)	Progress of the process.
status	string	Unique id of the encoded video.
id	string	Status of the process.
statusDescription	string	Description of the status.
isCancelable	bool	Value that tells if the output is cancelable or not.
outputGroupId	integer($int32)	Id of the output group.
videoCodexType	string	Type of the video codex.
id	string	Unique id of the encoded video.
videoWidth	integer($int32)	Width of the video.
videoHeight	integer($int32)	Height of the video.
videoBitrate	integer($int32)	Bitrate of the video.
audioCodexType	string	Type of the audio codex.
audioBitrate	integer($int32)	Bitrate of the audio.
audioSampleRate	integer($int32)	Rate of the audio sample.
status	string	Status of the record.
resultInfo	string	Returns extra info 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