Lookups

📘

Getting started

To get started, see lookups in the app components guide.

Schemas

AttachedResource

The response to a successful lookup request.

PropertyTypeDescription
errorstringThe error that should be displayed to the user.
resource_name (required)stringThe name of the attached resource.
resource_url (required)stringThe URL of the attached resource.
{
  "error": "No resource matched that input",
  "resource_name": "Build the Thing",
  "resource_url": "https://example.atlassian.net/browse/CP-1"
}

TypeaheadList

The response to a successful typeahead request.

PropertyTypeDescription
headerstringOptional. Header text to display above the list of typeahead results. If no header is passed in or the value is an empty string, only the typeahead results with be rendered.
items (required)[object]Array of TypeaheadItem objects that indicate typeahead results.
» icon_urlstringThe URL of the icon to display next to the title.
» subtitlestringThe subtitle of the typeahead item.
» title (required)stringThe title of the typeahead item.
» value (required)stringThe value of the typeahead item.
{
  "header": "List of messages",
  "items": [
    {
      "icon_url": "https://example-icon.png",
      "subtitle": "OTP",
      "title": "OTP Team PF",
      "value": "OTP"
    }
  ]
}

TypeaheadItem

An object describing a typeahead result.

PropertyTypeDescription
icon_urlstringThe URL of the icon to display next to the title.
subtitlestringThe subtitle of the typeahead item.
title (required)stringThe title of the typeahead item.
value (required)stringThe value of the typeahead item.
{
  "icon_url": "https://example-icon.png",
  "subtitle": "OTP",
  "title": "OTP Team PF",
  "value": "OTP"
}

Error schemas

BadRequest

PropertyTypeDescription
dataobjectAn object containing an error string to display to the user.
» errorstringThe error to display.

An error response object indicating a bad request (i.e., a status code of 400).

{
  "data": {
    "error": "Illegal or malformed request."
  }
}

Forbidden

An error response object indicating a forbidden request (i.e., a status code of 403).

PropertyTypeDescription
dataobjectAn object containing an error string to display to the user.
» errorstringThe error to display.
{
  "data": {
    "error": "Access forbidden."
  }
}

InternalServerError

An error response object indicating a request that could not be found (i.e., a status code of 500).

PropertyTypeDescription
dataobjectAn object containing an error string to display to the user.
» errorstringThe error to display.
{
  "data": {
    "error": "Internal server error."
  }
}

NotFound

An error response object indicating a request that could not be found (i.e., a status code of 404).

PropertyTypeDescription
dataobjectAn object containing an error string to display to the user.
» errorstringThe error to display.
{
  "data": {
    "error": "Not found."
  }
}

Unauthorized

An error response object indicating a unauthorized request (i.e., a status code of 401).

PropertyTypeDescription
dataobjectAn object containing an error string to display to the user.
» errorstringThe error to display.
{
  "data": {
    "error": "Authorization required."
  }
}