Relation Endpoints

Relation Endpoints

• Get a list of catalog relations

• Create a relation between two catalog entities

• Drop a relation between two catalog entities

Relation Endpoints

NB: create/delete relations between discovery created resources are forbidden

GET a list of catalog relations.

GEThttps://app.configure8.io/public/v1/catalog/relations

Query parameters

Response

200

Body

application/json

totalFound*number

Total elements found

pageNumber*number

pageSize*number

items*array of CatalogRelationDto (object)

Found catalog entities

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/relations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "items": [
    {
      "sourceEntityId": "text",
      "targetEntityId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ]
}

Create relation between catalog entities. NB: Resource-Resource relations are available only for non-discovery created resources.

POSThttps://app.configure8.io/public/v1/catalog/relations

Body

application/json

serviceIdstring

Service id as an additional relation parameter. Used ONLY when creating Environment-Resource relation

sourceEntityId*string

Id of the entity from which we want to create a relation

targetEntityId*string

Id of the entity to which we want to create a relation

label*enum

Entity relation type

belongs_todepends_onprovideshas_environmentpart_ofconsumesusescontainshas_repositoryhas_libraryhas_manifesthas_dependencychild_ofrelative_toowned_by

fieldstring

Entity relation field

Response

201400401403404422

Body

application/json

sourceEntityId*string

targetEntityId*string

label*enum

Entity relation type

belongs_todepends_onprovideshas_environmentpart_ofconsumesusescontainshas_repositoryhas_libraryhas_manifesthas_dependencychild_ofrelative_toowned_by

fieldstring

Entity relation field

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/catalog/relations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceEntityId": "text",
      "targetEntityId": "text",
      "label": "belongs_to"
    }),
});
const data = await response.json();

Response

201

{
  "sourceEntityId": "text",
  "targetEntityId": "text",
  "label": "belongs_to",
  "field": "text"
}

Delete catalog entity relation.

DELETEhttps://app.configure8.io/public/v1/catalog/relations

Body

application/json

serviceIdstring

Catalog relation service id

sourceEntityId*string

Catalog Source entity id

targetEntityId*string

Catalog Target entity id

fieldstring

Entity relation field

Response

200401403404422

Request

JavaScriptCurlPython

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