Get catalogs

GET 
/v1/catalogs

Get catalogs

Request

Header Parameters

Authorization string

Responses

200

Array of published catalogs

application/json

Schema

Schema

• Array [

id uuidrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty

caption stringrequired

Possible values: non-empty

publishedAt date-timenullablerequired
publishedBy stringrequired

Possible values: non-empty

models

object[]

required

Array [

id uuidrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty

caption stringrequired

Possible values: non-empty

description string

connectionIds string[]required

]

deployProvenance

object

gitBranch string

gitCommitId string

changesFrom string

Possible values: [local, committed]

source stringrequired

Possible values: [web, public-api, public-api-git, cli]

deployedAt date-timerequired

• ]

Example (from schema)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "caption": "string",
    "publishedAt": "2024-07-29T15:51:28.071Z",
    "publishedBy": "string",
    "models": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "caption": "string",
        "description": "string",
        "connectionIds": [
          "string"
        ]
      }
    ],
    "deployProvenance": {
      "gitBranch": "string",
      "gitCommitId": "string",
      "changesFrom": "local",
      "source": "web",
      "deployedAt": "2024-07-29T15:51:28.071Z"
    }
  }
]

400

Invalid request for example: Invalid parameters, missing parameters.

401

Unauthorized. This error will occur if calling user does not have access right for the API.

500

A server error occurred. Check the logs for more details.

Loading...