GetTasksResponse GetTasks(ctx, optional)
This gets a list of tasks based on the provided criteria
Required Parameters
| Name | Type | Description | Notes |
|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetTasksOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetTasksOpts struct
| Name | Type | Description | Notes |
|---|
| xCorrelationId | optional.String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | |
| startTime | optional.Int64 | The unix timestamp, describing the start time for the stats | |
| endTime | optional.Int64 | The unix timestamp, describing the end time for the stats | |
| offset | optional.Int64 | the number of data to skip before getting the result set | |
| limit | optional.Int64 | the number of items to return. | [default to 10] |
| orderBy | optional.String | the field to sort | [default to createdDateTime] |
| direction | optional.String | the sort order. ASC or DESC. | [default to DESC] |
| status | optional.Interface of TaskStatusEnum | Filtering by task Status | |
| organizationID | optional.String | Filter by organization id | |
| taskID | optional.String | Filter by task id | |
| coreTaskID | optional.String | Filter by coreTaskID | |
| errorType | optional.Interface of FailureReasonEnum | filter by errorType (failureReason) | |
| jobID | optional.String | Filter by job id | |
| coreJobID | optional.String | Filter by coreJobID | |
| engineID | optional.String | Filter by engine id | |
| mediaSourceID | optional.String | Filter by media source id | |
| recordingID | optional.Int64 | Filter tasks by the recording id | |
| engineCategoryID | optional.Interface of string | Filtering by engineCategoryID | |
| modifiedBefore | optional.Int64 | Filter by items modified before expressed as timestamp | |
| modifiedAfter | optional.Int64 | Filter by items modified after expressed as timestamp | |
| createdBefore | optional.Int64 | Filter items where created date is before this date | |
| createdAfter | optional.Int64 | Filter items where created date is after this date | |
| backlog | optional.Bool | Filtering all tasks in backlog | |
| alloc | optional.Bool | Filtering all tasks have alloc = true or not | |
Return type
GetTasksResponse
Authorization
api_key
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
