Batch Endpoints

Batch Endpoints

• Create Resource entity

• Create Base entity

• Drop catalog entities

Batch Endpoints

NB: max batch size equals 50 elements

Batch create new resource catalog entities

POSThttps://app.configure8.io/public/v1/catalog/batch/entities/resource

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity

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.

generalAccessarray of enum

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

parentsarray of EntityParentDto (object)

Catalog entity's parents

providerResourceKey*string

The key/ID of the resource in the provider

Example: "123456789012"

provider*string

Provider name

providerResourceType*string

Provider resource type

providerAccountIdstring

The key/ID of the account that owns this resource

locationstring

Resource location

detailsobject

Resource details in json format

deepLinkUrlstring

Deep link to the resource

Response

200401403

Body

application/json

success*number

Number of successfully saved entities

failures*number

Number of entities that failed saving

items*array of CatalogResourceDto (object)

Created resources

failed*array of FailedResource (object)

Failed resources

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/batch/entities/resource', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text",
        "providerResourceKey": "123456789012",
        "provider": "text",
        "providerResourceType": "text"
      }
    ]),
});
const data = await response.json();

Response

200

{
  "success": 0,
  "failures": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "type": "application",
      "description": "text",
      "metaTags": [
        {
          "name": "text",
          "value": "text",
          "type": "JSON",
          "createdBy": "MANUAL"
        }
      ],
      "links": [
        {
          "url": "text",
          "title": "text",
          "icon": "text"
        }
      ],
      "parents": [
        {
          "id": "text",
          "secondaryId": "text",
          "label": "belongs_to",
          "field": "text"
        }
      ],
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2024-11-21T06:29:25.688Z",
      "lastChangedDateTime": "2024-11-21T06:29:25.688Z",
      "generalAccess": [
        "read"
      ],
      "provider": "text",
      "providerType": "text",
      "providerResourceKey": "text",
      "providerResourceType": "text",
      "providerAccountId": "text",
      "location": "text",
      "deepLinkUrl": "text"
    }
  ],
  "failed": [
    {
      "providerResourceKey": "text",
      "status": 0,
      "error": "text"
    }
  ]
}

Batch create new base catalog entities

POSThttps://app.configure8.io/public/v1/catalog/batch/entities/base

Body

application/json

name*string

Name of the entity

descriptionstring

Description of the entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity

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.

generalAccessarray of enum

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

parentsarray of EntityParentDto (object)

Catalog entity's parents

providerResourceType*string

Provider resource type

detailsobject

Resource details in json format

Response

200

Body

application/json

success*number

Number of successfully saved entities

failures*number

Number of entities that failed saving

items*array of CatalogBaseDto (object)

Created base entities

failed*array of FailedBase (object)

Failed base entites

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/batch/entities/base', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text",
        "providerResourceType": "text"
      }
    ]),
});
const data = await response.json();

Response

200

{
  "success": 0,
  "failures": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "type": "application",
      "description": "text",
      "metaTags": [
        {
          "name": "text",
          "value": "text",
          "type": "JSON",
          "createdBy": "MANUAL"
        }
      ],
      "links": [
        {
          "url": "text",
          "title": "text",
          "icon": "text"
        }
      ],
      "parents": [
        {
          "id": "text",
          "secondaryId": "text",
          "label": "belongs_to",
          "field": "text"
        }
      ],
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2024-11-21T06:29:25.688Z",
      "lastChangedDateTime": "2024-11-21T06:29:25.688Z",
      "generalAccess": [
        "read"
      ],
      "providerResourceType": "text"
    }
  ],
  "failed": [
    {
      "name": "text",
      "status": 0,
      "error": "text"
    }
  ]
}

Batch delete the specified catalog entities

DELETEhttps://app.configure8.io/public/v1/catalog/batch/entities

Body

application/json

ids*array of string

Ids of entities to delete

Response

200401403

Body

application/json

deleted*number

Number of deleted entities

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/batch/entities', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "deleted": 0
}