Blueprints

Get Blueprints

get

/api/v1/blueprints

Authorizations

Query parameters

includeReferenceSchemaIncludereferenceschema

excludePluginBlueprintsExcludepluginblueprints

filterPluginBlueprintsFilterpluginblueprints

Filter plugin blueprints by data source

searchQuerySearchquery

filtersFilters

sortsSorts

cursorCursor

sizeSize

includeTotalIncludetotal

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/blueprints' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

200

{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "schemaProperties": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "type": "object",
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": {
          "^([a-zA-Z0-9_.-]+)$": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          }
        }
      },
      "options": {
        "showInSideBar": true,
        "propertiesGroups": {
          "ANY_ADDITIONAL_PROPERTY": {
            "order": 1,
            "title": "text",
            "description": "",
            "properties": [
              "text"
            ]
          }
        }
      },
      "isActive": true,
      "isHideable": true,
      "createdAt": "2025-02-21T18:19:13.075Z",
      "createdBy": 1,
      "updatedAt": "2025-02-21T18:19:13.075Z",
      "updatedBy": 1,
      "userEditable": true,
      "userDeletable": true,
      "referenceProperties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "relation": "text",
          "property": "text",
          "schema": "[Circular Reference]"
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "relation": "text",
          "property": "text",
          "schema": "[Circular Reference]"
        }
      },
      "calculationProperties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "icon": "text",
          "unit": "text",
          "outputType": "number",
          "method": "aggregation",
          "sql": "text",
          "aggregation": {
            "function": "count",
            "calculatedBy": "entities",
            "targetBlueprint": "text",
            "targetProperty": "text",
            "measureTimeBy": "text",
            "filters": [
              {
                "field": "text",
                "operator": "eq",
                "value": null
              }
            ]
          }
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "icon": "text",
          "unit": "text",
          "outputType": "number",
          "method": "aggregation",
          "sql": "text",
          "aggregation": {
            "function": "count",
            "calculatedBy": "entities",
            "targetBlueprint": "text",
            "targetProperty": "text",
            "measureTimeBy": "text",
            "filters": [
              {
                "field": "text",
                "operator": "eq",
                "value": null
              }
            ]
          }
        }
      },
      "relations": {
        "^([a-zA-Z0-9_.-]+)$": {
          "value": "text",
          "array": false,
          "title": "text",
          "description": "text"
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "array": false,
          "title": "text",
          "description": "text"
        }
      }
    }
  ]
}

Successful Response

Create Blueprint

post

/api/v1/blueprints

Authorizations

Query parameters

userEditableUsereditable

Body

idIdrequired

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

titleTitlerequired

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.

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/blueprints' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","title":"text","schemaProperties":{"type":"object","enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]}}},"options":{"showInSideBar":true,"propertiesGroups":{"ANY_ADDITIONAL_PROPERTY":{"order":1,"title":"text","description":"","properties":["text"]}}},"isActive":true,"isHideable":true,"referenceProperties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","relation":"text","property":"text"},"ANY_ADDITIONAL_PROPERTY":{"title":"text","relation":"text","property":"text"}},"calculationProperties":{"^([a-zA-Z0-9_.-]+)$":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}},"ANY_ADDITIONAL_PROPERTY":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}}},"relations":{"^([a-zA-Z0-9_.-]+)$":{"value":"text","array":false,"title":"text"},"ANY_ADDITIONAL_PROPERTY":{"value":"text","array":false,"title":"text"}}}'

201

422

201

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "type": "object",
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": "[Circular Reference]",
      "properties": "[Circular Reference]",
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    }
  },
  "options": {
    "showInSideBar": true,
    "propertiesGroups": {
      "ANY_ADDITIONAL_PROPERTY": {
        "order": 1,
        "title": "text",
        "description": "",
        "properties": [
          "text"
        ]
      }
    }
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2025-02-21T18:19:13.075Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:19:13.075Z",
  "updatedBy": 1,
  "userEditable": true,
  "userDeletable": true,
  "referenceProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    }
  },
  "calculationProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    }
  },
  "relations": {
    "^([a-zA-Z0-9_.-]+)$": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    }
  }
}

