Blueprints

Get Blueprints

GET/api/v1/blueprints

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/blueprints', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "schemaProperties": {
        "type": "object",
        "title": "text",
        "description": "text",
        "format": "text",
        "items": {
          "type": [
            "text"
          ],
          "title": "text",
          "description": "text",
          "format": "text",
          "items": {},
          "icon": "text",
          "enum": [],
          "additionalProperties": false,
          "readOnly": false
        },
        "icon": "text",
        "enum": [],
        "additionalProperties": false,
        "readOnly": false
      },
      "options": {
        "showInSideBar": true
      },
      "isActive": true,
      "isHideable": true,
      "createdAt": "2024-10-22T05:11:29.633Z",
      "updatedAt": "2024-10-22T05:11:29.633Z",
      "userEditable": false,
      "userDeletable": false
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Blueprint

POST/api/v1/blueprints

Query parameters

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

Successful Response

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

userEditable*Usereditable

userDeletable*Userdeletable

Request

const response = await fetch('/api/v1/blueprints', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "items": {},
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-10-22T05:11:29.633Z",
  "updatedAt": "2024-10-22T05:11:29.633Z",
  "userEditable": false,
  "userDeletable": false
}

Create Or Update Blueprint

PUT/api/v1/blueprints

Query parameters

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

Successful Response

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

userEditable*Usereditable

userDeletable*Userdeletable

Request

const response = await fetch('/api/v1/blueprints', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "items": {},
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-10-22T05:11:29.633Z",
  "updatedAt": "2024-10-22T05:11:29.633Z",
  "userEditable": false,
  "userDeletable": false
}

Create Or Update Blueprints Bulk

PUT/api/v1/blueprints/bulk

Query parameters

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

Successful Response

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

userEditable*Usereditable

userDeletable*Userdeletable

Request

const response = await fetch('/api/v1/blueprints/bulk', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "title": "text"
      }
    ]),
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "title": "text",
    "description": "text",
    "icon": "text",
    "schemaProperties": {
      "type": "object",
      "title": "text",
      "description": "text",
      "format": "text",
      "items": {
        "type": [
          "text"
        ],
        "title": "text",
        "description": "text",
        "format": "text",
        "items": {},
        "icon": "text",
        "enum": [],
        "additionalProperties": false,
        "readOnly": false
      },
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "options": {
      "showInSideBar": true
    },
    "isActive": true,
    "isHideable": true,
    "createdAt": "2024-10-22T05:11:29.633Z",
    "updatedAt": "2024-10-22T05:11:29.633Z",
    "userEditable": false,
    "userDeletable": false
  }
]

Get Blueprint

GET/api/v1/blueprints/{id_}

Path parameters

id_*Id

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

Query parameters

Response

Successful Response

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

userEditable*Usereditable

userDeletable*Userdeletable

Request

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "items": {},
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-10-22T05:11:29.633Z",
  "updatedAt": "2024-10-22T05:11:29.633Z",
  "userEditable": false,
  "userDeletable": false
}

Update Blueprint

PUT/api/v1/blueprints/{id_}

Path parameters

id_*Id

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

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

Successful Response

Body

id*Id

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

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

userEditable*Usereditable

userDeletable*Userdeletable

Request

const response = await fetch('/api/v1/blueprints/{id_}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "items": {},
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-10-22T05:11:29.633Z",
  "updatedAt": "2024-10-22T05:11:29.633Z",
  "userEditable": false,
  "userDeletable": false
}

Delete Blueprint

DELETE/api/v1/blueprints/{id_}

Path parameters

id_*Id

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

Response

Successful Response

Request

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

Response

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

Get Blueprint Schema Properties

GET/api/v1/blueprints/{id_}/schemaProperties

Path parameters

id_*Id

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

Response

Successful Response

Body

Other propertiesJsonSchema

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

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

Response

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

Create Blueprint Schema Properties

POST/api/v1/blueprints/{id_}/schemaProperties

Path parameters

id_*Id

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

Body

Other propertiesJsonSchema

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Response

Successful Response

Body

Other propertiesJsonSchema

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

const response = await fetch('/api/v1/blueprints/{id_}/schemaProperties', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

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

Update Blueprint Schema Properties

PUT/api/v1/blueprints/{id_}/schemaProperties

Path parameters

id_*Id

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

Body

Other propertiesJsonSchema

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Response

Successful Response

Body

Other propertiesJsonSchema

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

const response = await fetch('/api/v1/blueprints/{id_}/schemaProperties', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

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

Delete Blueprint Schema Properties

DELETE/api/v1/blueprints/{id_}/schemaProperties/{schema_property_key}

Path parameters

id_*Id

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

schema_property_key*Schema Property Key

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

Response

Successful Response

Request

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

Response

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

Get Blueprint Relations

GET/api/v1/blueprints/{id_}/relations

Path parameters

id_*Id

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

Response

Successful Response

Body

Other propertiesBlueprintRelation

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

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

Response

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

Create Blueprint Relations

POST/api/v1/blueprints/{id_}/relations

Path parameters

id_*Id

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

Body

Other propertiesBlueprintRelation

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Response

Successful Response

Body

Other propertiesBlueprintRelation

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

const response = await fetch('/api/v1/blueprints/{id_}/relations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

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

Update Blueprint Relations

PUT/api/v1/blueprints/{id_}/relations

Path parameters

id_*Id

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

Body

Other propertiesBlueprintRelation

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Response

Successful Response

Body

Other propertiesBlueprintRelation

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

const response = await fetch('/api/v1/blueprints/{id_}/relations', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

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

Delete Blueprint Relations

DELETE/api/v1/blueprints/{id_}/relations/{relation_key}

Path parameters

id_*Id

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

relation_key*Relation Key

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

Response

Successful Response

Request

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

Response

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

Get Blueprint Reference Properties

GET/api/v1/blueprints/{id_}/referenceProperties

Path parameters

id_*Id

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

Response

Successful Response

Body

Other propertiesReferenceProperty

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

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

Response

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

Create Blueprint Reference Properties

POST/api/v1/blueprints/{id_}/referenceProperties

Path parameters

id_*Id

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

Body

Other propertiesReferencePropertyCreateOrUpdate

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Response

Successful Response

Body

Other propertiesReferenceProperty

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

const response = await fetch('/api/v1/blueprints/{id_}/referenceProperties', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

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

Update Blueprint Reference Properties

PUT/api/v1/blueprints/{id_}/referenceProperties

Path parameters

id_*Id

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

Body

Other propertiesReferencePropertyCreateOrUpdate

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Response

Successful Response

Body

Other propertiesReferenceProperty

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

Request

const response = await fetch('/api/v1/blueprints/{id_}/referenceProperties', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

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

Delete Blueprint Reference Property

DELETE/api/v1/blueprints/{id_}/referenceProperties/{ref_property_key}

Path parameters

id_*Id

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

ref_property_key*Ref Property Key

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

Response

Successful Response

Request

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

Response

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

Troubleshooting

PreviousAutomation Suggestions NextDashboards & Views

Last updated 5 months ago