Get Jobs Info
Lists jobs in the current tenant for discovery and lifecycle monitoring
Endpoint
GET /api/v3/jobs
Responses
200 (Ok)
Returns JobInfo[] as an array of JobInfo.
403 (Forbidden)
Access restricted. Refer to the response text for more information
Data Contracts
JobInfo
Summary information for a configured job
Fields:
| Name | Type | Description |
|---|---|---|
| JobId | string | Job ID |
| JobName | string | Job name unique within the tenant |
| StartDateUtc | datetime or null | Optional. Date and time when the job was last started, in UTC; null if it has not started |
| CompleteDateUtc | datetime or null | Optional. Date and time when the job completed, in UTC; null if it has not completed |
| EnrollmentState | EnrollmentState or null | Optional. Current retrieval enrollment state; null when the retrieval service is unavailable |
EnrollmentState
Retrieval enrollment lifecycle state for indexed content produced by the job
Enumeration values:
| Name | Description |
|---|---|
| Pending | No indexed snippets have been observed for the job yet |
| Enrolling | At least one indexed snippet is still being enrolled |
| Completed | Indexed snippets for the job are visible in the retrieval index |
| Disabled | Retrieval enrollment is disabled for the job |