Entities

Get Entities

GET/api/v1/entities

Query parameters

Response

200422

Successful Response

Body

application/json

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

JavaScriptCurlPython

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

Response

200422

{
  "items": [
    {
      "id": "text",
      "blueprintId": "text",
      "title": "text",
      "description": "text",
      "isActive": true,
      "isHidden": false,
      "createdAt": "2025-01-20T18:54:29.936Z",
      "createdBy": 0,
      "updatedAt": "2025-01-20T18:54:29.936Z",
      "updatedBy": 0
    }
  ],
  "total": 0,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Entity

POST/api/v1/entities

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Response

200422

Successful Response

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurlPython

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

200422

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2025-01-20T18:54:29.936Z",
  "createdBy": 0,
  "updatedAt": "2025-01-20T18:54:29.936Z",
  "updatedBy": 0
}

Get Entity

GET/api/v1/entities/{id_}

Path parameters

id_*Id

Pattern: ^([a-z0-9_.-]+)$

Query parameters

Response

200422

Successful Response

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

Request

JavaScriptCurlPython

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

Response

200422

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2025-01-20T18:54:29.936Z",
  "createdBy": 0,
  "updatedAt": "2025-01-20T18:54:29.936Z",
  "updatedBy": 0
}

Upsert Entity

PUT/api/v1/entities/{id_}

Path parameters

id_*Id

Pattern: ^([a-z0-9_.-]+)$

Query parameters

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

titleTitle

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Response

200422

Successful Response

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurlPython

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

200422

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2025-01-20T18:54:29.936Z",
  "createdBy": 0,
  "updatedAt": "2025-01-20T18:54:29.936Z",
  "updatedBy": 0
}

Delete Entity

DELETE/api/v1/entities/{id_}

Path parameters

id_*Id

Pattern: ^([a-z0-9_.-]+)$

Response

204422

Successful Response

Request

JavaScriptCurlPython

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

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Create Or Update Entities Bulk

PUT/api/v1/entities/bulk

Query parameters

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

titleTitle

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Response

201422

Successful Response

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurlPython

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

201422

[
  {
    "id": "text",
    "blueprintId": "text",
    "title": "text",
    "description": "text",
    "isActive": true,
    "isHidden": false,
    "createdAt": "2025-01-20T18:54:29.936Z",
    "createdBy": 0,
    "updatedAt": "2025-01-20T18:54:29.936Z",
    "updatedBy": 0
  }
]

Validate Entity

POST/api/v1/entities/validate

Body

application/json

id*Id

Pattern: ^([a-z0-9_.-]+)$

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

sourcesSources

Response

200422

Successful Response

Body

application/json

valid*Valid

errorsErrors

Request

JavaScriptCurlPython

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

200422

{
  "valid": false,
  "errors": []
}

Troubleshooting

Troubleshooting