GoliathDevelopersGet an API key
Reference/Spacesgenerated from the gateway manifest

getSpaceTextLines

A text file's lines, numbered, a page at a time.

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

A text file's lines, numbered, a page at a time (N| line; up to 12000 characters a page from startLine, totalLines and endLine say where you are). For a file too large for getSpaceTextContent to return whole: read it page by page, passing the FIRST page's versionId on every later page so all pages come from one version, then add lines with insertSpaceTextLines by these numbers with that versionId as baseVersionId (a save since is refused, never mixed in).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getSpaceTextLines",
    "variables": {
      "itemId": "<itemId>"
    }
  }'
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.getSpaceTextLines({
  itemId: '<itemId>'
})
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: 'getSpaceTextLines',
    variables: {
      itemId: '<itemId>'
    }
  }),
})
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
versionIdID
startLineInt
maxCharsInt

Response

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

response shape
{
  "data": {
    "spacesQuery": {
      "textLines": {
        "versionId": "<ID>",
        "totalLines": 0,
        "startLine": 0,
        "endLine": 0,
        "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.

READlistSpaceRootsREADlistSpaceFolderREADgetSpaceItemREADsearchSpaceItemsREADgetSpaceTextContentREADreadSpaceSheet