Base (Custom Schemas)

Base

PreviousApplication NextEnvironment

Last updated 2 months ago

Create a new base catalog entity

post

/public/v1/catalog/entities/base

Body

namestringrequired

Name of the entity

descriptionstring

Description of the entity

providerResourceTypestringrequired

Provider resource type

detailsobject

Resource details in json format

linksobject[]

List of URLs linked to this entity

metaTagsobject[]

List of metadata tags linked to this entity

parentsobject[]

Catalog entity's parents

generalAccessstring · enum[]

Entity visibility control. By default it is set to a default access control on organization level

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions ("create", "delete", "execute", "modify", "read") associated with each user or team.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/catalog/entities/base' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","providerResourceType":"text","details":{},"links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"generalAccess":["read"],"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

201

400

401

403

422

500

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:03:51.513Z",
  "lastChangedDateTime": "2025-02-21T18:03:51.513Z",
  "providerResourceType": "text",
  "details": {},
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Update a base catalog entity

patch

/public/v1/catalog/entities/base/{id}

Path parameters

idstringrequired

ID of the catalog entity.

Body

namestring

Catalog entity name, should be unique, not updatable for discovery created catalog entity

descriptionstring

Catalog entity description, not updatable for discovery created catalog entity

replaceMetadataTagsboolean

Replace metadata tags with the provided list