Skip to content
Artbucket

What it comes from and what uses it

GET
/api/v1/catalog/{ref}/lineage
curl --request GET \
  --url 'http://localhost:3000/api/v1/catalog/example/lineage?depth=3' \
  --header 'Authorization: Bearer <token>'

Hop by hop, through what you can reach only: unseen counts what you can’t. Each node says how many edges it has each way (up, down), so a client can expand it. impact is what changing it reaches.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string

An id, or an address

Query Parameters

Section titled “Query Parameters”
direction
string

Up, down, or up,down (the default)

depth
integer
default: 3 >= 1 <= 6

Hops each way

Responses

Section titled “Responses”

200

Section titled “200”

Lineage

Media typeapplication/json
object
root
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
nodes
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
type
required
string
Allowed values: brand collection asset site rule page component
slug
required
string
name
required
string
address
required

{org}/{project}/{type}/{slug}[@release]; a part after its object

string
description
required
string | null
status
required
string
Allowed values: draft in_review current replaced archived
release
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
expires
required
string | null
expiring
required
boolean
private
required
boolean
tags
required
Array<string>
project
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
slug
required
string
name
required
string
parent
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
type
required
string
Allowed values: brand collection asset site rule page component
slug
required
string
name
required
string
createdAt
required
string
updatedAt
required
string
up
required
integer
>= -9007199254740991 <= 9007199254740991
down
required
integer
>= -9007199254740991 <= 9007199254740991
license

An asset’s license (rights.license); absent on other types

string | null
versions

How many versions an asset’s stack holds; release is which one this is

integer
>= -9007199254740991 <= 9007199254740991
edges
required
Array<object>
object
from
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
to
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
via
required
string | null
unseen
required
integer
>= -9007199254740991 <= 9007199254740991
impact
required
object
things
required
integer
>= -9007199254740991 <= 9007199254740991
projects
required
integer
>= -9007199254740991 <= 9007199254740991
line
required
string
Example
{
  "nodes": [
    {
      "type": "brand",
      "status": "draft",
      "parent": {
        "type": "brand"
      }
    }
  ]
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}