diff --git a/static/apispec.yaml b/static/apispec.yaml
index 7f09aaaea..653469860 100644
--- a/static/apispec.yaml
+++ b/static/apispec.yaml
@@ -2,9 +2,6 @@ openapi: 3.1.0
info:
title: Port API
version: "1.0"
-servers:
- - url: https://api.port.io
- - url: https://api.us.port.io
components:
securitySchemes:
bearer:
@@ -5963,9 +5960,7 @@ paths:
summary: Get a page's permissions
tags:
- Pages
- description: >
- **The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly.
Please refer to [Pages overview](/api-reference/pages) before using this endpoint.
**
- This route allows you to get a specific page's
+ 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:
@@ -6016,9 +6011,8 @@ paths:
summary: Update a page's permissions
tags:
- Pages
- description: >
- **The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly.
Please refer to [Pages overview](/api-reference/pages) before using this endpoint.
**
- This route allows you to update a specific page’s permissions.
To learn more about pages, check out the
+ 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:
@@ -24132,9 +24126,7 @@ paths:
summary: Get all pages in your portal
tags:
- Pages
- description: >
- **The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly.
Please refer to the [Pages overview](/api-reference/pages) before using this endpoint.
**
- This route allows you to get all pages in your portal.
To
+ 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:
@@ -24181,94 +24173,18375 @@ paths:
- message
additionalProperties: false
description: A resource with the provided identifier was not found
- "/v1/pages/{identifier}":
- get:
- summary: Get a page
+ post:
+ summary: Create pages in your portal
tags:
- Pages
- description: >
- **The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly.
Please refer to the [Pages overview](/api-reference/pages) before using this endpoint.
**
- This route allows you to get a specific page in your
- portal.
To learn more about pages, checkout the
+ 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
+ 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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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
+ 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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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/{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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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
+ 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
+ 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.
+ 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
+ style: form
+ explode: true
+ 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
+ style: form
+ explode: true
+ items:
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ - type: string
+ enum:
+ - blueprint
+ - entity
+ - run
+ - webhook
+ - scorecard
+ - action
+ description: Fetch all audit logs related to the specified resource type/s.
+ includes:
+ type: array
+ style: form
+ explode: true
+ 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 fetch.
+ 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.
+ 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
+ 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:
+ - 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:
+ - entities-pie-chart
+ title:
+ type: string
+ blueprint:
+ type: string
+ property:
+ type: string
+ description:
+ type: string
+ dataset:
+ $ref: "#/components/schemas/def-1"
+ emptyStateText:
+ type: string
+ 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ timeRange:
+ type: object
+ properties:
+ preset:
+ type: string
+ enum:
+ - today
+ - yesterday
+ - lastDay
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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
+ - 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
+ 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
+ - lastWeek
+ - last2Weeks
+ - lastMonth
+ - last3Months
+ - last6Months
+ - last12Months
+ 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: 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
+ anyOf:
+ - type: object
+ properties:
+ property:
+ type: object
+ properties:
+ path:
+ type: array
+ items:
+ type: string
+ fromBlueprint:
+ type: string
+ required:
+ - path
+ additionalProperties: false
+ operator:
+ type: string
+ enum:
+ - matchAny
+ value:
+ anyOf:
+ - type: string
+ - type: array
+ items:
+ type: string
+ required:
+ - property
+ - operator
+ - value
+ additionalProperties: false
+ - $ref: "#/components/schemas/def-1"
+ - $ref: "#/components/schemas/def-1"
+ 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
+ required:
+ - type
+ - dataset
+ - unit
+ allOf:
+ - 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
+ - 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:
+ 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
+ markdown:
+ type: string
+ required:
+ - type
+ - title
+ - 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
+ - $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: identifier
+ name: page_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
- delete:
- summary: Delete a page
- tags:
- - Pages
- description: >
- **The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly.
Please refer to the [Pages overview](/api-reference/pages) before using this endpoint.
**
- 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
+ "201":
+ description: Created successfully
"401":
description: Default Response
content:
@@ -24343,9 +42616,7 @@ paths:
summary: Update a widget
tags:
- Pages
- description: >
- **The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly.
Please refer to the [Pages overview](/api-reference/pages) before using this endpoint.
**
- This route allows you to update a specific widget in your portal.
+ 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:
@@ -24454,9 +42725,7 @@ paths:
summary: Delete a widget
tags:
- Pages
- description: >
- **The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly.
Please refer to the [Pages overview](/api-reference/pages) before using this endpoint.
**
- This route allows you to delete a specific widget in your portal.
+ 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:
@@ -32577,275 +50846,6 @@ paths:
- message
additionalProperties: false
description: The json provided does not match the route's schema
- "/v1/agent/invoke/{invocation_identifier}":
- get:
- summary: Get an invocation's result
- tags:
- - AI
- description: This route allows you to get a specific invocation
- result.
To learn more about AI agents, check out the
- [documentation](https://docs.port.io/ai-agents/overview).
- parameters:
- - schema:
- type: string
- in: path
- name: invocation_identifier
- required: true
- description: A unique identifier for the agent invocation.
- security:
- - bearer:
- - read:entities
- 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
- "/v1/agent/{agentIdentifier}/invoke":
- post:
- summary: Invoke a specific agent
- tags:
- - AI
- description: This route allows you to create an agent's invocation.
To
- learn more about AI agents, check out the
- [documentation](https://docs.port.io/ai-agents/overview).
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- context:
- type: object
- description: An object used to dynamically inject values into the prompt.
- prompt:
- type: string
- description: The user's message or query to be processed by the AI agent.
- labels:
- type: object
- description: Optional meta-data about the invocation.
- parameters:
- - schema:
- type: boolean
- default: false
- in: query
- name: stream
- required: false
- description: If `true`, the response will show as a stream of information
- instead of a JSON response.
- - schema:
- type: string
- in: path
- name: agentIdentifier
- required: true
- description: The identifier of the agent you want to operate on.
- security:
- - bearer:
- - read:entities
- 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/agent/invoke:
- post:
- summary: Invoke an agent
- tags:
- - AI
- description: This route allows you to create an invocation without choosing a
- specific agent.
To learn more about AI agents, check out the
- [documentation](https://docs.port.io/ai-agents/overview).
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- context:
- type: object
- description: An object used to dynamically inject values into the prompt.
- prompt:
- type: string
- description: The user's message or query to be processed by the AI agent.
- labels:
- type: object
- description: Optional meta-data about the invocation.
- parameters:
- - schema:
- type: boolean
- default: false
- in: query
- name: stream
- required: false
- description: If `true`, the response will show as a stream of information
- instead of a JSON response.
- security:
- - bearer:
- - read:entities
- 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/actions/{action_identifier}/permissions":
get:
summary: Get an action's permissions
@@ -33093,405 +51093,3 @@ paths:
- message
additionalProperties: false
description: The json provided does not match the route's schema
- "/v1/integration/{integrationInternalId}/syncMetrics":
- get:
- summary: Get an integration's metrics and sync status
- description: This route allows you to get a specific integration's metrics and sync status either the latest one or for a specific resync.
It returns the sync's execution status and detailed metrics per kind for each phase of the sync.
For example, the number of fetched objects in the sync's fetch phase, number of objects that were mapped in the mapping phase, etc.
To learn more about integrations, check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/).
- tags:
- - Integrations
- parameters:
- - schema:
- type: string
- in: query
- name: resyncId
- required: false
- description: The ID of a specific resync. If this field is left empty, the latest resync data will be returned.
- - schema:
- type: string
- in: path
- name: integrationInternalId
- required: true
- description: The ID of the integration you want to operate on.
- - schema:
- type: string
- in: header
- name: Authorization
- required: false
- description: Your API token. To get it, go to your [Port account](https://app.port.io/), click the `...` button, then click the `Generate API token` button and copy the generated token.
- responses:
- "200":
- description: Default Response
- content:
- application/json:
- schema:
- type: object
- properties:
- ok:
- type: boolean
- count:
- type: number
- data:
- type: array
- items:
- type: object
- properties:
- integrationType:
- type: string
- integrationIdentifier:
- type: string
- integrationVersion:
- type: string
- oceanVersion:
- type: string
- kindIdentifier:
- type: string
- kind:
- type: string
- kindIndex:
- type: number
- eventId:
- type: string
- syncState:
- type: string
- blueprint:
- type: string
- metrics:
- type: object
- properties:
- phase:
- type: object
- properties:
- resync:
- type: object
- properties:
- duration_seconds:
- type: number
- success:
- type: number
- additionalProperties: false
- load:
- type: object
- properties:
- object_count_type:
- type: object
- properties:
- skipped:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- failed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- loaded:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- raw_extracted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- transformed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- filtered_out:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- deleted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- additionalProperties: false
- required:
- - object_count_type
- additionalProperties: false
- extract:
- type: object
- properties:
- object_count_type:
- type: object
- properties:
- skipped:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- failed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- loaded:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- raw_extracted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- transformed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- filtered_out:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- deleted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- additionalProperties: false
- required:
- - object_count_type
- additionalProperties: false
- transform:
- type: object
- properties:
- object_count_type:
- type: object
- properties:
- skipped:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- failed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- loaded:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- raw_extracted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- transformed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- filtered_out:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- deleted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- additionalProperties: false
- required:
- - object_count_type
- additionalProperties: false
- delete:
- type: object
- properties:
- object_count_type:
- type: object
- properties:
- skipped:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- failed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- loaded:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- raw_extracted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- transformed:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- filtered_out:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- deleted:
- type: object
- properties:
- object_count:
- type: number
- required:
- - object_count
- additionalProperties: false
- additionalProperties: false
- required:
- - object_count_type
- additionalProperties: false
- additionalProperties: false
- required:
- - phase
- additionalProperties: false
- createdAt:
- type: string
- format: date-time
- updatedAt:
- type: string
- format: date-time
- required:
- - integrationType
- - integrationIdentifier
- - integrationVersion
- - oceanVersion
- - kindIdentifier
- - kind
- - eventId
- - syncState
- - metrics
- - createdAt
- - updatedAt
- additionalProperties: false
- required:
- - ok
- - count
- - data
- additionalProperties: false
- "401":
- description: Default Response
- content:
- application/json:
- schema:
- type: object
- properties:
- ok:
- type: boolean
- error:
- type: string
- message:
- type: string
- required:
- - ok
- - error
- additionalProperties: false
- "500":
- description: Default Response
- content:
- application/json:
- schema:
- type: object
- properties:
- ok:
- type: boolean
- error:
- type: string
- message:
- type: string
- required:
- - ok
- - error
- additionalProperties: false
\ No newline at end of file