AlmondTill/G3N API

On this page

search

query · in the family Reading your records

What it does

Name search across your records — type-ahead by caption within your own group.

Caption typeahead within the caller's OWN org-group family; requires authentication. Scoped server-side to the principal's rootId (never cross-tenant); the prefix folds case/diacritic-insensitively; limit defaults + clamps server-side.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
typeSearchableType SearchableType!yesNo further notes.
prefixString String!yesNo further notes.
limitIntnoHow many records to answer at most; a page may hold fewer.

Returns

SearchHit [SearchHit!]! — One caption-search typeahead hit — the display projection of a matched construct.

Example request

query ExampleSearch($type: SearchableType!, $prefix: String!, $limit: Int) {
  search(type: $type, prefix: $prefix, limit: $limit) {
    id
    type
    rootId
    caption
    status
    sysId
  }
}

Variables:

{
  "type": "Organization",
  "prefix": "<prefix>",
  "limit": 1
}

Example response

{
  "data": {
    "search": [
      {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "type": "Organization",
        "rootId": "01900000-0000-7000-8000-a093dd800000",
        "caption": "Blue jeans",
        "status": "<status>",
        "sysId": "<sys id>"
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer