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

identifierstringrequired

The identifier of the new blueprint.


Possible values: <= 30 characters, Value must match regular expression ^[A-Za-z0-9@_.:\\/=-]+$

titlestringrequired

The title of the new blueprint.


Possible values: <= 30 characters

descriptionstring

The description of the new blueprint.


Possible values: <= 200 characters

iconstring

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"


pathstringrequired

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

titlestring

The title of the property.


descriptionstring

The description of the property.


iconstring

The icon of the property.


typerequired

The type of the property.


Possible values: [string, number, boolean, object, array]

format

The type's format.


Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, timer, proto]

spec

The spec of the property.


Possible values: [open-api, embedded-url, async-api]

requiredstring[]

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

titlestring

descriptionstring

iconstring

calculationstringrequired

typerequired

Possible values: [string, number, boolean, object, array]

format

Possible values: [date-time, url, email, ipv4, ipv6, markdown, yaml, user, team, proto]

spec

Possible values: [open-api, embedded-url, async-api]

colorizedboolean

colorsobject

items

object

type

Possible values: [string, number, boolean, object, array]

format

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

pathstringrequired

Possible values: Value must match regular expression ^(?:[A-Za-z0-9@_=\-]+\.)+?(\w|\$|@|-)*?[^\.]+$

titlestring

aggregationProperties

object

The aggregation properties of the new blueprint.


property name*

object

titlestringrequired

descriptionstring

iconstring

type

Possible values: [number]

Default value: number

targetstringrequired

calculationSpec

object

required

oneOf

query

object

combinatorrequired

Possible values: [and, or]

rules

object[]

required

Array [

anyOf

Number rule

propertystringrequired

operatorrequired

Possible values: [>, >=, <, <=]

valuenumberrequired

Date rule

propertystringrequired

operatorrequired

Possible values: [between, notBetween, =]

value

object

required

oneOf

Date range

fromdate-timerequired

todate-timerequired

Date preset

presetstringrequired

Possible values: [today, tomorrow, yesterday, lastWeek, last2Weeks, lastMonth, last3Months, last6Months, last12Months]

String rule

propertystringrequired

operatorrequired

Possible values: [=, !=, containsAny, contains, doesNotContain, beginsWith, doesNotBeginWith, endsWith, doesNotEndWith, in, notIn]

value

object

required

anyOf

string

string

number

number

boolean

boolean

array

Array [

string

]

date-time

string

Empty rule

operatorrequired

Possible values: [isEmpty, isNotEmpty]

propertystringrequired

Relation rule

operatorrequired

Possible values: [relatedTo]

blueprintstringrequired

valuestringrequired

direction

Possible values: [upstream, downstream]

requiredboolean

Property rule

propertySchema

object

required

typestringrequired

formatstring

operatorrequired

Possible values: [=, !=]

value

object

anyOf

string

string

number

number

boolean

boolean

]

relations

object

The relations of the new blueprint.


property name*

object

titlestring

targetstringrequired

requiredbooleanrequired

Default value: false

manybooleanrequired

Default value: false

descriptionstring

changelogDestination

object

The destination of the blueprint's changelog.


oneOf

Webhook

typestringrequired

Possible values: [WEBHOOK]

agentboolean

If true, Port's execution agent will be used to send the changelog.


urlurirequired

The URL of the webhook.


Kafka

typestringrequired

Possible values: [KAFKA]

Responses

200

Default Response