plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Pagination

Pagination

The envelope, the page and link shapes, the advisory warnings and the shared Ref.

View as Markdown

The collection envelope

As GET /work-items declares it.

dataarray of WorkItemList
metaWorkItemsIndexMeta
Show 2 child fields
meta.pagePageOptionalTotal
Show 4 child fields
meta.page.per_pageinteger

The page size that was applied.

meta.page.next_cursorstring or null

Cursor for the next page, or null on the last one.

meta.page.prev_cursorstring or null

Cursor for the previous page, or null on the first one.

meta.page.totalinteger or null

The total number of matching rows; null unless with_total=1 was sent.

meta.warningsarray of object

Non-fatal notes about this request. Switch on code, never on detail.

Show 6 child fields
meta.warnings.codestring

Machine-readable warning code. Switch on this, never on detail.

include_truncated

New values may be added.

meta.warnings.detailstring

Human-readable explanation.

meta.warnings.pointerstring or null

RFC 6901 pointer into the request body, where the warning is about a body field.

meta.warnings.parameterstring or null

The query-parameter name, brackets included, where the warning is about a parameter.

meta.warnings.sunsetdate (YYYY-MM-DD) or null

Date the deprecated thing stops working.

meta.warnings.replacementstring or null

What to use instead.

Page

per_pageinteger

The page size that was applied.

next_cursorstring or null

Cursor for the next page, or null on the last one. Always null in page mode.

prev_cursorstring or null

Cursor for the previous page, or null on the first one. Always null in page mode.

totalinteger

The total number of matching rows.

current_pageinteger or null

The page number this response answers, echoed from the request even when it exceeds last_page. Null when the request did not send page.

last_pageinteger or null

The highest page number that holds rows: ceil(total / per_page), and 1 on an empty collection. Null when the request did not send page.

PageOptionalTotal

per_pageinteger

The page size that was applied.

next_cursorstring or null

Cursor for the next page, or null on the last one.

prev_cursorstring or null

Cursor for the previous page, or null on the first one.

totalinteger or null

The total number of matching rows; null unless with_total=1 was sent.

Ref

A reference to a record by its id. The full object appears when the relation is included.

idinteger

TagSummary

A tag, as referenced from another resource.

idinteger

Unique identifier.

titlestring≤ 255

Tag title as shown in the UI.

TagSummaryInclude

dataarray of TagSummary≤ 50
metaobject
Show 2 child fields
meta.countinteger≥ 0
meta.truncatedboolean