List references

List references available in the requested location.

GET/api/reference

Query parameters

locationobject | any

Responses

200Success

locationLocation.Inforequired

Show properties

directorystringrequired

workspaceIDobject

Show properties

object

projectobjectrequired

Show properties

idstringrequired

directorystringrequired

dataReference.Info[]required

Show properties

Array of Reference.Info

namestringrequired

pathstringrequired

descriptionstring

hiddenboolean

sourceReference.Sourcerequired

Show properties

Any of:

Reference.LocalSource

typestringrequired

Allowed:local

pathstringrequired

descriptionstring

hiddenboolean

Reference.GitSource

typestringrequired

Allowed:git

repositorystringrequired

branchstring

descriptionstring

hiddenboolean

400InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

Request

curl -X GET "/api/reference"

const response = await fetch("/api/reference", {
  method: "GET"
});

import requests

response = requests.get(
    "/api/reference",
)

Response

{
  "location": {
    "directory": "string",
    "workspaceID": {},
    "project": {
      "id": "string",
      "directory": "string"
    }
  },
  "data": [
    {
      "name": "string",
      "path": "string",
      "description": "string",
      "hidden": true,
      "source": {
        "type": "local",
        "path": "string",
        "description": "string",
        "hidden": true
      }
    }
  ]
}