Skip to content
AveraAveraAvera Documentation

Read the rows of a configured grid view

POST
/api/v1/projects/{projectId}/grid/rows
curl --request POST \
  --url https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/grid/rows \
  --header 'Content-Type: application/json' \
  --data '{ "itemTypeId": "example", "anchorKind": "example", "subtree": { "rootItemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "relationshipTypeId": "example", "direction": "example", "maxDepth": 1 }, "thisItemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "levels": [ { "relationshipTypeId": "example", "direction": "example", "itemTypeId": "example", "recursive": true, "maxDepth": 1 } ], "relationshipColumns": [ { "key": "example", "relationshipTypeId": "example", "direction": "example", "itemTypeId": "example" } ], "lookupColumns": [ { "key": "example", "path": [ { "relationshipTypeId": "example", "direction": "example", "itemTypeId": "example", "recursive": true, "maxDepth": 1 } ], "slug": "example" } ] }'

A POST because the query is a structure: an anchor, an ordered chain of levels and a set of relationship columns. Each row carries its item’s seq, which the paired batch-apply endpoint takes as the expected seq that turns a stale edit into a reported conflict rather than a silent clobber.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
itemTypeId
string | null
anchorKind
string | null
subtree
One of:
object
rootItemId
required
string format: uuid
relationshipTypeId
required
string
direction
required
string
maxDepth
required
integer format: int32
thisItemId
string | null format: uuid
levels
required
Array<object>
object
relationshipTypeId
required
string
direction
required
string
itemTypeId
string | null
recursive
required
boolean
maxDepth
integer | null format: int32
relationshipColumns
required
Array<object>
object
key
required
string
relationshipTypeId
required
string
direction
required
string
itemTypeId
string | null
lookupColumns
required
Array<object>
object
key
required
string
path
required
Array<object>
object
relationshipTypeId
required
string
direction
required
string
itemTypeId
string | null
recursive
required
boolean
maxDepth
integer | null format: int32
slug
required
string

Example generated

{
  "itemTypeId": "example",
  "anchorKind": "example",
  "subtree": {
    "rootItemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relationshipTypeId": "example",
    "direction": "example",
    "maxDepth": 1
  },
  "thisItemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "levels": [
    {
      "relationshipTypeId": "example",
      "direction": "example",
      "itemTypeId": "example",
      "recursive": true,
      "maxDepth": 1
    }
  ],
  "relationshipColumns": [
    {
      "key": "example",
      "relationshipTypeId": "example",
      "direction": "example",
      "itemTypeId": "example"
    }
  ],
  "lookupColumns": [
    {
      "key": "example",
      "path": [
        {
          "relationshipTypeId": "example",
          "direction": "example",
          "itemTypeId": "example",
          "recursive": true,
          "maxDepth": 1
        }
      ],
      "slug": "example"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
rows
required
Array<object>
object
canonicalId
required
string format: uuid
itemId
required
string format: uuid
number
required
string
itemTypeId
required
string
status
required
string
revision
string | null
seq
required
integer format: int64
depth
required
integer format: int32
parentCanonicalId
string | null format: uuid
levelKind
required
string
Allowed values: FRAMEWORK ANALYSIS
attributes
required
object
key
additional properties
frozenAttributeIds
required
Array<string>
relationships
required
object
key
additional properties
Array<object>
object
canonicalId
required
string format: uuid
itemId
required
string format: uuid
number
required
string
title
string | null
itemTypeId
required
string
status
required
string
suspect
required
boolean
rollup
One of:
object
own
required
integer format: int32
missingByColumn
required
object
key
additional properties
integer format: int32
lookups
required
object
key
additional properties
Array<object>
object
canonicalId
required
string format: uuid
itemId
required
string format: uuid
number
required
string
value
null
via
One of:
object
relationshipTypeId
required
string
direction
required
string
position
integer | null format: int32
sectionNumber
string | null
sectionTitle
string | null
outlineNumber
string | null
verdict
string | null