Entity

The general shape of an Entity in our API responses.

Example

{
  "identifier": "payment-service",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-02-20T14:45:00Z",
  "description": "Core payment processing service",
  "owner_teams": [
    {
      "id": "MzI1NTk",
      "name": "Payments Team"
    }
  ],
  "owner_users": [
    {
      "id": "MzI1NYn",
      "name": "John Doe"
    }
  ],
  "domain": {
    "identifier": "payments",
    "name": "Payment Domain"
  },
  "properties": {
    "language": ["TypeScript", "Node.js"],
    "service-tier": "Tier-1",
    "approved": true
  },
  "aliases": {
    "github_repo": [
      {
        "identifier": "671150935",
        "name": "company/payment-service",
        "url": "https://github.com/company/payment-service"
      }
    ]
  }
}

Properties

Key Type Description
identifier string The user defined unique identifier for the entity.
created_at ISO8601 timestamp When the entity was created.
updated_at ISO8601 timestamp When the entity was last updated.
description string The description of the entity.
owner_teams array<Owner Team> The owner teams assigned to the entity.
owner_users array<Owner User> The owner users assigned to the entity.
domain Domain The domain entity parent assigned to the entity.
properties Properties Key/Value object of the properties and their values on the entity.
aliases Aliases Key/Value object of the aliases assigned to the entity.