Successful Response

Create Or Update Blueprint

put

/api/v1/blueprints

Authorizations

Query parameters

userEditableUsereditable

Body

idIdrequired

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

titleTitlerequired

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.

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/blueprints' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","title":"text","schemaProperties":{"type":"object","enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]}}},"options":{"showInSideBar":true,"propertiesGroups":{"ANY_ADDITIONAL_PROPERTY":{"order":1,"title":"text","description":"","properties":["text"]}}},"isActive":true,"isHideable":true,"referenceProperties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","relation":"text","property":"text"},"ANY_ADDITIONAL_PROPERTY":{"title":"text","relation":"text","property":"text"}},"calculationProperties":{"^([a-zA-Z0-9_.-]+)$":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}},"ANY_ADDITIONAL_PROPERTY":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}}},"relations":{"^([a-zA-Z0-9_.-]+)$":{"value":"text","array":false,"title":"text"},"ANY_ADDITIONAL_PROPERTY":{"value":"text","array":false,"title":"text"}}}'

201

422

201

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "type": "object",
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": "[Circular Reference]",
      "properties": "[Circular Reference]",
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    }
  },
  "options": {
    "showInSideBar": true,
    "propertiesGroups": {
      "ANY_ADDITIONAL_PROPERTY": {
        "order": 1,
        "title": "text",
        "description": "",
        "properties": [
          "text"
        ]
      }
    }
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2025-02-21T18:19:13.075Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:19:13.075Z",
  "updatedBy": 1,
  "userEditable": true,
  "userDeletable": true,
  "referenceProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    }
  },
  "calculationProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    }
  },
  "relations": {
    "^([a-zA-Z0-9_.-]+)$": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    }
  }
}

Successful Response

Create Or Update Blueprints Bulk

put

/api/v1/blueprints/bulk

Authorizations

Query parameters

userEditableUsereditable

Body

idIdrequired

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

titleTitlerequired

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.

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/blueprints/bulk' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","title":"text","schemaProperties":{"type":"object","enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]}}},"options":{"showInSideBar":true,"propertiesGroups":{"ANY_ADDITIONAL_PROPERTY":{"order":1,"title":"text","description":"","properties":["text"]}}},"isActive":true,"isHideable":true,"referenceProperties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","relation":"text","property":"text"},"ANY_ADDITIONAL_PROPERTY":{"title":"text","relation":"text","property":"text"}},"calculationProperties":{"^([a-zA-Z0-9_.-]+)$":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}},"ANY_ADDITIONAL_PROPERTY":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}}},"relations":{"^([a-zA-Z0-9_.-]+)$":{"value":"text","array":false,"title":"text"},"ANY_ADDITIONAL_PROPERTY":{"value":"text","array":false,"title":"text"}}}]'

201

422

201

[
  {
    "id": "text",
    "title": "text",
    "description": "text",
    "icon": "text",
    "schemaProperties": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "type": "object",
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      }
    },
    "options": {
      "showInSideBar": true,
      "propertiesGroups": {
        "ANY_ADDITIONAL_PROPERTY": {
          "order": 1,
          "title": "text",
          "description": "",
          "properties": [
            "text"
          ]
        }
      }
    },
    "isActive": true,
    "isHideable": true,
    "createdAt": "2025-02-21T18:19:13.075Z",
    "createdBy": 1,
    "updatedAt": "2025-02-21T18:19:13.075Z",
    "updatedBy": 1,
    "userEditable": true,
    "userDeletable": true,
    "referenceProperties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "relation": "text",
        "property": "text",
        "schema": "[Circular Reference]"
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "relation": "text",
        "property": "text",
        "schema": "[Circular Reference]"
      }
    },
    "calculationProperties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "icon": "text",
        "unit": "text",
        "outputType": "number",
        "method": "aggregation",
        "sql": "text",
        "aggregation": {
          "function": "count",
          "calculatedBy": "entities",
          "targetBlueprint": "text",
          "targetProperty": "text",
          "measureTimeBy": "text",
          "filters": [
            {
              "field": "text",
              "operator": "eq",
              "value": null
            }
          ]
        }
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "icon": "text",
        "unit": "text",
        "outputType": "number",
        "method": "aggregation",
        "sql": "text",
        "aggregation": {
          "function": "count",
          "calculatedBy": "entities",
          "targetBlueprint": "text",
          "targetProperty": "text",
          "measureTimeBy": "text",
          "filters": [
            {
              "field": "text",
              "operator": "eq",
              "value": null
            }
          ]
        }
      }
    },
    "relations": {
      "^([a-zA-Z0-9_.-]+)$": {
        "value": "text",
        "array": false,
        "title": "text",
        "description": "text"
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "value": "text",
        "array": false,
        "title": "text",
        "description": "text"
      }
    }
  }
]

