Entities

Get Entities

GET/api/v1/entities
Query parameters
Response

Successful Response

Body
items*Items
totalTotal

Total items

current_pageCurrent Page

Cursor to refetch the current page

current_page_backwardsCurrent Page Backwards

Cursor to refetch the current page starting from the last item

previous_pagePrevious Page

Cursor for the previous page

next_pageNext Page

Cursor for the next page

Request
const response = await fetch('/api/v1/entities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "items": [
    {
      "id": "text",
      "blueprintId": "text",
      "title": "text",
      "description": "text",
      "isActive": true,
      "isHidden": false,
      "createdAt": "2024-07-15T00:45:49.070Z",
      "updatedAt": "2024-07-15T00:45:49.070Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Entity

POST/api/v1/entities
Body
id*Id
blueprintId*Blueprintid
title*Title
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
Response

Successful Response

Body
id*Id
blueprintId*Blueprintid
title*Title
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
createdAt*Createdat
createdByCreatedby
updatedAt*Updatedat
updatedByUpdatedby
referencePropertiesReferenceproperties
Request
const response = await fetch('/api/v1/entities', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "blueprintId": "text",
      "title": "text"
    }),
});
const data = await response.json();
Response
{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2024-07-15T00:45:49.070Z",
  "updatedAt": "2024-07-15T00:45:49.070Z"
}

Get Entity

GET/api/v1/entities/{id_}
Path parameters
id_*Id
Query parameters
Response

Successful Response

Body
id*Id
blueprintId*Blueprintid
title*Title
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
createdAt*Createdat
createdByCreatedby
updatedAt*Updatedat
updatedByUpdatedby
referencePropertiesReferenceproperties
Request
const response = await fetch('/api/v1/entities/{id_}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2024-07-15T00:45:49.070Z",
  "updatedAt": "2024-07-15T00:45:49.070Z"
}

Upsert Entity

PUT/api/v1/entities/{id_}
Path parameters
id_*Id
Query parameters
Body
id*Id
blueprintId*Blueprintid
titleTitle
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
Response

Successful Response

Body
id*Id
blueprintId*Blueprintid
title*Title
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
createdAt*Createdat
createdByCreatedby
updatedAt*Updatedat
updatedByUpdatedby
referencePropertiesReferenceproperties
Request
const response = await fetch('/api/v1/entities/{id_}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "blueprintId": "text"
    }),
});
const data = await response.json();
Response
{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2024-07-15T00:45:49.070Z",
  "updatedAt": "2024-07-15T00:45:49.070Z"
}

Delete Entity

DELETE/api/v1/entities/{id_}
Path parameters
id_*Id
Response

Successful Response

Request
const response = await fetch('/api/v1/entities/{id_}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Create Or Update Entities Bulk

PUT/api/v1/entities/bulk
Query parameters
Body
id*Id
blueprintId*Blueprintid
titleTitle
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
Response

Successful Response

Body
id*Id
blueprintId*Blueprintid
title*Title
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
createdAt*Createdat
createdByCreatedby
updatedAt*Updatedat
updatedByUpdatedby
referencePropertiesReferenceproperties
Request
const response = await fetch('/api/v1/entities/bulk', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "blueprintId": "text"
      }
    ]),
});
const data = await response.json();
Response
[
  {
    "id": "text",
    "blueprintId": "text",
    "title": "text",
    "description": "text",
    "isActive": true,
    "isHidden": false,
    "createdAt": "2024-07-15T00:45:49.070Z",
    "updatedAt": "2024-07-15T00:45:49.070Z"
  }
]

Validate Entity

POST/api/v1/entities/validate
Body
id*Id
blueprintId*Blueprintid
title*Title
descriptionDescription
isActiveIsactive
isHiddenIshidden
propertiesProperties
relationsRelations
sourcesSources
Response

Successful Response

Body
valid*Valid
errorsErrors
Request
const response = await fetch('/api/v1/entities/validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "blueprintId": "text",
      "title": "text"
    }),
});
const data = await response.json();
Response
{
  "valid": false,
  "errors": []
}

Troubleshooting

Troubleshooting

Last updated