openapi: 3.1.0
info:
title: Port Action Runs Pages API
version: '1.0'
tags:
- name: Pages
paths:
/v1/pages/{page_identifier}/permissions:
get:
summary: Get a page's permissions
tags:
- Pages
description: This route allows you to get a specific page's permissions.
To learn more about pages, check out the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/page-permissions).
parameters:
- schema:
type: string
minLength: 1
in: path
name: page_identifier
required: true
security:
- bearer: []
responses:
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
patch:
summary: Update a page's permissions
tags:
- Pages
description: This route allows you to update a specific page’s permissions.
To learn more about pages, check out the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/page-permissions).
requestBody:
content:
application/json:
schema:
type: object
properties:
read:
type: object
properties:
users:
type: array
items:
type: string
roles:
type: array
items:
type: string
teams:
type: array
items:
type: string
additionalProperties: false
update:
type: object
properties:
users:
type: array
items:
type: string
roles:
type: array
items:
type: string
teams:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
parameters:
- schema:
type: string
minLength: 1
in: path
name: page_identifier
required: true
security:
- bearer: []
responses:
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
/v1/pages:
get:
summary: Get all pages in your portal
tags:
- Pages
description: This route allows you to get all pages in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
parameters:
- schema:
type: boolean
default: false
in: query
name: compact
required: true
security:
- bearer: []
responses:
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
post:
summary: Create pages in your portal
tags:
- Pages
description: This route allows you to create pages in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
requestBody:
content:
application/json:
schema:
type: object
properties:
identifier:
type: string
pattern: ^(?!\.{1,2}$)(?:[A-Za-z0-9@_.:\/=\-]|\$team\b|\$users\b|\$user\b|\$AuditLog\b|\$run\b|\$RunsHistory\b|\$home)*$
minLength: 1
example: string
blueprint:
type: string
title:
type: string
description:
type: string
icon:
type: string
sidebar:
type: string
nullable: true
enum:
- null
- catalog
parent:
type: string
nullable: true
after:
type: string
nullable: true
locked:
type: boolean
requiredQueryParams:
type: array
items:
type: string
widgets:
type: array
items:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- grouper
title:
type: string
displayMode:
type: string
enum:
- tabs
- switch
activeGroupUrlParam:
type: string
groupsOrder:
type: array
items:
type: string
groups:
type: array
items:
type: object
properties:
title:
type: string
icon:
type: string
widgets:
type: array
items:
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- title
- widgets
additionalProperties: false
required:
- type
- groups
- displayMode
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- dashboard-widget
layout:
type: array
items:
type: object
properties:
height:
type: number
columns:
type: array
items:
type: object
properties:
size:
type: number
id:
type: string
additionalProperties: false
required:
- size
- id
additionalProperties: false
required:
- columns
- height
widgets:
type: array
items:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- type
- layout
- widgets
type:
type: string
enum:
- run
- user
- team
- entity
- users-and-teams
- runs-history
- audit-log
- blueprint-entities
- dashboard
- home
showInSidebar:
type: boolean
default: true
section:
type: string
enum:
- software_catalog
- organization
default: software_catalog
pageFilters:
type: array
items:
type: object
properties:
query:
type: object
properties:
blueprint:
type: string
combinator:
enum:
- and
description: The combinator to use for the rules.
rules:
type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
required:
- combinator
- rules
additionalProperties: false
example:
combinator: and
rules:
- property: $blueprint
operator: '='
value: service
title: /schemas/filterTag
identifier:
type: string
title:
type: string
required:
- identifier
- title
- query
additionalProperties: false
additionalProperties: true
required:
- identifier
required: true
security:
- bearer:
- create:pages
responses:
'201':
description: Created successfully
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
/v1/pages/{identifier}:
get:
summary: Get a page
tags:
- Pages
description: This route allows you to get a specific page in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
parameters:
- schema:
type: string
in: path
name: identifier
required: true
description: The unique identifier of the resource you want to operate on.
security:
- bearer: []
responses:
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
patch:
summary: Patch a page
tags:
- Pages
description: This route allows you to update a specific page in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
requestBody:
content:
application/json:
schema:
type: object
properties:
identifier:
type: string
pattern: ^(?!\.{1,2}$)(?:[A-Za-z0-9@_.:\/=\-]|\$team\b|\$users\b|\$user\b|\$AuditLog\b|\$run\b|\$RunsHistory\b|\$home)*$
minLength: 1
example: string
blueprint:
type: string
title:
type: string
description:
type: string
icon:
type: string
parent:
type: string
nullable: true
after:
type: string
nullable: true
locked:
type: boolean
widgets:
type: array
items:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- grouper
title:
type: string
displayMode:
type: string
enum:
- tabs
- switch
activeGroupUrlParam:
type: string
groupsOrder:
type: array
items:
type: string
groups:
type: array
items:
type: object
properties:
title:
type: string
icon:
type: string
widgets:
type: array
items:
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- title
- widgets
additionalProperties: false
required:
- type
- groups
- displayMode
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- dashboard-widget
layout:
type: array
items:
type: object
properties:
height:
type: number
columns:
type: array
items:
type: object
properties:
size:
type: number
id:
type: string
additionalProperties: false
required:
- size
- id
additionalProperties: false
required:
- columns
- height
widgets:
type: array
items:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- type
- layout
- widgets
showInSidebar:
type: boolean
default: true
section:
type: string
enum:
- software_catalog
- organization
default: software_catalog
pageFilters:
type: array
items:
type: object
properties:
query:
type: object
properties:
blueprint:
type: string
combinator:
enum:
- and
description: The combinator to use for the rules.
rules:
type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
required:
- combinator
- rules
additionalProperties: false
example:
combinator: and
rules:
- property: $blueprint
operator: '='
value: service
identifier:
type: string
title:
type: string
required:
- identifier
- title
- query
additionalProperties: false
additionalProperties: false
required: []
parameters:
- schema:
type: string
in: path
name: identifier
required: true
description: The unique identifier of the resource you want to operate on.
security:
- bearer: []
responses:
'200':
description: Updated successfully
content:
application/json:
schema:
type: object
properties:
ok:
enum:
- true
identifier:
type: string
additionalProperties: false
required:
- ok
- identifier
description: Updated successfully
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
delete:
summary: Delete a page
tags:
- Pages
description: This route allows you to delete a specific page in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
parameters:
- schema:
type: string
in: path
name: identifier
required: true
description: The unique identifier of the resource you want to operate on.
security:
- bearer:
- delete:pages
responses:
'200':
description: Deleted successfully
content:
application/json:
schema:
description: Deleted successfully
type: object
properties:
ok:
enum:
- true
additionalProperties: false
required:
- ok
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
/v1/pages/{identifier}/duplicate:
post:
summary: Duplicate a page
tags:
- Pages
description: Creates a copy of an existing page with the same page permissions.
parameters:
- schema:
type: string
in: path
name: identifier
required: true
description: The unique identifier of the resource you want to operate on.
security:
- bearer: []
responses:
'201':
description: Duplicated successfully
content:
application/json:
schema:
type: object
properties:
ok:
enum:
- true
identifier:
type: string
additionalProperties: false
required:
- ok
- identifier
description: Duplicated successfully
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
/v1/pages/{page_identifier}/widgets:
post:
summary: Create a widget
tags:
- Pages
description: This route allows you to create a widget in a specific page in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
requestBody:
content:
application/json:
schema:
type: object
properties:
widget:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- grouper
title:
type: string
displayMode:
type: string
enum:
- tabs
- switch
activeGroupUrlParam:
type: string
groupsOrder:
type: array
items:
type: string
groups:
type: array
items:
type: object
properties:
title:
type: string
icon:
type: string
widgets:
type: array
items:
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- title
- widgets
additionalProperties: false
required:
- type
- groups
- displayMode
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- dashboard-widget
layout:
type: array
items:
type: object
properties:
height:
type: number
columns:
type: array
items:
type: object
properties:
size:
type: number
id:
type: string
additionalProperties: false
required:
- size
- id
additionalProperties: false
required:
- columns
- height
widgets:
type: array
items:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- type
- layout
- widgets
parentWidgetId:
type: string
additionalProperties: false
required:
- widget
- parentWidgetId
required: true
parameters:
- schema:
type: string
minLength: 1
in: path
name: page_identifier
required: true
security:
- bearer: []
responses:
'201':
description: Created successfully
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
/v1/pages/{page_identifier}/widgets/{widget_id}:
patch:
summary: Update a widget
tags:
- Pages
description: This route allows you to update a specific widget in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
parameters:
- schema:
type: string
minLength: 1
in: path
name: page_identifier
required: true
- schema:
type: string
minLength: 1
in: path
name: widget_id
required: true
security:
- bearer: []
responses:
'200':
description: Updated successfully
content:
application/json:
schema:
type: object
properties:
ok:
enum:
- true
identifier:
type: string
additionalProperties: false
required:
- ok
- identifier
description: Updated successfully
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
delete:
summary: Delete a widget
tags:
- Pages
description: This route allows you to delete a specific widget in your portal.
To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
parameters:
- schema:
type: string
minLength: 1
in: path
name: page_identifier
required: true
- schema:
type: string
minLength: 1
in: path
name: widget_id
required: true
security:
- bearer: []
responses:
'200':
description: Deleted successfully
content:
application/json:
schema:
description: Deleted successfully
type: object
properties:
ok:
enum:
- true
additionalProperties: false
required:
- ok
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
components:
schemas:
def-1:
type: object
properties:
combinator:
enum:
- and
- or
description: The combinator to use for the rules.
rules:
type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
required:
- combinator
- rules
additionalProperties: false
example:
combinator: and
rules:
- property: $blueprint
operator: '='
value: service
- combinator: or
rules:
- property: environment
operator: '='
value: production
- property: environment
operator: '='
value: staging
title: /schemas/entitiesQuery
def-3:
type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- dashboard-widget
layout:
type: array
items:
type: object
properties:
height:
type: number
columns:
type: array
items:
type: object
properties:
size:
type: number
id:
type: string
additionalProperties: false
required:
- size
- id
additionalProperties: false
required:
- columns
- height
widgets:
type: array
items:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- type
- layout
- widgets
title: /schemas/dashboardWidget
def-4:
type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- grouper
title:
type: string
displayMode:
type: string
enum:
- tabs
- switch
activeGroupUrlParam:
type: string
groupsOrder:
type: array
items:
type: string
groups:
type: array
items:
type: object
properties:
title:
type: string
icon:
type: string
widgets:
type: array
items:
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions.'
includes:
type: array
items:
enum:
- action
- context
- diff
- identifier
- resourceType
- status
- trigger
- additionalData
- message
description: The fields you want to include in the response. If used, only the specified fields will be included in the response.
from:
type: string
format: date-time
description: The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
to:
type: string
format: date-time
description: The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`.
action:
type: string
description: Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`.
status:
type: string
enum:
- SUCCESS
- FAILURE
description: Fetch all audit logs with the specified status.
limit:
type: number
description: The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts.
actionType:
type: string
enum:
- automation
- self-service
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- query
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- users-table
title:
type: string
query:
type: object
properties:
team:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- teams-table
title:
type: string
query:
type: object
properties:
user:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- runs-table
title:
type: string
query:
type: object
properties:
entity:
type: string
description: The identifier of the entity associated with the action run.
blueprint:
type: string
description: The identifier of the blueprint associated with the action run.
active:
type: boolean
description: If `true`, only running action runs will be fetched.
user_email:
type: string
description: The email of the user who initiated the action run.
user_id:
type: string
description: The id of the user who initiated the action run.
limit:
type: number
minimum: 1
maximum: 1000
description: The maximum number of action runs to fetch.
exclude:
type: array
items:
type: string
description: The fields to exclude from the response
external_run_id:
type: string
description: The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the `run_id`.
version:
type: string
enum:
- v1
- v2
description: Specifies the API version to use. Please use `v2` for the latest version of the API.
action:
type: string
source:
type: array
items:
type: string
enum:
- UI
- API
- AUTOMATION
if:
properties:
version:
enum:
- v1
- null
then:
properties:
action:
type: 'null'
additionalProperties: false
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- workflow-runs-history-table
query:
type: object
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- run-info
title:
type: string
runId:
type: string
additionalProperties: false
required:
- type
- runId
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- user-info
title:
type: string
user_email:
type: string
additionalProperties: false
required:
- type
- user_email
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- graph-entities-explorer
title:
type: string
dataset:
$ref: '#/components/schemas/def-1'
hiddenBlueprints:
type: array
items:
type: string
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- bar-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- entities-pie-chart
title:
type: string
blueprint:
type: string
property:
type: string
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
emptyStateText:
type: string
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- property
- type: object
oneOf:
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- type
- blueprint
- chartType
- entity
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
- properties
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- line-chart
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- type
- blueprint
- chartType
- func
- measureTimeBy
additionalProperties: false
if:
type: object
properties:
timeRange:
type: object
properties:
preset:
enum:
- last2Years
- last3Years
then:
type: object
properties:
timeInterval:
enum:
- quarter
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
icon:
type: string
type:
enum:
- multi-line-chart
title:
type: string
xAxisTitle:
type: string
yAxisTitle:
type: string
timeInterval:
type: string
enum:
- hour
- day
- isoWeek
- month
- quarter
timeRange:
type: object
properties:
preset:
type: string
enum:
- today
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
required:
- preset
additionalProperties: false
description:
type: string
emptyStateText:
type: string
lines:
type: array
items:
type: object
oneOf:
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- propertiesValueHistory
entity:
type: string
properties:
type: array
items:
type: string
minItems: 1
required:
- title
- entity
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- aggregatePropertiesValues
func:
type: string
enum:
- sum
- average
- min
- max
- median
- last
properties:
type: array
items:
type: string
minItems: 1
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- properties
- blueprint
- chartType
additionalProperties: false
- properties:
title:
type: string
blueprint:
type: string
chartType:
enum:
- countEntities
func:
type: string
enum:
- count
- average
breakdownProperty:
type: string
measureTimeBy:
type: string
dataset:
$ref: '#/components/schemas/def-1'
required:
- title
- func
- measureTimeBy
- blueprint
- chartType
additionalProperties: false
baselines:
type: array
items:
type: object
properties:
name:
type: string
value:
type: number
color:
type: string
additionalProperties: false
required:
- value
nullValueDisplayMode:
type: string
enum:
- zero
- 'null'
required:
- lines
- timeInterval
- timeRange
- title
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- entities-number-chart
title:
type: string
icon:
type: string
description:
type: string
emptyStateText:
type: string
unit:
type: string
enum:
- none
- $
- €
- £
- '%'
- custom
unitAlignment:
type: string
enum:
- left
- right
calculationBy:
type: string
enum:
- entities
- property
conditionalFormatting:
type: array
items:
type: object
properties:
operator:
enum:
- '>'
- '>='
- <
- <=
- '='
- '!='
value:
type: number
message:
type: string
maxLength: 50
description:
type: string
maxLength: 200
color:
type: string
enum:
- blue
- turquoise
- orange
- purple
- pink
- yellow
- green
- red
- gold
- silver
- paleBlue
- darkGray
- lightGray
- bronze
- lime
- olive
- brown
required:
- operator
- value
displayFormatting:
type: string
enum:
- none
- round
- custom
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- type
- unit
allOf:
- if:
properties:
chartType:
enum:
- aggregateByProperty
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- countEntities
required:
- chartType
then:
properties:
dataset:
oneOf:
- type: array
items:
anyOf:
- type: object
title: Date Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- between
- notBetween
- '='
value:
type: object
oneOf:
- type: object
title: Date Range
properties:
from:
type: string
format: date-time
to:
type: string
format: date-time
required:
- from
- to
- type: object
title: Date Preset
properties:
preset:
type: string
enum:
- today
- tomorrow
- yesterday
- lastDay
- lastWeek
- last2Weeks
- lastMonth
- last3Months
- last6Months
- last12Months
- last2Years
- last3Years
- nextDay
- nextWeek
- next2Weeks
- nextMonth
- next3Months
- next6Months
- next12Months
required:
- preset
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Empty Rule
oneOf:
- type: object
title: Empty Rule
properties:
operator:
enum:
- isEmpty
- isNotEmpty
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: Number Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '>'
- '>='
- <
- <=
value:
anyOf:
- type: number
title: number
- type: string
format: date-time
title: date-time
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- type: object
title: Expired Rule
oneOf:
- type: object
title: Expired Rule
properties:
operator:
enum:
- isExpired
- isNotExpired
property:
type: string
required:
- operator
- property
additionalProperties: false
- type: object
title: String Rule
oneOf:
- type: object
title: String Rule
properties:
property:
oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
enum:
- '='
- '!='
- containsAny
- contains
- doesNotContains
- beginsWith
- doesNotBeginsWith
- endsWith
- doesNotEndsWith
- in
- notIn
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
- type: string
format: date-time
title: date-time
- type: array
items:
type: string
title: array
- type: array
items:
type: number
title: array
- type: array
items:
type: boolean
title: array
- type: array
items:
type: string
format: date-time
title: array
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
additionalProperties: false
required:
- property
- operator
- value
- type: object
title: Relation Rule
properties:
operator:
enum:
- relatedTo
blueprint:
type: string
value:
anyOf:
- type: string
title: string
- type: array
items:
type: string
title: array
direction:
enum:
- upstream
- downstream
required:
type: boolean
additionalProperties: false
required:
- operator
- value
- blueprint
- type: object
title: Property schema rule
properties:
propertySchema:
type: object
properties:
type:
type: string
format:
type: string
items:
type: object
properties:
type:
type: string
format:
type: string
required:
- type
required:
- type
additionalProperties: false
operator:
enum:
- '='
- '!='
- contains
value:
anyOf:
- type: 'null'
title: 'null'
- type: string
title: string
- type: number
title: number
- type: boolean
title: boolean
required:
- operator
- propertySchema
additionalProperties: false
- type: object
title: matchAny Rule
anyOf:
- type: object
properties:
property:
oneOf:
- type: object
properties:
path:
type: array
items:
anyOf:
- type: string
- type: object
properties:
relation:
type: string
maxHops:
type: number
minimum: 1
maximum: 15
fromBlueprint:
type: string
required:
- path
additionalProperties: false
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
operator:
type: string
enum:
- matchAny
value:
anyOf:
- type: array
items:
type: string
- oneOf:
- type: string
- type: object
properties:
property:
type: string
context:
type: string
enum:
- user
- userTeams
required:
- property
- context
required:
- property
- operator
- value
additionalProperties: false
- $ref: '#/components/schemas/def-1'
- $ref: '#/components/schemas/def-1'
segmentTableViewConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
required:
- dataset
- if:
properties:
chartType:
enum:
- displaySingleProperty
required:
- chartType
then:
properties:
property:
type: string
entity:
type: string
required:
- property
- if:
properties:
calculationBy:
enum:
- property
required:
- calculationBy
then:
properties:
property:
type: string
func:
type: string
enum:
- sum
- average
- min
- max
- median
required:
- property
- func
- if:
properties:
calculationBy:
enum:
- entities
required:
- calculationBy
then:
properties:
func:
type: string
enum:
- average
- count
required:
- func
- if:
properties:
func:
enum:
- average
required:
- func
then:
properties:
averageOf:
type: string
enum:
- hour
- day
- week
- month
- total
measureTimeBy:
type: string
required:
- averageOf
- if:
properties:
unit:
enum:
- custom
required:
- unit
then:
properties:
unitCustom:
type: string
required:
- unitCustom
- if:
properties:
displayFormatting:
enum:
- custom
required:
- displayFormatting
then:
properties:
decimalPlaces:
type: string
enum:
- '.0'
- '.00'
- '.000'
- '.0000'
- '.00000'
required:
- decimalPlaces
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- iframe-widget
title:
type: string
icon:
type: string
description:
type: string
url:
type: string
format: url
urlType:
type: string
enum:
- public
- protected
required:
- type
- url
- urlType
- title
allOf:
- if:
properties:
urlType:
enum:
- protected
then:
properties:
popupAuth:
type: boolean
tokenUrl:
type: string
format: url
authorizationUrl:
type: string
format: url
clientId:
type: string
scopes:
type: array
items:
type: string
required:
- tokenUrl
- authorizationUrl
- clientId
- scopes
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- markdown
title:
type: string
icon:
type: string
required:
- type
- title
anyOf:
- type: object
properties:
source:
type: string
enum:
- custom
markdown:
type: string
required:
- markdown
- type: object
properties:
source:
type: string
enum:
- property
blueprintIdentifier:
type: string
propertyIdentifier:
type: string
entityIdentifier:
type: string
required:
- source
- blueprintIdentifier
- propertyIdentifier
- entityIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- team-info
title:
type: string
team_name:
type: string
additionalProperties: false
required:
- type
- team_name
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-viewed-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- recently-used-actions
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- my-entities
title:
type: string
icon:
type: string
required:
- type
- title
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
type: string
enum:
- custom-widget
title:
type: string
icon:
type: string
description:
type: string
pluginId:
type: string
paramValues:
type: object
additionalProperties:
type: object
properties:
type:
type: string
enum:
- string
- number
- boolean
- object
- array
- blueprint
value:
oneOf:
- type: string
- type: number
- type: boolean
- type: array
- type: object
required:
- type
- value
additionalProperties: false
required:
- type
- pluginId
- title
additionalProperties: false
- $ref: '#/components/schemas/def-3'
- $ref: '#/components/schemas/def-4'
additionalProperties: false
required:
- title
- widgets
additionalProperties: false
required:
- type
- groups
- displayMode
title: /schemas/grouperWidget
securitySchemes:
bearer:
type: apiKey
name: Authorization
in: header