Successful Response

Get Blueprint

get

/api/v1/blueprints/{id_}

Authorizations

Path parameters

id_Id required

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

Query parameters

includeReferenceSchemaIncludereferenceschema

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/blueprints/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

200

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "type": "object",
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": "[Circular Reference]",
      "properties": "[Circular Reference]",
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    }
  },
  "options": {
    "showInSideBar": true,
    "propertiesGroups": {
      "ANY_ADDITIONAL_PROPERTY": {
        "order": 1,
        "title": "text",
        "description": "",
        "properties": [
          "text"
        ]
      }
    }
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2025-02-21T18:19:13.075Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:19:13.075Z",
  "updatedBy": 1,
  "userEditable": true,
  "userDeletable": true,
  "referenceProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    }
  },
  "calculationProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    }
  },
  "relations": {
    "^([a-zA-Z0-9_.-]+)$": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    }
  }
}

Successful Response

Update Blueprint

put

/api/v1/blueprints/{id_}

Authorizations

Path parameters

id_Id required

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

Body

idIdrequired

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

titleTitlerequired

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.

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

referencePropertiesReferenceproperties

calculationPropertiesCalculationproperties

relationsRelations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/blueprints/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","title":"text","schemaProperties":{"type":"object","enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]}}},"options":{"showInSideBar":true,"propertiesGroups":{"ANY_ADDITIONAL_PROPERTY":{"order":1,"title":"text","description":"","properties":["text"]}}},"isActive":true,"isHideable":true,"referenceProperties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","relation":"text","property":"text"},"ANY_ADDITIONAL_PROPERTY":{"title":"text","relation":"text","property":"text"}},"calculationProperties":{"^([a-zA-Z0-9_.-]+)$":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}},"ANY_ADDITIONAL_PROPERTY":{"outputType":"number","method":"aggregation","aggregation":{"function":"count","calculatedBy":"entities","targetBlueprint":"text","targetProperty":"text","measureTimeBy":"text","filters":[{"field":"text","operator":"eq","value":null}]}}},"relations":{"^([a-zA-Z0-9_.-]+)$":{"value":"text","array":false,"title":"text"},"ANY_ADDITIONAL_PROPERTY":{"value":"text","array":false,"title":"text"}}}'

200

422

200

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "type": "object",
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": "[Circular Reference]",
      "properties": "[Circular Reference]",
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    }
  },
  "options": {
    "showInSideBar": true,
    "propertiesGroups": {
      "ANY_ADDITIONAL_PROPERTY": {
        "order": 1,
        "title": "text",
        "description": "",
        "properties": [
          "text"
        ]
      }
    }
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2025-02-21T18:19:13.075Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:19:13.075Z",
  "updatedBy": 1,
  "userEditable": true,
  "userDeletable": true,
  "referenceProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "relation": "text",
      "property": "text",
      "schema": "[Circular Reference]"
    }
  },
  "calculationProperties": {
    "^([a-zA-Z0-9_.-]+)$": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "title": "text",
      "description": "text",
      "icon": "text",
      "unit": "text",
      "outputType": "number",
      "method": "aggregation",
      "sql": "text",
      "aggregation": {
        "function": "count",
        "calculatedBy": "entities",
        "targetBlueprint": "text",
        "targetProperty": "text",
        "measureTimeBy": "text",
        "filters": [
          {
            "field": "text",
            "operator": "eq",
            "value": null
          }
        ]
      }
    }
  },
  "relations": {
    "^([a-zA-Z0-9_.-]+)$": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "array": false,
      "title": "text",
      "description": "text"
    }
  }
}

