Qodex.ai

Lists jobs.

GET {{baseUrl}}/jobs?compartmentId={{compartment_ocid}}&limit=10&sortOrder=ASC

Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. Jobs can also be filtered based on the name and lifecycleState parameters.

Request Params

KeyDatatypeRequiredDescription
compartmentIdstring(Required) The OCID of the compartment.
idstringThe identifier of the resource.
managedDatabaseGroupIdstringThe OCID of the Managed Database Group.
managedDatabaseIdstringThe OCID of the Managed Database.
namestringA filter to return only resources that match the entire name.
lifecycleStatestringThe lifecycle state of the job.
limitnumberThe maximum number of records returned in the paginated response.
pagestringThe page token representing the page from where the next set of paginated results
are retrieved. This is usually retrieved from a previous list call.
sortBystringThe field to sort information by. Only one sortOrder can be used. The default sort order
for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.
The ‘NAME’ sort order is case-sensitive.
sortOrderstringThe option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.

HEADERS

KeyDatatypeRequiredDescription
opc-request-idstringThe client request ID for tracing.
Acceptstring

RESPONSES

status: OK

{"items":[{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","name":"\u003cstring\u003e","scheduleType":"\u003cstring\u003e","jobType":"SQL","lifecycleState":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","timeUpdated":"\u003cdateTime\u003e","databaseSubType":"NON_CDB","definedTags":{"elit_c":{"consequat04":{},"exercitation_d":{}}},"description":"\u003cstring\u003e","freeformTags":{"eue":"\u003cstring\u003e","aliqua_22":"\u003cstring\u003e"},"managedDatabaseGroupId":"\u003cstring\u003e","managedDatabaseId":"\u003cstring\u003e","scheduleDetails":{"endTime":"\u003cstring\u003e","intervalType":"NEVER","intervalValue":"\u003cstring\u003e","startTime":"\u003cstring\u003e"},"submissionErrorMessage":"\u003cstring\u003e","timeout":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","name":"\u003cstring\u003e","scheduleType":"\u003cstring\u003e","jobType":"SQL","lifecycleState":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","timeUpdated":"\u003cdateTime\u003e","databaseSubType":"ACD","definedTags":{"laborisc6":{"utf":{},"nostrud2":{}},"dolore_7":{"do_e":{}}},"description":"\u003cstring\u003e","freeformTags":{"nisi_63":"\u003cstring\u003e"},"managedDatabaseGroupId":"\u003cstring\u003e","managedDatabaseId":"\u003cstring\u003e","scheduleDetails":{"endTime":"\u003cstring\u003e","intervalType":"NEVER","intervalValue":"\u003cstring\u003e","startTime":"\u003cstring\u003e"},"submissionErrorMessage":"\u003cstring\u003e","timeout":"\u003cstring\u003e"}]}