Atlassian · Schema

PagedListUserDetailsApplicationUser

A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
end-index integer The index of the last item returned on the page.
items array The list of items.
max-results integer The maximum number of results that could be on the page.
size integer The number of items on the page.
start-index integer The index of the first item returned on the page.
View JSON Schema on GitHub

JSON Schema

atlassian-pagedlistuserdetailsapplicationuser-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PagedListUserDetailsApplicationUser",
  "title": "PagedListUserDetailsApplicationUser",
  "additionalProperties": false,
  "description": "A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40.",
  "properties": {
    "end-index": {
      "description": "The index of the last item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true,
        "name": "end-index"
      }
    },
    "items": {
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/UserDetails"
      },
      "readOnly": true,
      "type": "array"
    },
    "max-results": {
      "description": "The maximum number of results that could be on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true,
        "name": "max-results"
      }
    },
    "size": {
      "description": "The number of items on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true
      }
    },
    "start-index": {
      "description": "The index of the first item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer",
      "xml": {
        "attribute": true,
        "name": "start-index"
      }
    }
  },
  "type": "object"
}