Successful Response

Delete Blueprint

delete

/api/v1/blueprints/{id_}

Authorizations

Path parameters

id_Id required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/blueprints/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

204

No body

Successful Response

Get Blueprint Schema Properties

get

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

Authorizations

Path parameters

id_Id required

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/blueprints/{id_}/schemaProperties' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    },
    "type": [
      "text"
    ]
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    },
    "type": [
      "text"
    ]
  }
}

Successful Response

Create Blueprint Schema Properties

post

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

Authorizations

Path parameters

id_Id required

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.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/blueprints/{id_}/schemaProperties' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"^([a-zA-Z0-9_.-]+)$":{"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":[null]},"ANY_ADDITIONAL_PROPERTY":{"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":[null]}}'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    },
    "type": [
      "text"
    ]
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    },
    "type": [
      "text"
    ]
  }
}

Successful Response

Update Blueprint Schema Properties

put

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

Authorizations

Path parameters

id_Id required

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.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/blueprints/{id_}/schemaProperties' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"^([a-zA-Z0-9_.-]+)$":{"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":[null]},"ANY_ADDITIONAL_PROPERTY":{"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":["text"]},"properties":{"^([a-zA-Z0-9_.-]+)$":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]},"ANY_ADDITIONAL_PROPERTY":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":{"title":"text","description":"text","format":"text","icon":"text","additionalProperties":true,"readOnly":true,"enum":[],"enumColors":{"ANY_ADDITIONAL_PROPERTY":"text"},"enumIcons":{"ANY_ADDITIONAL_PROPERTY":"text"},"items":"[Circular Reference]","properties":"[Circular Reference]","type":["text"]},"properties":"[Circular Reference]","type":["text"]}},"type":[null]}}'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    },
    "type": [
      "text"
    ]
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "title": "text",
    "description": "text",
    "format": "text",
    "icon": "text",
    "additionalProperties": true,
    "readOnly": true,
    "enum": [],
    "enumColors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "enumIcons": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "items": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": "[Circular Reference]",
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    },
    "properties": {
      "^([a-zA-Z0-9_.-]+)$": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": "[Circular Reference]",
        "type": [
          "text"
        ]
      }
    },
    "type": [
      "text"
    ]
  }
}

Successful Response

Delete Blueprint Schema Properties

delete

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

Authorizations

Path parameters

id_Id required

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

schema_property_keySchema Property Keyrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/blueprints/{id_}/schemaProperties/{schema_property_key}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

204

No body

Successful Response

Get Blueprint Relations

get

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

Authorizations

Path parameters

id_Id required

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/blueprints/{id_}/relations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "value": "text",
    "array": false,
    "title": "text",
    "description": "text"
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "value": "text",
    "array": false,
    "title": "text",
    "description": "text"
  }
}

Successful Response

Create Blueprint Relations

post

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

Authorizations

Path parameters

id_Id required

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.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/blueprints/{id_}/relations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"^([a-zA-Z0-9_.-]+)$":{"value":"text","array":false,"title":"text"},"ANY_ADDITIONAL_PROPERTY":{"value":"text","array":false,"title":"text"}}'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "value": "text",
    "array": false,
    "title": "text",
    "description": "text"
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "value": "text",
    "array": false,
    "title": "text",
    "description": "text"
  }
}

Successful Response

Update Blueprint Relations

put

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

Authorizations

Path parameters

id_Id required

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.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/blueprints/{id_}/relations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"^([a-zA-Z0-9_.-]+)$":{"value":"text","array":false,"title":"text"},"ANY_ADDITIONAL_PROPERTY":{"value":"text","array":false,"title":"text"}}'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "value": "text",
    "array": false,
    "title": "text",
    "description": "text"
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "value": "text",
    "array": false,
    "title": "text",
    "description": "text"
  }
}

