Create a blueprint
POST/v1/blueprints
This route allows you to create a new blueprint in your data model.
To learn more about blueprints, check out the documentation.
Request
- application/json
Body
required
Array [
- Number rule
- Date rule
- String rule
- Empty rule
- Relation rule
- Property rule
- Date range
- Date preset
- string
- number
- boolean
- array
- date-time
Array [
]
- string
- number
- boolean
]
- Webhook
- Kafka
Possible values: <= 30 characters, Value must match regular expression ^[A-Za-z0-9@_.:\\/=-]+$
The identifier of the new blueprint.
Possible values: <= 30 characters
The title of the new blueprint.
Possible values: <= 200 characters
The description of the new blueprint.
The icon of the new blueprint.
teamInheritance
object
A relation to another blueprint from which to inherit the team. Can be any blueprint connected to this one via any number of relations. path is the path to the desired blueprint via relations, for example: "relationIdentifier.relationIdentifierInRelatedBlueprint"
schema
object
required
The schema of the new blueprint, see properties and required below for more information.
properties
object
required
The properties of the new blueprint.
property name*
object
The title of the property.
The description of the property.
The icon of the property.
Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, timer, proto]
The type's format.
The required properties of the blueprint, these must be provided when creating an entity based on this blueprint. This is an array of the required properties' identifiers.
calculationProperties
object
The calculation properties of the new blueprint.
property name*
object
Possible values: [string, number, boolean, object, array]
Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, proto]
Possible values: [open-api, embedded-url, async-api]
items
object
Possible values: [string, number, boolean, object, array]
Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, timer, proto]
mirrorProperties
object
The mirror properties of the new blueprint.
property name*
object
Possible values: Value must match regular expression ^(?:[A-Za-z0-9@_=\-]+\.)+?(\w|\$|@|-)*?[^\.]+$
aggregationProperties
object
The aggregation properties of the new blueprint.
property name*
object
Possible values: [number]
Default value: number
calculationSpec
object
required
oneOf
query
object
Possible values: [and, or]
rules
object[]
required
anyOf
Possible values: [>, >=, <, <=]
Possible values: [between, notBetween, =]
value
object
required
oneOf
Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]
Possible values: [=, !=, containsAny, contains, doesNotContain, beginsWith, doesNotBeginWith, endsWith, doesNotEndWith, in, notIn]
value
object
required
anyOf
string
number
boolean
string
string
Possible values: [isEmpty, isNotEmpty]
Possible values: [relatedTo]
Possible values: [upstream, downstream]
propertySchema
object
required
Possible values: [=, !=]
value
object
anyOf
string
number
boolean
relations
object
The relations of the new blueprint.
property name*
object
changelogDestination
object
The destination of the blueprint's changelog.
oneOf
Possible values: [WEBHOOK]
If true, Port's execution agent will be used to send the changelog.
The URL of the webhook.
Possible values: [KAFKA]
Responses
- 200
Default Response