GoliathDevelopersGet an API key
Reference/Spacesgenerated from the gateway manifest

searchSpaceText

Find words INSIDE one text file.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

Find words INSIDE one text file: the numbered lines (N| line) holding any of terms (case-insensitive, matches inside longer words), with contextLines (default 2) around each and … between blocks: one read instead of paging a long file with getSpaceTextLines. Pass a few variants of the idea ("hire", "hiring", "recruit"). matchedLines counts every hit; truncated means some were left out for space: narrow the terms or read around a hit with getSpaceTextLines.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "searchSpaceText",
    "variables": {
      "itemId": "<itemId>",
      "terms": [
        "<String>"
      ]
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.spaces.searchSpaceText({
  itemId: '<itemId>',
  terms: [
    '<String>'
  ]
})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'searchSpaceText',
    variables: {
      itemId: '<itemId>',
      terms: [
        '<String>'
      ]
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

itemIdID!required
terms[String!]!required
contextLinesInt
versionIdID

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "spacesQuery": {
      "textSearch": {
        "versionId": "<ID>",
        "totalLines": 0,
        "matchedLines": 0,
        "truncated": true,
        "text": "…"
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READlistSpaceRootsREADlistSpaceFolderREADgetSpaceItemREADsearchSpaceItemsREADgetSpaceTextContentREADgetSpaceTextLines