Successful Response

Delete Blueprint Relations

delete

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

Authorizations

Path parameters

id_Id required

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

relation_keyRelation Keyrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/blueprints/{id_}/relations/{relation_key}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

204

No body

Successful Response

Get Blueprint Reference Properties

get

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

Authorizations

Path parameters

id_Id required

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/blueprints/{id_}/referenceProperties' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "title": "text",
    "description": "text",
    "relation": "text",
    "property": "text",
    "schema": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": {
          "^([a-zA-Z0-9_.-]+)$": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          }
        },
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    }
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "title": "text",
    "description": "text",
    "relation": "text",
    "property": "text",
    "schema": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": {
          "^([a-zA-Z0-9_.-]+)$": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          }
        },
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    }
  }
}

Successful Response

Create Blueprint Reference Properties

post

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

Authorizations

Path parameters

id_Id required

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.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/blueprints/{id_}/referenceProperties' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"^([a-zA-Z0-9_.-]+)$":{"title":"text","relation":"text","property":"text"},"ANY_ADDITIONAL_PROPERTY":{"title":"text","relation":"text","property":"text"}}'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "title": "text",
    "description": "text",
    "relation": "text",
    "property": "text",
    "schema": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": {
          "^([a-zA-Z0-9_.-]+)$": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          }
        },
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    }
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "title": "text",
    "description": "text",
    "relation": "text",
    "property": "text",
    "schema": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": {
          "^([a-zA-Z0-9_.-]+)$": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          }
        },
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    }
  }
}

Successful Response

Update Blueprint Reference Properties

put

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

Authorizations

Path parameters

id_Id required

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.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/blueprints/{id_}/referenceProperties' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"^([a-zA-Z0-9_.-]+)$":{"title":"text","relation":"text","property":"text"},"ANY_ADDITIONAL_PROPERTY":{"title":"text","relation":"text","property":"text"}}'

200

422

200

{
  "^([a-zA-Z0-9_.-]+)$": {
    "title": "text",
    "description": "text",
    "relation": "text",
    "property": "text",
    "schema": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": {
          "^([a-zA-Z0-9_.-]+)$": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          }
        },
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    }
  },
  "ANY_ADDITIONAL_PROPERTY": {
    "title": "text",
    "description": "text",
    "relation": "text",
    "property": "text",
    "schema": {
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "additionalProperties": true,
      "readOnly": true,
      "enum": [],
      "enumColors": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "enumIcons": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "items": {
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "additionalProperties": true,
        "readOnly": true,
        "enum": [],
        "enumColors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enumIcons": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "items": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": "[Circular Reference]",
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "properties": {
          "^([a-zA-Z0-9_.-]+)$": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": {
              "title": "text",
              "description": "text",
              "format": "text",
              "icon": "text",
              "additionalProperties": true,
              "readOnly": true,
              "enum": [],
              "enumColors": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "enumIcons": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "items": "[Circular Reference]",
              "properties": "[Circular Reference]",
              "type": [
                "text"
              ]
            },
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          }
        },
        "type": [
          "text"
        ]
      },
      "properties": {
        "^([a-zA-Z0-9_.-]+)$": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "additionalProperties": true,
          "readOnly": true,
          "enum": [],
          "enumColors": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "enumIcons": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "items": {
            "title": "text",
            "description": "text",
            "format": "text",
            "icon": "text",
            "additionalProperties": true,
            "readOnly": true,
            "enum": [],
            "enumColors": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "enumIcons": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "items": "[Circular Reference]",
            "properties": "[Circular Reference]",
            "type": [
              "text"
            ]
          },
          "properties": "[Circular Reference]",
          "type": [
            "text"
          ]
        }
      },
      "type": [
        "text"
      ]
    }
  }
}

Successful Response

Delete Blueprint Reference Property

delete

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

Authorizations

Path parameters

id_Id required

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

ref_property_keyRef Property Keyrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/blueprints/{id_}/referenceProperties/{ref_property_key}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

204

No body

Successful Response

Troubleshooting

Troubleshooting