GetJobListResponse GetJobs(ctx, optional)
This gets a list of jobs
Required Parameters
| Name | Type | Description | Notes |
|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetJobsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetJobsOpts 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 | |
| status | optional.Interface of JobStatusEnum | If specified, this limits the jobs or tasks to follow status | |
| 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] |
| coreID | optional.Interface of string | Filter by coreID | |
| organizationID | optional.String | Filter by organizationID | |
| recordingID | optional.String | Filter by recordingID | |
| jobID | optional.Interface of string | Filter by jobID | |
| coreJobID | optional.String | Filter by coreJobID | |
| scheduledJobID | optional.String | Filter by scheduledJobID(s) separated by commas | |
| 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 | |
Return type
GetJobListResponse
Authorization
api_key
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
