Templates
GET Templates#
Get all templates.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobtemplates |
| Headers | Authorization |
| Parameters | version, projectId, pageIndex, pageSize, type, search, category |
| 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 | string($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 | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| PageIndex | No | integer($int32) | 1 | Enter the page index, from which page you want to see jobs |
| PageSize | No | integer($int32) | 10 | Enter how many pages you want to list from page index you selected |
| Type | No | integer($int32) | 0 | Shows the type of template |
| Search | No | string | "string" | Shows the substring that must match the template name |
| Category | No | string | "string" | Shows the category of the template |
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": 0, "name": "string", "jobTemplateType": 0, "category": "string", "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 templates object | |
| id | integer($int32) | 0 | Returns the id of the template |
| name | string | "string" | Returns the name of the template |
| jobTemplateType | int | 0 | Returns the type of the template. For example 0 for system templates or 1 for custom templates |
| category | string | "string" | Returns the category of the template |
| description | string | "string" | Returns the description of the template |
| 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
POST Template#
Create a template.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobtemplates |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | {name, category, description, liveJobTemplate, projectId, groups[]{name, customName, segmentControl, segmentLength, minSegmentLength, type, description, hasDRM, groupDrm{shakaPackagerKeyProviderType, protectionSchemaType, encryptionAlgorithmType, label, clearLead}, outputs[]{name, nameModifier, extension, presetId}}} |
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($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
Request body#
{ "name": "string", "category": "string", "description": "string", "liveJobTemplate": false, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "groups": [ { "name": "string", "customName": "string", "segmentControl": 0, "segmentLength": 0, "minSegmentLength": 0, "type": 0, "description": "string", "hasDRM": false, "groupDrm": { "shakaPackagerKeyProviderType": 0, "protectionSchemaType": 0, "encryptionAlgorithmType": 0, "label": "string", "clearLead": 0 }, "outputs": [ { "name": "string", "nameModifier": "string", "extension": "string", "presetId": 0 } ] } ]}
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | It specifies the name for the template to be created |
| category | No | string | "string" | It specifies the category for the template to be created |
| description | No | string | "string" | It specifies the description for the template to be created |
| liveJobTemplate | Yes | bool | false | It specifies whether the template is made for job or live job |
| projectId | Yes | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | It specifies the project id for the template to be created |
| groups | Yes | array[object] | It specifies the list of output groups that will be used by the template | |
| name | Yes | string | "string" | It specifies the default name for the specific output group |
| customName | Yes | string | "string" | It specifies the custom name for the specific output group provided by the user |
| segmentControl | Yes | integer($int32) | 0 | It specifies the segment control for the transcoded segments |
| segmentLength | Yes | integer($int32) | 0 | It specifies the segment length for the transcoded segments |
| minSegmentLength | Yes | integer($int32) | 0 | It specifies the minimum segment length for the transcoded segments |
| type | Yes | integer($int32) | 0 | It specifies the output group type such as File Group, Apple HLS or DASH ISO |
| description | No | string | "string" | It specifies the description for the output group |
| hasDRM | Yes | bool | false | It specifies whether the DRM iss enabled or not |
| groupDrm | Yes | object | It specifies the group DRM properties | |
| shakaPackagerKeyProviderType | Yes | integer($int32) | 0 | It specifies the Shaka Packeger Key Provider Id |
| protectionSchemaType | Yes | integer($int32) | 0 | It specifies the Protection Schema Type Id |
| label | Yes | string | "string" | It specifies the label for the group DRM |
| clearLead | Yes | integer($int32) | 0 | It specifies the clear lead in seconds if encryption is enabled |
| outputs | Yes | array[object] | It specifies the list of the outputs in regard to the template | |
| name | Yes | string | "string" | It specifies the folder name for the output files to be located |
| nameModifier | Yes | string | "string" | It specifies the name of the playlist |
| presetId | Yes | integer($int32) | 0 | It specifies the id of the preset for the output group |
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": 0, "name": "string", "category": "string", "description": "string", "liveJobTemplate": true, "jobTemplateType": 0, "jobTemplateTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": 0, "segmentControlOptions": [ { "id": 0, "value": "string", "enabled": true } ], "segmentLength": 0, "minSegmentLength": 0, "type": 0, "outputGroupsTypes": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 }, "typeDescription": "string", "description": "string", "groupDRM": { "shakaPackagerKeyProviderType": 0, "protectionSchemaType": 0, "protectionSchemaOptions": [ { "id": 0, "value": "string", "enabled": true } ], "encryptionAlgorithmType": 0, "label": "string", "clearLead": 0 }, "drmList": { "providers": [ { "id": 0, "name": "string" } ], "widevineAlgorithm": { "widevineId": 0, "algorithms": [ { "id": 0, "type": "string" } ] }, "rawKey": { "rawKeyId": 0, "labels": [ "string" ] } }, "hasDRM": true, "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 }}| Body Parameter Name | Mandatory | 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 live job | ||
| id | integer($int32) | 0 | Returns the id of the created template | |
| name | string | "string" | Returns the name of the created template | |
| category | string | "string" | Returns the category of the created template | |
| description | string | "string" | Returns the description of the created template | |
| liveJobTemplate | bool | false | Returns true if the template is used for live jobs or false if used for jobs | |
| jobTemplateType | integer($int32) | 0 | Returns the selected template type for the created template | |
| jobTemplateTypeOptions | array[object] | Returns the list of template type options | ||
| id | integer($int32) | 0 | Returns the id of the template type option | |
| value | string | "string" | Returns the value of the template type option | |
| enabled | bool | false | Returns whether the template type option is enabled | |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id for the created template | |
| groups | array[object] | Returns the list of output groups in regard to the created template | ||
| name | string | "string" | Returns the default name of the encoding group | |
| customName | string | "string" | Returns the name of the encoding group provided by the user. It will overwrite the default name | |
| uploadedPath | string | "string" | Returns the uploaded path of the encoding group | |
| segmentControl | integer($int32) | 0 | Returns the selected segment control for the created template | |
| segmentControlOptions | array[object] | Returns the list of segment control options | ||
| id | integer($int32) | 0 | Returns the id of the segment control option | |
| value | string | "string" | Returns the value of the segment control option | |
| enabled | bool | false | Returns whether the segment control option is enabled | |
| segmentLength | integer($int32) | 0 | Returns the length of the MPEG-2 Transport Stream segments to create (in seconds) | |
| minSegmentLength | integer($int32) | 0 | Returns the minimum length of the Transport Stream segments | |
| type | integer($int32) | 0 | Returns the id of the selected output group | |
| outputGroupsTypes | Dictionary<string, int> | {"string", 0},{"string", 0} | Returns the name and id of output groups | |
| typeDescription | string | "string" | Returns the description for the selected output | |
| description | string | "string" | Returns the description for the selected output group | |
| groupDRM | object | Returns the properties of the group DRM | ||
| shakaPackagerKeyProviderType | integer($int32) | 0 | Returns the Shaka Packeger Key Provider Id | |
| protectionSchemaType | integer($int32) | 0 | Returns the selected protection schema type for the created template | |
| protectionSchemaOptions | array[object] | Returns the list of protection schema type options | ||
| 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 encryption algorithm type | |
| label | string | "string" | Returns the label for the group DRM | |
| clearLead | integer($int32) | 0 | Returns the clear lead in seconds if encryption is enabled | |
| drmList | object | Returns the group DRM List | ||
| providers | array[object] | Returns the list of the Shaka Package Provider | ||
| id | integer($int32) | 0 | Returns the id of the provider | |
| name | string | "string" | Returns the name of the provider | |
| widevineAlgorithm | object | Returns the Widevine Model properties | ||
| widevineId | integer($int32) | 0 | Returns the id of the Widevine Algorithmn | |
| algorithms | array[object] | Returns the list of the encryption algorithms | ||
| id | integer($int32) | 0 | Returns the id of the encryption algorithms | |
| type | string | "string" | Returns the type of the encryption algorithms | |
| rawKey | object | Returns the raw key model properties | ||
| rawKeyId | integer($int32) | 0 | Returns the id of the raw key | |
| labels | array[string] | {"string"} | Returns the labels of the selected raw key | |
| hasDRM | bool | false | Returns whether the DRM iss enabled or not | |
| emptyOutputModel | object | Returns a output minified model | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the output minified model provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the output minified model | |
| presetName | string | "string" | Returns the preset name of the output minified model | |
| videoCodec | string | "string" | Returns the video codec of the output minified model | |
| audioCodec | string | "string" | Returns the audio codec of the output minified model | |
| outputs | array[object] | Returns the list of the encoding outputs | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the encoding output provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the encoding output | |
| presetName | string | "string" | Returns the preset name of the encoding output | |
| videoCodec | string | "string" | Returns the video codec of the encoding output | |
| audioCodec | string | "string" | Returns the audio codec of the encoding output | |
| 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
PUT Template#
Update a template.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobtemplates |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | {id, name, category, description, liveJobTemplate, jobTemplateType, projectId, groups[]{name, customName, uploadedPath, segmentControl, segmentLength, minSegmentLength, type, outputGroupsTypes{additionalProp1, additionalProp2}, typeDescription, description, groupDRM{shakaPackagerKeyProviderType, protectionSchemaType, encryptionAlgorithmType, label, clearLead}, drmList{providers[]{id, name}, widevineAlgorithm{widevineId, algorithms[]{id, type}}, rawKey{rawKeyId, labels[]}}, hasDRM, emptyOutputModel{name, nameModifier, presetId, presetName, videoCodec, audioCodec}, outputs[]{name, nameModifier, presetId, presetName, videoCodec, audioCodec}}} |
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($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| ProjectId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | integer($int32) | v1 | Shows the version of API |
Request body#
{ "id": 0, "name": "string", "category": "string", "description": "string", "liveJobTemplate": true, "jobTemplateType": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": 0, "segmentLength": 0, "minSegmentLength": 0, "type": 0, "outputGroupsTypes": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 }, "typeDescription": "string", "description": "string", "groupDRM": { "shakaPackagerKeyProviderType": 0, "protectionSchemaType": 0, "encryptionAlgorithmType": 0, "label": "string", "clearLead": 0 }, "drmList": { "providers": [ { "id": 0, "name": "string" } ], "widevineAlgorithm": { "widevineId": 0, "algorithms": [ { "id": 0, "type": "string" } ] }, "rawKey": { "rawKeyId": 0, "labels": [ "string" ] } }, "hasDRM": true, "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" } ] } ]}
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | integer($int32) | 0 | It specifies the id of the template to be updated |
| name | Yes | string | "string" | It specifies the name of the template to be updated |
| category | No | string | "string" | It specifies the category of the template to be updated |
| description | No | string | "string" | It specifies the description of the template to be updated |
| liveJobTemplate | Yes | bool | false | It specifies whether if the template is used for live jobs or if it used for jobs |
| jobTemplateType | Yes | integer($int32) | 0 | It specifies the template type of the template to be updated |
| jobTemplateTypeOptions | array[object] | It specifies the template type options | ||
| id | Yes | integer($int32) | 0 | It specifies the id of the template type option |
| value | Yes | string | "string" | It specifies the name of the template type option |
| enabled | Yes | bool | false | It specifies if the specific template type is being used or enabled |
| projectId | Yes | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | It specifies the project id for the template to be updated |
| groups | array[object] | It specifies the list of output groups in regard to the template to be updated | ||
| name | Yes | string | "string" | It specifies the default name of the encoding group for the template to be updated |
| customName | Yes | string | "string" | It specifies the name of the encoding group provided by the user. It will overwrite the default name |
| uploadedPath | Yes | string | "string" | It specifies the uploaded path of the encoding group |
| segmentControl | Yes | string | "string" | It specifies the segment control of the encoding group chosen by the user in accordance with the respective group |
| segmentControlOptions | array[object] | It specifies the segment control options | ||
| id | Yes | integer($int32) | 0 | It specifies the id of the segment control option |
| value | Yes | string | "string" | It specifies the name of the segment control option |
| enabled | Yes | bool | false | It specifies if the specific segment control is being used or enabled |
| segmentLength | Yes | integer($int32) | 0 | It specifies the length of the MPEG-2 Transport Stream segments to create (in seconds) |
| minSegmentLength | Yes | integer($int32) | 0 | It specifies the minimum length of the Transport Stream segments |
| type | Yes | integer($int32) | 0 | It specifies the id of the selected output group for the template to be updated |
| outputGroupsTypes | Dictionary<string, int> | {"string", 0},{"string", 0} | It specifies the types of output groups for the template to be updated | |
| typeDescription | No | string | "string" | It specifies the description for the selected output |
| description | No | string | "string" | It specifies the description for the selected output group |
| groupDRM | object | It specifies the properties of the group DRM | ||
| shakaPackagerKeyProviderType | Yes | integer($int32) | 0 | It specifies the Shaka Packager Key Provider Id |
| protectionSchemaType | Yes | integer($int32) | 0 | It specifies the Protection Schema Type Id |
| protectionSchemaOptions | array[object] | It specifies the protection schema options | ||
| id | Yes | integer($int32) | 0 | It specifies the id of the selected protection schema option |
| value | Yes | string | "string" | It specifies the name of the selected protection schema |
| enabled | Yes | bool | false | It specifies if the protection schema option is being used or enabled |
| label | Yes | string | "string" | It specifies the label for the group DRM |
| clearLead | Yes | integer($int32) | 0 | It specifies the clear lead in seconds if encryption is enabled |
| drmList | Yes | object | It specifies the group DRM List | |
| providers | Yes | array[object] | It specifies the list of the Shaka Package Provider for the template to be updated | |
| id | Yes | integer($int32) | 0 | It specifies the id of the provider |
| name | Yes | string | "string" | It specifies the name of the provider |
| widevineAlgorithm | Yes | object | It specifies the Widevine Model properties for the template to be updated | |
| widevineId | Yes | integer($int32) | 0 | It specifies the id of the Widevine Algorithm |
| algorithms | array[object] | It specifies the list of the encryption algorithms | ||
| id | Yes | integer($int32) | 0 | It specifies the id of the encryption algorithms |
| type | Yes | string | "string" | It specifies the type of the encryption algorithms |
| rawKey | object | It specifies the raw key model properties for the template to be updated | ||
| rawKeyId | Yes | integer($int32) | 0 | It specifies the id of the raw key |
| labels | Yes | array[string] | {"string"} | It specifies the labels od the seleced raw key |
| hasDRM | Yes | bool | false | It specifies whether the DRM iss enabled or not |
| emptyOutputModel | Yes | object | It specifies a output minified model for the template to be updated | |
| name | Yes | string | "string" | It specifies the default name of the output minified model |
| nameModifier | Yes | string | "string" | It specifies the name of the output minified model provided by the user |
| presetId | Yes | integer($int32) | 0 | It specifies the preset id of the output minified model |
| presetName | Yes | string | "string" | It specifies the preset name of the output minified model |
| videoCodec | Yes | string | "string" | It specifies the video codec of the output minified model |
| audioCodec | Yes | string | "string" | It specifies the audio codec of the output minified model |
| outputs | array[object] | It specifies the list of the encoding outputs for the template to be updated | ||
| name | Yes | string | "string" | It specifies the default name of the output minified model |
| nameModifier | Yes | string | "string" | It specifies the name of the encoding output provided by the user |
| presetId | Yes | integer($int32) | 0 | It specifies the preset id of the encoding output |
| presetName | Yes | string | "string" | It specifies the preset name of the encoding output |
| videoCodec | Yes | string | "string" | It specifies the video codec of the encoding output |
| audioCodec | Yes | string | "string" | It specifies the audio codec of the encoding output |
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": 0, "name": "string", "category": "string", "description": "string", "liveJobTemplate": true, "jobTemplateType": 0, "jobTemplateTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": 0, "segmentControlOptions": [ { "id": 0, "value": "string", "enabled": true } ], "segmentLength": 0, "minSegmentLength": 0, "type": 0, "outputGroupsTypes": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 }, "typeDescription": "string", "description": "string", "groupDRM": { "shakaPackagerKeyProviderType": 0, "protectionSchemaType": 0, "protectionSchemaOptions": [ { "id": 0, "value": "string", "enabled": true } ], "encryptionAlgorithmType": 0, "label": "string", "clearLead": 0 }, "drmList": { "providers": [ { "id": 0, "name": "string" } ], "widevineAlgorithm": { "widevineId": 0, "algorithms": [ { "id": 0, "type": "string" } ] }, "rawKey": { "rawKeyId": 0, "labels": [ "string" ] } }, "hasDRM": true, "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 }}| Body Parameter Name | Mandatory | 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 | object | Returns the updated job | ||
| id | integer($int32) | 0 | Returns the id of the updated template | |
| name | string | "string" | Returns the name of the updated template | |
| category | string | "string" | Returns the category of the updated template | |
| description | string | "string" | Returns the description of the updated template | |
| liveJobTemplate | bool | false | Returns true if the template is used for live jobs or false if used for jobs | |
| jobTemplateType | integer($int32) | 0 | Returns the template type of the updated template | |
| jobTemplateTypeOptions | array[object] | Returns the list of template type options | ||
| id | integer($int32) | 0 | Returns the id of the job template option | |
| value | string | "string" | Returns the name of the job template option | |
| enabled | bool | false | Returns if the specific job template is being used or enabled | |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id for the updated template | |
| groups | array[object] | Returns the list of output groups in regard to the updated template | ||
| name | string | "string" | Returns the default name of the encoding group | |
| customName | string | "string" | Returns the name of the encoding group provided by the user. It will overwrite the default name | |
| uploadedPath | string | "string" | Returns the uploaded path of the encoding group | |
| segmentControl | string | "string" | Returns the segment control of the encoding group chosen by the user in accordance with the respective group | |
| segmentControlOptions | array[object] | Returns the list of segment control options | ||
| id | integer($int32) | 0 | Returns the id of the segment control option | |
| value | string | "string" | Returns the value of the segment control option | |
| enabled | bool | false | Returns if the specific segment control is being used or enabled | |
| segmentLength | integer($int32) | 0 | Returns the length of the MPEG-2 Transport Stream segments to create (in seconds) | |
| minSegmentLength | integer($int32) | 0 | Returns the minimum length of the Transport Stream segments | |
| type | integer($int32) | 0 | Returns the id of the selected output group | |
| outputGroupsTypes | Dictionary<string, int> | {"string", 0},{"string", 0} | Returns the name and id of output groups | |
| typeDescription | string | "string" | Returns the description for the selected output | |
| description | string | "string" | Returns the description for the selected output group | |
| groupDRM | object | Returns the properties of the group DRM | ||
| shakaPackagerKeyProviderType | integer($int32) | 0 | Returns the Shaka Packager Key Provider Id | |
| protectionSchemaType | integer($int32) | 0 | Returns the Protection Schema Type Id for the updated template | |
| protectionSchemaOptions | array[object] | Returns the list of protection schema type options | ||
| id | integer($int32) | 0 | Returns the id of the protection schema option | |
| value | string | "string" | Returns the name of the protection schema | |
| enabled | bool | false | Returns if the protection schema option is being used or enabled | |
| label | string | "string" | Returns the label for the group DRM | |
| clearLead | integer($int32) | 0 | Returns the clear lead in seconds if encryption is enabled | |
| drmList | object | Returns the group DRM List | ||
| providers | array[object] | Returns the list of the Shaka Package Provider for the updated template | ||
| id | integer($int32) | 0 | Returns the id of the provider | |
| name | string | "string" | Returns the name of the provider | |
| widevineAlgorithm | object | Returns the Widevine Model properties for the updated template | ||
| widevineId | integer($int32) | 0 | Returns the id of the Widevine Algorithmn | |
| algorithms | array[object] | Returns the list of the encryption algorithms for the updated template | ||
| id | integer($int32) | 0 | Returns the id of the encryption algorithms | |
| type | string | "string" | Returns the type of the encryption algorithms | |
| rawKey | object | Returns the raw key model properties for the updated template | ||
| rawKeyId | integer($int32) | 0 | Returns the id of the raw key | |
| labels | array[string] | {"string"} | Returns the labels od the seleced raw key | |
| hasDRM | bool | false | Returns whether the DRM iss enabled or not | |
| emptyOutputModel | object | Returns a output minified model | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the output minified model provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the output minified model | |
| presetName | string | "string" | Returns the preset name of the output minified model | |
| videoCodec | string | "string" | Returns the video codec of the output minified model | |
| audioCodec | string | "string" | Returns the audio codec of the output minified model | |
| outputs | array[object] | Returns the list of the encoding outputs for the updated template | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the encoding output provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the encoding output | |
| presetName | string | "string" | Returns the preset name of the encoding output | |
| videoCodec | string | "string" | Returns the video codec of the encoding output | |
| audioCodec | string | "string" | Returns the audio codec of the encoding output | |
| 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
GET Template#
Get a specific template.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobtemplates/{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 | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| {id} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the template |
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 |
| Id | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the template |
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": 0, "name": "string", "category": "string", "description": "string", "liveJobTemplate": true, "jobTemplateType": 0, "jobTemplateTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": 0, "segmentControlOptions": [ { "id": 0, "value": "string", "enabled": true } ], "segmentLength": 0, "minSegmentLength": 0, "type": 0, "outputGroupsTypes": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 }, "typeDescription": "string", "description": "string", "groupDRM": { "shakaPackagerKeyProviderType": 0, "protectionSchemaType": 0, "protectionSchemaOptions": [ { "id": 0, "value": "string", "enabled": true } ], "encryptionAlgorithmType": 0, "label": "string", "clearLead": 0 }, "drmList": { "providers": [ { "id": 0, "name": "string" } ], "widevineAlgorithm": { "widevineId": 0, "algorithms": [ { "id": 0, "type": "string" } ] }, "rawKey": { "rawKeyId": 0, "labels": [ "string" ] } }, "hasDRM": true, "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 }}| Body Parameter Name | Mandatory | 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 | object | Returns the requested template | ||
| id | integer($int32) | 0 | Returns the id of the requested template | |
| name | string | "string" | Returns the name of the requested template | |
| category | string | "string" | Returns the category of the requested template | |
| description | string | "string" | Returns the description of the selected template | |
| liveJobTemplate | bool | false | Returns true if the template is used for live jobs or false if used for jobs | |
| jobTemplateType | integer($int32) | 0 | Returns the template type of the requested template | |
| jobTemplateTypeOptions | array[object] | Returns the list of template type options | ||
| id | integer($int32) | 0 | Returns the id of the template type option | |
| value | string | "string" | Returns the value of the template type option | |
| enabled | bool | false | Returns whether the template type option is enabled | |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id for the selected template | |
| groups | array[object] | Returns the list of output groups in regard to the requested template | ||
| name | string | "string" | Returns the default name of the encoding group | |
| customName | string | "string" | Returns the name of the encoding group provided by the user. It will overwrite the default name | |
| uploadedPath | string | "string" | Returns the uploaded path of the encoding group | |
| segmentControl | integer($int32) | 0 | Returns the segment control of the requested template | |
| segmentControlOptions | array[object] | Returns the list of segment control options | ||
| id | integer($int32) | 0 | Returns the id of the segment control option | |
| value | string | "string" | Returns the value of the segment control option | |
| enabled | bool | false | Returns whether the segment control option is enabled | |
| segmentLength | integer($int32) | 0 | Returns the length of the MPEG-2 Transport Stream segments to create (in seconds) | |
| minSegmentLength | integer($int32) | 0 | Returns the minimum length of the Transpost Stream segments | |
| type | integer($int32) | 0 | Returns the id of the requested output group | |
| outputGroupsTypes | Dictionary<string, int> | {"string", 0},{"string", 0} | Returns the name and id of output groups | |
| additionalProp1 | integer($int32) | 0 | Returns the id of the specific output group | |
| typeDescription | string | "string" | Returns the description for the requested output | |
| description | string | "string" | Returns the description for the requested output group | |
| groupDRM | object | Returns the properties of the group DRM for the requested template | ||
| shakaPackagerKeyProviderType | integer($int32) | 0 | Returns the Shaka Packeger Key Provider Id | |
| protectionSchemaType | integer($int32) | 0 | Returns the Protection Schema Type Id of the requested template | |
| protectionSchemaOptions | array[object] | Returns the list of protection schema type options | ||
| 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 encryption algorithm type | |
| label | string | "string" | Returns the label for the group DRM | |
| clearLead | integer($int32) | 0 | Returns the clear lead in seconds if encryption is enabled | |
| drmList | object | Returns the group DRM List for the requested template | ||
| providers | array[object] | Returns the list of the Shaka Package Provider for the requested template | ||
| id | integer($int32) | 0 | Returns the id of the provider | |
| name | string | "string" | Returns the name of the provider | |
| widevineAlgorithm | object | Returns the Widevine Model properties for the requested template | ||
| widevineId | integer($int32) | 0 | Returns the id of the Widevine Algorithmn | |
| algorithms | array[object] | Returns the list of the encryption algorithms for the requested template | ||
| id | integer($int32) | 0 | Returns the id of the encryption algorithms | |
| type | string | "string" | Returns the type of the encryption algorithms | |
| rawKey | object | Returns the raw key model properties for the requested template | ||
| rawKeyId | integer($int32) | 0 | Returns the id of the raw key | |
| labels | array[string] | {"string"} | Returns the labels od the seleced raw key | |
| hasDRM | bool | false | Returns whether the DRM iss enabled or not | |
| emptyOutputModel | object | Returns a output minified model for the requested template | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the output minified model provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the output minified model | |
| presetName | string | "string" | Returns the preset name of the output minified model | |
| videoCodec | string | "string" | Returns the video codec of the output minified model | |
| audioCodec | string | "string" | Returns the audio codec of the output minified model | |
| outputs | array[object] | Returns the list of the encoding outputs for the requested template | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the encoding output provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the encoding output | |
| presetName | string | "string" | Returns the preset name of the encoding output | |
| videoCodec | string | "string" | Returns the video codec of the encoding output | |
| audioCodec | string | "string" | Returns the audio codec of the encoding output | |
| 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
DELETE Template#
Delete a specific template.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobtemplates/{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 | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| {id} | Yes | integer($int32) | 0 | Shows the id of the template |
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 |
| Id | Yes | integer($int32) | 06 | Shows the id of the template |
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.
{ "message": "string"}| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| message | string | "string" | Returns the message in regard to deletion of the template |
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
POST Template#
Duplicate a job template.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobtemplates/{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 | integer($int32) | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| {id} | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the template |
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 |
| Id | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the template |
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": 0, "name": "string", "category": "string", "description": "string", "liveJobTemplate": true, "jobTemplateType": 0, "jobTemplateTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": 0, "segmentControlOptions": [ { "id": 0, "value": "string", "enabled": true } ], "segmentLength": 0, "minSegmentLength": 0, "type": 0, "outputGroupsTypes": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 }, "typeDescription": "string", "description": "string", "groupDRM": { "shakaPackagerKeyProviderType": 0, "protectionSchemaType": 0, "protectionSchemaOptions": [ { "id": 0, "value": "string", "enabled": true } ], "encryptionAlgorithmType": 0, "label": "string", "clearLead": 0 }, "drmList": { "providers": [ { "id": 0, "name": "string" } ], "widevineAlgorithm": { "widevineId": 0, "algorithms": [ { "id": 0, "type": "string" } ] }, "rawKey": { "rawKeyId": 0, "labels": [ "string" ] } }, "hasDRM": true, "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 }}| Body Parameter Name | Mandatory | 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 | object | Returns the duplicated job | ||
| id | integer($int32) | 0 | Returns the id of the duplicated template | |
| name | string | "string" | Returns the name of the duplicated template | |
| category | string | "string" | Returns the category of the duplicated template | |
| description | string | "string" | Returns the description of the duplicated template | |
| liveJobTemplate | bool | false | Returns true if the template is used for live jobs or false if used for jobs | |
| jobTemplateType | integer($int32) | 0 | Returns the template type of the duplicated template | |
| jobTemplateTypeOptions | array[object] | Returns the duplicated job template options | ||
| id | integer($int32) | 0 | Returns the id of the duplicated job template | |
| value | string | "string" | Returns the name of the duplicated job template | |
| enabled | bool | false | Returns if the specific job template is being used or enabled | |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id for the duplicated template | |
| groups | array[object] | Returns the list of output groups in regard to the duplicated template | ||
| name | string | "string" | Returns the default name of the encoding group | |
| customName | string | "string" | Returns the name of the encoding group provided by the user. It will overwrite the default name | |
| uploadedPath | string | "string" | Returns the uploaded path of the encoding group | |
| segmentControl | string | "string" | Returns the segment control of the encoding group chosen by the user in accordance with the respective group | |
| segmentControlOptions | array[object] | Returns the segment control options | ||
| id | integer($int32) | 0 | Returns the id of the selected segment control | |
| value | string | "string" | Returns the name of the selected segment control | |
| enabled | bool | false | Returns if the specific segment control is being used or enabled | |
| segmentLength | integer($int32) | 0 | Returns the length of the MPEG-2 Transport Stream segments to create (in seconds) | |
| minSegmentLength | integer($int32) | 0 | Returns the minimum length of the Transport Stream segments | |
| type | integer($int32) | 0 | Returns the id of the selected output group | |
| outputGroupsTypes | Dictionary<string, int> | {"string", 0},{"string", 0} | Returns the name and id of output groups | |
| typeDescription | string | "string" | Returns the description for the selected output | |
| description | string | "string" | Returns the description for the selected output group | |
| groupDRM | object | Returns the properties of the group DRM | ||
| shakaPackagerKeyProviderType | integer($int32) | 0 | Returns the Shaka Packager Key Provider Id | |
| protectionSchemaType | integer($int32) | 0 | Returns the Protection Schema Type Id | |
| protectionSchemaOptions | array[object] | Returns the protection schema options | ||
| id | integer($int32) | 0 | Returns the id of the selected protection schema option | |
| value | string | "string" | Returns the name of the selected protection schema | |
| enabled | bool | false | Returns if the protection schema option is being used or enabled | |
| label | string | "string" | Returns the label for the group DRM | |
| clearLead | integer($int32) | 0 | Returns the clear lead in seconds if encryption is enabled | |
| drmList | object | Returns the group DRM List | ||
| providers | array[object] | Returns the list of the Shaka Package Provider | ||
| id | integer($int32) | 0 | Returns the id of the provider | |
| name | string | "string" | Returns the name of the provider | |
| widevineAlgorithm | object | Returns the Widevine Model properties | ||
| widevineId | integer($int32) | 0 | Returns the id of the Widevine Algorithm | |
| algorithms | array[object] | Returns the list of the encryption algorithms | ||
| id | integer($int32) | 0 | Returns the id of the encryption algorithms | |
| type | string | "string" | Returns the type of the encryption algorithms | |
| rawKey | object | Returns the raw key model properties | ||
| rawKeyId | integer($int32) | 0 | Returns the id of the raw key | |
| labels | array[string] | {"string"} | Returns the labels of the selected raw key | |
| hasDRM | bool | false | Returns whether the DRM iss enabled or not | |
| emptyOutputModel | object | Returns a output minified model | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the output minified model provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the output minified model | |
| presetName | string | "string" | Returns the preset name of the output minified model | |
| videoCodec | string | "string" | Returns the video codec of the output minified model | |
| audioCodec | string | "string" | Returns the audio codec of the output minified model | |
| outputs | array[object] | Returns the list of the encoding outputs | ||
| name | string | "string" | Returns the default name of the output minified model | |
| nameModifier | string | "string" | Returns the name of the encoding output provided by the user | |
| presetId | integer($int32) | 0 | Returns the preset id of the encoding output | |
| presetName | string | "string" | Returns the preset name of the encoding output | |
| videoCodec | string | "string" | Returns the video codec of the encoding output | |
| audioCodec | string | "string" | Returns the audio codec of the encoding output | |
| 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