Get Labels
GET /labelsRetrieve the assets used in a given program
Request Parameters
Query Parameters
| Name | Type | Description |
|---|---|---|
search | string | Term will be searched for in any field |
page | integer | Default: 1 |
size | integer | Default: 50 |
Header Parameters
| Name | Type | Description |
|---|---|---|
program-id required | string |
Responses
200 Successful Response
PageLabel | application/json
| Name | Type | Properties |
|---|---|---|
items required | array | items: {'$ref': '#/components/schemas/Label'} |
total required | integer | minimum: 0.0 |
page required | integer | minimum: 1.0 |
size required | integer | minimum: 1.0 |
Label | application/json
| Name | Type | Properties |
|---|---|---|
label required | string | maxLength: 64 |
weight required | number | description: The strength of the action recommendation for the given user. Higher values mean stronger recommendation. |
Response Example
{
"items": [
{
"label": "string",
"weight": "number"
}
],
"total": "integer",
"page": "integer",
"size": "integer"
}
422 Validation Error
HTTPValidationError | application/json
| Name | Type | Properties |
|---|---|---|
detail | array | items: {'$ref': '#/components/schemas/ValidationError'} |
ValidationError | application/json
| Name | Type | Properties |
|---|---|---|
loc required | array | items: {'anyOf': [{'type': 'string'}, {'type': 'integer'}]} |
msg required | string | |
type required | string |