Skip to main content

Get Labels

GET /labels

Retrieve the assets used in a given program

Request Parameters

Query Parameters

NameTypeDescription
searchstring

Term will be searched for in any field

pageinteger

Default: 1

sizeinteger

Default: 50

Header Parameters

NameTypeDescription
program-id requiredstring

Responses

200 Successful Response

PageLabel | application/json

NameTypeProperties
items requiredarray

items: {'$ref': '#/components/schemas/Label'}

total requiredinteger

minimum: 0.0

page requiredinteger

minimum: 1.0

size requiredinteger

minimum: 1.0

Label | application/json

NameTypeProperties
label requiredstring

maxLength: 64

weight requirednumber

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

NameTypeProperties
detailarray

items: {'$ref': '#/components/schemas/ValidationError'}

ValidationError | application/json

NameTypeProperties
loc requiredarray

items: {'anyOf': [{'type': 'string'}, {'type': 'integer'}]}

msg requiredstring
type requiredstring