Jobs
GET Jobs#
Get all jobs
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobs |
| Headers | Authorization |
| Parameters | version, projectId, pageIndex, pageSize, status |
| 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:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string($Guid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the id of the project |
| Version | Yes | string | 1 | Shows the version of API |
| 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 |
| Status | No | integer($int32) | 0 | Shows the all the jobs with that particular status |
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": [], "messages": [], "result": [ { "id": 0, "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filePath": "https://example.com/bucket/destination/test.mp4", "isCancelable": false, "status": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "progress": 0, "insertDate": "2022-04-12T08:46:36.313Z", "startDateTime": "2022-04-12T08:46:36.313Z", "endDateTime": null } ], "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 jobs | |
| id | integer($int32) | 0 | Returns the id of the requested job |
| name | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the name of the requested job |
| filePath | string | "https://example.com/file.mp4" | Returns the file path of the input file of the requested job |
| isCancelable | bool | false | Returns true if you can cancel the job or false if you can't cancel a job while processing |
| status | string | "Submitted" | Return the status of the job |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the requested job |
| progress | integer($int32) | 0 | Returns the progress of completion for the requested job |
| insertDate | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been inserted |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been finished |
| 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 Job#
Get job by name.
| GET | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobs |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | {jobTemplateId, input{filePath, fileDuration, callbackUrl}, destination, generateThumbnail, tags[]{key, value}} |
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#
{ "jobTemplateId": 0, "input": { "filePath": "string", "fileDuration": 0, "callbackUrl": "string" }, "destination": "string", "generateThumbnail": true, "tags": [ { "key": "string", "value": "string" } ]}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| jobTemplateId | Yes | integer($int32) | 0 | The id of the template to be used to create the job |
| input | Yes | object | It specifies all the input file properties to create a new job | |
| filePath | Yes | string | "string" | It specifies the path for the input file to be transcoded |
| fileDuration | No | string | 0 | It specifies the duration of the input file to be transcoded |
| callbackUrl | No | string | "string" | It specifies the url that will be used to notify on any status change |
| destination | Yes | string | "test/path" | It specifies the destination for the encoded videos |
| generateThumbnail | Yes | bool | false | It specifies whether or not you want to create a thumbnail for the encoded video |
| tags | No | array [object] | It specifies the list of tags, which are key-value properties, regarding the requested job | |
| key | No | string | "string" | It specifies the tag's key of the requested job |
| value | No | string | "string" | It specifies the tag's value of the requested job |
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, "insertDate": "2022-04-12T09:40:21.233Z", "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobTemplateId": 0, "jobTemplateName": "string", "status": "string", "statusId": 0, "isCancelable": true, "destination": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobPercentComplete": 0, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z", "drmContentId": "string", "drmKeyId": "string", "generateThumbnail": true, "input": { "filePath": "string", "fileDuration": 0, "callbackUrl": "string" }, "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": "string", "masterFile": "string", "segmentLength": 0, "minSegmentLength": 0, "typeDescription": "string", "description": "string", "outputs": [ { "id": 0, "name": "string", "nameModifier": "string", "presetId": 0, "presetName": "string", "videoCodec": "string", "uploadedPath": "string", "masterFile": "string", "audioCodec": "string", "encodingOutputJob": { "id": 0, "progress": 0, "statusDescription": "string", "isCancelable": true, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z" } } ] } ], "tags": [ { "key": "string", "value": "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 live job | |
| id | integer($int32) | 0 | Returns the id of the job |
| insertDate | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been inserted |
| name | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the name of the job |
| jobTemplateId | integer($int32) | 0 | Returns the id of the requested job template |
| jobTemplateName | string | "TestTemplate" | Return the name of the template |
| status | string | "Submitted" | Return the status of the job |
| statusId | integer($int32) | 0 | Returns the status id of the requested job |
| isCancelable | bool | false | Returns true if you can cancel the job or false if you can't cancel a job while processing |
| destination | string | "test/path" | Return the destination for the encoded videos |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the created job |
| jobPercentComplete | integer($int32) | 0 | Returns the percentage of the progress of completion for the requested job |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been finished |
| drmContentId | string | "string" | Return the content id of the DRM for the created job |
| drmKeyId | string | "string" | Return the key id of the DRM for the created job |
| input | object | Return the input object which contains the input file properties | |
| filePath | string | "string" | Returns the path for the input file to be transcoded |
| fileDuration | string | 0 | Returns the duration of the input file to be transcoded |
| callbackUrl | string | "string" | Returns url that will be used to notify on any status change |
| groups | array [object] | Returns the list of groups that are used during the transcoding process | |
| 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 |
| masterFile | string | "string" | Returns the name of the master file for the encoded file input |
| 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 |
| typeDescription | string | "string" | Returns the description regarding the type of output group chosen |
| description | string | "string" | Returns the description about that output group |
| outputs | array [object] | Returns the list of outputs which specify the properties of the output format for the input file | |
| id | integer($int32) | 0 | Returns the id of the output |
| name | string | "string" | Returns the default name of the output |
| nameModifier | string | "string" | Returns the name given by the user for that specific output which will overwrite the default name |
| presetId | integer($int32) | 0 | Returns the preset id for that specific output |
| presetName | string | "string" | Returns the name of the preset for that specific output |
| videoCodec | string | "string" | Returns the codec of the video |
| uploadedPath | string | "string" | Returns the path of the output uploaded |
| masterFile | string | "string" | Returns the path for the masterfile of the requested output |
| audioCodec | string | "string" | Returns the codec of the audio |
| encodingOutputJob | object | Returns the properties of the encoding output job specific for that particular output | |
| id | integer($int32) | 0 | Returns the id of the encoding output job for that specific output |
| progress | integer($int32) | 0 | Returns the percentage of the encoding output job completion |
| statusDescription | string | "string" | Returns the description of the status of the encoding output job |
| isCancelable | bool | false | Returns true if you can cancel the encoding output job or false if you can't cancel an encoding output job while processing |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has been finished |
| tags | array [object] | Returns the list of tags, which are key-value properties, regarding the requested job | |
| key | string | "string" | Returns the tag's key of the requested job |
| value | string | "string" | Returns the tag's value of the requested job |
| 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: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Job#
Get job by name.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobs/{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 project id |
| {id} | Yes | string | Guid | The name of the job requested |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Id | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the name of the requested job |
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the project id for the requested job |
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, "insertDate": "2022-04-12T09:40:21.233Z", "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobTemplateId": 0, "jobTemplateName": "string", "status": "string", "statusId": 0, "isCancelable": true, "destination": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobPercentComplete": 0, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z", "drmContentId": "string", "drmKeyId": "string", "generateThumbnail": true, "input": { "filePath": "string", "fileDuration": 0, "callbackUrl": "string" }, "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": "string", "masterFile": "string", "segmentLength": 0, "minSegmentLength": 0, "typeDescription": "string", "description": "string", "outputs": [ { "id": 0, "name": "string", "nameModifier": "string", "presetId": 0, "presetName": "string", "videoCodec": "string", "uploadedPath": "string", "masterFile": "string", "audioCodec": "string", "encodingOutputJob": { "id": 0, "progress": 0, "statusDescription": "string", "isCancelable": true, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z" } } ] } ], "tags": [ { "key": "string", "value": "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 live job | |
| id | integer($int32) | 0 | Returns the id of the requested job |
| insertDate | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been inserted |
| name | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the name of the requested job |
| jobTemplateId | integer($int32) | 0 | Returns the id of the requested job template |
| jobTemplateName | string | "TestTemplate" | Return the name of the requested job template |
| status | string | "Submitted" | Return the status of the job |
| statusId | integer($int32) | 0 | Returns the status id of the requested job |
| isCancelable | bool | false | Returns true if you can cancel the job or false if you can't cancel a job while processing |
| destination | string | "test/path" | Return the destination for the encoded videos |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the requested job |
| jobPercentComplete | integer($int32) | 0 | Returns the percentage of the progress of completion for the requested job |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been finished |
| drmContentId | string | "string" | Return the content id of the DRM for the reqested job |
| drmKeyId | string | "string" | Return the key id of the DRM for the reqested job |
| input | object | Return the input object which contains the input file properties | |
| filePath | string | "string" | Returns the path for the input file to be transcoded |
| fileDuration | string | 0 | Returns the duration of the inut file to be transcoded |
| callbackUrl | string | "string" | Returns url that will be used to notify on any status change |
| groups | array [object] | Returns the list of groups that are used during the transcoding process | |
| 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 |
| masterFile | string | "string" | Returns the name of the master file for the encoded file input |
| 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 |
| typeDescription | string | "string" | Returns the description regarding the type of output group chosen |
| description | string | "string" | Returns the description about that output group |
| outputs | array [object] | Returns the list of outputs which specify the properties of the output format for the input file | |
| id | integer($int32) | 0 | Returns the id of the output |
| name | string | "string" | Returns the default name of the output |
| nameModifier | string | "string" | Returns the name given by the user for that specific output which will overwrite the default name |
| presetId | integer($int32) | 0 | Returns the preset id for that specific output |
| presetName | string | "string" | Returns the name of the preset for that specific output |
| videoCodec | string | "string" | Returns the codec of the video |
| uploadedPath | string | "string" | Returns the path of the output uploaded |
| masterFile | string | "string" | Returns the path for the masterfile of the requested output |
| audioCodec | string | "string" | Returns the codec of the audio |
| encodingOutputJob | object | Returns the properties of the encoding output job specific for that particular output | |
| id | integer($int32) | 0 | Returns the id of the encoding output job for that specific output |
| progress | integer($int32) | 0 | Returns the percentage of the encoding output job completetion |
| statusDescription | string | "string" | Returns the description of the status of the encoding output job |
| isCancelable | bool | false | Returns true if you can cancel the encoding output job or false if you can't cancel an encoding output job while processing |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has been finished |
| tags | array [object] | Returns the list of tags, which are key-value properties, regarding the requested job | |
| key | string | "string" | Returns the tag's key of the requested job |
| value | string | "string" | Returns the tag's value of the requested job |
| resultInfo | array [object] | Returns an object of job | |
| 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 jobs |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the page number of job |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
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 Not found
POST Job#
Duplicate job.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobs/{id}/duplicate |
| 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 project id |
| {id} | Yes | Guid | Guid | The name of the job requested |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Id | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the name of the requested job to be duplicated |
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the project id for the requested job to be duplicated |
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, "insertDate": "2022-04-12T09:40:21.233Z", "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobTemplateId": 0, "jobTemplateName": "string", "status": "string", "statusId": 0, "isCancelable": true, "destination": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobPercentComplete": 0, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z", "drmContentId": "string", "drmKeyId": "string", "generateThumbnail": true, "input": { "filePath": "string", "fileDuration": 0, "callbackUrl": "string" }, "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": "string", "masterFile": "string", "segmentLength": 0, "minSegmentLength": 0, "typeDescription": "string", "description": "string", "outputs": [ { "id": 0, "name": "string", "nameModifier": "string", "presetId": 0, "presetName": "string", "videoCodec": "string", "uploadedPath": "string", "masterFile": "string", "audioCodec": "string", "encodingOutputJob": { "id": 0, "progress": 0, "statusDescription": "string", "isCancelable": true, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z" } } ] } ], "tags": [ { "key": "string", "value": "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 live job | |
| id | integer($int32) | 0 | Returns the id of the requested job |
| insertDate | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been inserted |
| name | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the name of the requested job |
| jobTemplateId | integer($int32) | 0 | Returns the id of the requested job template |
| jobTemplateName | string | "TestTemplate" | Return the name of the requested job template |
| status | string | "Submitted" | Return the status of the job |
| statusId | integer($int32) | 0 | Returns the status id of the requested job |
| isCancelable | bool | false | Returns true if you can cancel the job or false if you can't cancel a job while processing |
| destination | string | "test/path" | Return the destination for the encoded videos |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the requested job |
| jobPercentComplete | integer($int32) | 0 | Returns the percentage of the progress of completion for the requested job |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been finished |
| drmContentId | string | "string" | Return the content id of the DRM for the reqested job |
| drmKeyId | string | "string" | Return the key id of the DRM for the reqested job |
| input | object | Return the input object which contains the input file properties | |
| filePath | string | "string" | Returns the path for the input file to be transcoded |
| fileDuration | string | 0 | Returns the duration of the inut file to be transcoded |
| callbackUrl | string | "string" | Returns url that will be used to notify on any status change |
| groups | array [object] | Returns the list of groups that are used during the transcoding process | |
| 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 |
| masterFile | string | "string" | Returns the name of the master file for the encoded file input |
| 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 |
| typeDescription | string | "string" | Returns the description regarding the type of output group chosen |
| description | string | "string" | Returns the description about that output group |
| outputs | array [object] | Returns the list of outputs which specify the properties of the output format for the input file | |
| id | integer($int32) | 0 | Returns the id of the output |
| name | string | "string" | Returns the default name of the output |
| nameModifier | string | "string" | Returns the name given by the user for that specific output which will overwrite the default name |
| presetId | integer($int32) | 0 | Returns the preset id for that specific output |
| presetName | string | "string" | Returns the name of the preset for that specific output |
| videoCodec | string | "string" | Returns the codec of the video |
| uploadedPath | string | "string" | Returns the path of the output uploaded |
| masterFile | string | "string" | Returns the path for the masterfile of the requested output |
| audioCodec | string | "string" | Returns the codec of the audio |
| encodingOutputJob | object | Returns the properties of the encoding output job specific for that particular output | |
| id | integer($int32) | 0 | Returns the id of the encoding output job for that specific output |
| progress | integer($int32) | 0 | Returns the percentage of the encoding output job completetion |
| statusDescription | string | "string" | Returns the description of the status of the encoding output job |
| isCancelable | bool | false | Returns true if you can cancel the encoding output job or false if you can't cancel an encoding output job while processing |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has been finished |
| tags | array [object] | Returns the list of tags, which are key-value properties, regarding the requested job | |
| key | string | "string" | Returns the tag's key of the requested job |
| value | string | "string" | Returns the tag's value of the requested job |
| resultInfo | array [object] | Returns an object of job | |
| 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 jobs |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the page number of job |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
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 Job#
Cancel a job
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobs/{id}/cancel |
| 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 project id |
| {id} | Yes | string | Guid | The name of the job requested |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Id | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the name of the requested job to be canceled |
| Version | Yes | integer($int32) | 1 | Shows the version of API |
| ProjectId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Shows the project id for the requested job to be canceled |
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, "insertDate": "2022-04-12T09:40:21.233Z", "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobTemplateId": 0, "jobTemplateName": "string", "status": "string", "statusId": 0, "isCancelable": true, "destination": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "jobPercentComplete": 0, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z", "drmContentId": "string", "drmKeyId": "string", "generateThumbnail": true, "input": { "filePath": "string", "fileDuration": 0, "callbackUrl": "string" }, "groups": [ { "name": "string", "customName": "string", "uploadedPath": "string", "segmentControl": "string", "masterFile": "string", "segmentLength": 0, "minSegmentLength": 0, "typeDescription": "string", "description": "string", "outputs": [ { "id": 0, "name": "string", "nameModifier": "string", "presetId": 0, "presetName": "string", "videoCodec": "string", "uploadedPath": "string", "masterFile": "string", "audioCodec": "string", "encodingOutputJob": { "id": 0, "progress": 0, "statusDescription": "string", "isCancelable": true, "startDateTime": "2022-04-12T09:40:21.233Z", "endDateTime": "2022-04-12T09:40:21.233Z" } } ] } ], "tags": [ { "key": "string", "value": "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 live job | |
| id | integer($int32) | 0 | Returns the id of the requested job |
| insertDate | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been inserted |
| name | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the name of the requested job to be canceled |
| jobTemplateId | integer($int32) | 0 | Returns the id of the requested job template |
| jobTemplateName | string | "TestTemplate" | Return the name of the requested job template |
| status | string | "Submitted" | Return the status of the job |
| statusId | integer($int32) | 0 | Returns the status id of the requested job |
| isCancelable | bool | false | Returns true if you can cancel the job or false if you can't cancel a job while processing |
| destination | string | "test/path" | Return the destination for the encoded videos |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id of the requested job |
| jobPercentComplete | integer($int32) | 0 | Returns the percentage of the progress of completion for the requested job |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that job has been finished |
| drmContentId | string | "string" | Return the content id of the DRM for the reqested job |
| drmKeyId | string | "string" | Return the key id of the DRM for the reqested job |
| input | object | Return the input object which contains the input file properties | |
| filePath | string | "string" | Returns the path for the input file to be transcoded |
| fileDuration | string | 0 | Returns the duration of the inut file to be transcoded |
| callbackUrl | string | "string" | Returns url that will be used to notify on any status change |
| groups | array [object] | Returns the list of groups that are used during the transcoding process | |
| 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 |
| masterFile | integer($int32) | 0 | Returns the name of the master file for the encoded file input |
| 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 |
| typeDescription | string | "string" | Returns the description regarding the type of output group chosen |
| description | string | "string" | Returns the description about that output group |
| outputs | array [object] | Returns the list of outputs which specify the properties of the output format for the input file | |
| id | integer($int32) | 0 | Returns the id of the output |
| name | string | "string" | Returns the default name of the output |
| nameModifier | string | "string" | Returns the name given by the user for that specific output which will overwrite the default name |
| presetId | integer($int32) | 0 | Returns the preset id for that specific output |
| presetName | string | "string" | Returns the name of the preset for that specific output |
| videoCodec | string | "string" | Returns the codec of the video |
| uploadedPath | string | "string" | Returns the path of the output uploaded |
| masterFile | string | "string" | Returns the path for the masterfile of the requested output |
| audioCodec | string | "string" | Returns the codec of the audio |
| encodingOutputJob | object | Returns the properties of the encoding output job specific for that particular output | |
| id | integer($int32) | 0 | Returns the id of the encoding output job for that specific output |
| progress | integer($int32) | 0 | Returns the percentage of the encoding output job completetion |
| statusDescription | string | "string" | Returns the description of the status of the encoding output job |
| isCancelable | bool | false | Returns true if you can cancel the encoding output job or false if you can't cancel an encoding output job while processing |
| startDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has started processing |
| endDateTime | date | 2022-04-12T08:46:36.313Z | Returns the date when that encoding output job has been finished |
| tags | array [object] | Returns the list of tags, which are key-value properties, regarding the requested job | |
| key | string | "string" | Returns the tag's key of the requested job |
| value | string | "string" | Returns the tag's value of the requested job |
| resultInfo | array [object] | Returns an object of job | |
| 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 jobs |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the page number of job |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
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 Job Timing#
Get all job timing
| GET ALL | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/jobs/{id}/timings |
| Headers | Authorization |
| Parameters | version, projectId, id, pageIndex, pageSize, status |
| 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 name of the requested job to aqcuire all the timings |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string | v1 | Shows the version of API |
| Id | Yes | string | v1 | Shows the name of the job to aqcuire all the timings |
| 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 |
| Status | No | integer($int32) | 0 | Shows the all the jobs with that particular status |
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": [ { "status": "string", "childStatus": "string", "startDateTime": "2022-04-13T22:41:25.576Z", "messageComment": "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 live job | |
| status | string | "string" | Returns the status of the job when the timing was taken |
| childStatus | string | "Guid" | Returns the status of the activity of the job when the timing was taken |
| startDateTime | DateTime | "2022-04-13T22:41:25.576Z" | Returns the time when that timing was recorded |
| messageComment | string | "string" | Returns the message of the job timing |
| resultInfo | array [object] | Returns an object of job | |
| 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 jobs |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the page number of job |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed 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