List outcomes
Units of business work counted against a request.
Lists recorded outcomes.
Request
GET /v1/organisations/{organisation}/outcomesGET /v1/organisations/{organisation}/workspaces/{workspace}/outcomes
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
pageSize |
query | integer | no | Maximum outcomes to return. |
pageToken |
query | string | no | A page token from a previous response, to retrieve the next page. |
Response
| Field | Type | What it is |
|---|---|---|
outcomes |
list of object | The outcomes in this page. |
nextPageToken |
string | Token to retrieve the next page, empty when there are no more. |
Each item of the list
| Field | Type | What it is |
|---|---|---|
name |
string | The resource name of the outcome. |
outcomeDefinition |
string | The kind of outcome being counted. |
request |
string | The request that produced it, matching Activity.request. |
quantity |
int64 as string | How many were produced, e.g. 12 candidates on one shortlist. |
occurredAt |
timestamp | When the outcome was produced. |
etag |
string | Entity tag. |
createTime |
timestamp | When this outcome was recorded. |
updateTime |
timestamp | When this outcome was last updated. |
The OpenAPI document has every field. All methods.