Skip to content

Atlassian: Labels schemas

1 Atlassian schema with complete fields and constraints.

โ† Labels operations ยท All schemas

Get all labels โ€” response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]stringEach itemRead only: true
values (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.