Entity

Entity inputs allow users to select an entity from your software catalog.

Common usage

The entity input type can be used for:

• Selecting a service to deploy
• Choosing an environment
• Picking a cloud resource
• Referencing related entities

Definition

Basic

{
  "service": {
    "title": "Service",
    "description": "Select a service to deploy",
    "type": "string",
    "format": "entity",
    "blueprint": "service"
  }
}

With dataset filter

{
  "service": {
    "title": "Service",
    "description": "Select a production service",
    "type": "string",
    "format": "entity",
    "blueprint": "service",
    "dataset": {
      "combinator": "and",
      "rules": [
        {
          "property": "environment",
          "operator": "=",
          "value": "production"
        }
      ]
    }
  }
}

Array

{
  "services": {
    "title": "Services",
    "description": "Select multiple services",
    "type": "array",
    "items": {
      "type": "string",
      "format": "entity",
      "blueprint": "service"
    }
  }
}

Properties

Property	Type	Description
type	"string"	Required. Must be "string"
format	"entity"	Required. Must be "entity"
blueprint	string	Required. The blueprint identifier to select entities from
default	string	Default entity identifier
dataset	object	Filter to limit available entities
sort	object	Sort configuration with property and order (ASC or DESC)

Dataset filtering

Use the dataset property to filter which entities are available for selection:

{
  "service": {
    "type": "string",
    "format": "entity",
    "blueprint": "service",
    "dataset": {
      "combinator": "and",
      "rules": [
        {
          "property": "tier",
          "operator": "=",
          "value": "critical"
        },
        {
          "property": "status",
          "operator": "!=",
          "value": "deprecated"
        }
      ]
    }
  }
}

Sorting results

Sort the entity list by a property:

{
  "service": {
    "type": "string",
    "format": "entity",
    "blueprint": "service",
    "sort": {
      "property": "title",
      "order": "ASC"
    }
  }
}