Target API

• Base URL: https://target.sls.epilot.io
• Full API Docs: https://docs.epilot.io/api/target

Usage

import { epilot } from '@epilot/sdk'

epilot.authorize(() => '<token>')
const { data } = await epilot.target.createTarget(...)

Tree-shakeable import

import { getClient, authorize } from '@epilot/sdk/target'

const targetClient = getClient()
authorize(targetClient, () => '<token>')
const { data } = await targetClient.createTarget(...)

Operations

Target

• createTarget
• getTarget
• deleteTarget
• patchTarget
• updateTarget

Schemas

• BaseError
• ServerError
• ClientError
• BaseUUID
• BaseTags
• BasePurpose
• BaseRelation
• BaseEntityOwner
• BaseEntityAcl
• BaseSystemFields
• BaseSystemReadonlyFields
• BaseSystemFieldsRequired
• BaseTarget
• BaseTargetRequired
• Target
• TargetCreate
• TargetPatch

createTarget

Create a new target entity

POST /v1/target

const { data } = await client.createTarget(
  null,
  {
    _schema: 'target',
    name: 'string',
    description: 'string',
    entity_schema: 'string',
    entity_filters: {
      filter: {
        items: [
          {
            key: 'string',
            operator: 'string',
            value: 'string'
          }
        ],
        combination: 'string'
      }
    },
    _tags: ['string'],
    _purpose: ['string'],
    _files: {
      $relation: [
        {
          entity_id: '123e4567-e89b-12d3-a456-426614174000',
          _tags: ['string']
        }
      ]
    },
    _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
    __additional: {}
  },
)

Response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_schema": "target",
  "_org": "string",
  "_tags": ["string"],
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000",
        "_tags": ["string"]
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_title": "string",
  "_created_at": "1970-01-01T00:00:00.000Z",
  "_updated_at": "1970-01-01T00:00:00.000Z",
  "_acl": {
    "view": ["org:456"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "name": "string",
  "description": "string",
  "entity_schema": "string",
  "entity_filters": {
    "filter": {
      "items": [
        {
          "key": "string",
          "operator": "string",
          "value": "string"
        }
      ],
      "combination": "string"
    }
  },
  "_purpose": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "__additional": {}
}

---

getTarget

Read a specific target entity by a given id

GET /v1/target/{targetId}

const { data } = await client.getTarget({
  targetId: 'example',
  hydrate: true,
  strict: true,
})

Response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_schema": "target",
  "_org": "string",
  "_tags": ["string"],
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000",
        "_tags": ["string"]
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_title": "string",
  "_created_at": "1970-01-01T00:00:00.000Z",
  "_updated_at": "1970-01-01T00:00:00.000Z",
  "_acl": {
    "view": ["org:456"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "name": "string",
  "description": "string",
  "entity_schema": "string",
  "entity_filters": {
    "filter": {
      "items": [
        {
          "key": "string",
          "operator": "string",
          "value": "string"
        }
      ],
      "combination": "string"
    }
  },
  "_purpose": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "__additional": {}
}

---

deleteTarget

Delete a specific target entity by a given id

DELETE /v1/target/{targetId}

const { data } = await client.deleteTarget({
  targetId: 'example',
})

Response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_schema": "target",
  "_org": "string",
  "_tags": ["string"],
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000",
        "_tags": ["string"]
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_title": "string",
  "_created_at": "1970-01-01T00:00:00.000Z",
  "_updated_at": "1970-01-01T00:00:00.000Z",
  "_acl": {
    "view": ["org:456"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "name": "string",
  "description": "string",
  "entity_schema": "string",
  "entity_filters": {
    "filter": {
      "items": [
        {
          "key": "string",
          "operator": "string",
          "value": "string"
        }
      ],
      "combination": "string"
    }
  },
  "_purpose": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "__additional": {}
}

---

patchTarget

Partially update a specific target entity's properties by a given id and a given payload

PATCH /v1/target/{targetId}

const { data } = await client.patchTarget(
  {
    targetId: 'example',
  },
  {
    _schema: 'target',
    name: 'string',
    description: 'string',
    entity_schema: 'string',
    entity_filters: {
      filter: {
        items: [
          {
            key: 'string',
            operator: 'string',
            value: 'string'
          }
        ],
        combination: 'string'
      }
    },
    _tags: ['string'],
    _purpose: ['string'],
    _files: {
      $relation: [
        {
          entity_id: '123e4567-e89b-12d3-a456-426614174000',
          _tags: ['string']
        }
      ]
    },
    _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
    __additional: {}
  },
)

Response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_schema": "target",
  "_org": "string",
  "_tags": ["string"],
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000",
        "_tags": ["string"]
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_title": "string",
  "_created_at": "1970-01-01T00:00:00.000Z",
  "_updated_at": "1970-01-01T00:00:00.000Z",
  "_acl": {
    "view": ["org:456"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "name": "string",
  "description": "string",
  "entity_schema": "string",
  "entity_filters": {
    "filter": {
      "items": [
        {
          "key": "string",
          "operator": "string",
          "value": "string"
        }
      ],
      "combination": "string"
    }
  },
  "_purpose": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "__additional": {}
}

---

updateTarget

Completly replace a specific target entity's properties by a given id and a given payload

PUT /v1/target/{targetId}

const { data } = await client.updateTarget(
  {
    targetId: 'example',
  },
  {
    _schema: 'target',
    name: 'string',
    description: 'string',
    entity_schema: 'string',
    entity_filters: {
      filter: {
        items: [
          {
            key: 'string',
            operator: 'string',
            value: 'string'
          }
        ],
        combination: 'string'
      }
    },
    _tags: ['string'],
    _purpose: ['string'],
    _files: {
      $relation: [
        {
          entity_id: '123e4567-e89b-12d3-a456-426614174000',
          _tags: ['string']
        }
      ]
    },
    _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
    __additional: {}
  },
)

Response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_schema": "target",
  "_org": "string",
  "_tags": ["string"],
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000",
        "_tags": ["string"]
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_title": "string",
  "_created_at": "1970-01-01T00:00:00.000Z",
  "_updated_at": "1970-01-01T00:00:00.000Z",
  "_acl": {
    "view": ["org:456"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "name": "string",
  "description": "string",
  "entity_schema": "string",
  "entity_filters": {
    "filter": {
      "items": [
        {
          "key": "string",
          "operator": "string",
          "value": "string"
        }
      ],
      "combination": "string"
    }
  },
  "_purpose": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "__additional": {}
}

---

Schemas

BaseError

type BaseError = {
  status: number
  message: string
}

ServerError

type ServerError = {
  status: number
  message: string
}

ClientError

type ClientError = {
  status: number
  message: string
}

BaseUUID

type BaseUUID = string // uuid

BaseTags

type BaseTags = string[]

BasePurpose

type BasePurpose = string[]

BaseRelation

type BaseRelation = {
  $relation?: Array<{
    entity_id?: string // uuid
    _tags?: string[]
  }>
}

BaseEntityOwner

The user / organization owning this entity.

Note: Owner implicitly has access to the entity regardless of ACLs.

type BaseEntityOwner = {
  org_id: string
  user_id?: string
}

BaseEntityAcl

Access control list (ACL) for an entity. Defines sharing access to external orgs or users.

type BaseEntityAcl = {
  view?: string[]
  edit?: string[]
  delete?: string[]
}

BaseSystemFields

type BaseSystemFields = {
  _tags?: string[]
  _purpose?: string[]
  _files?: {
    $relation?: Array<{
      entity_id?: { ... }
      _tags?: { ... }
    }>
  }
  _manifest?: string // uuid[]
  __additional?: Record<string, unknown>
}

BaseSystemReadonlyFields

type BaseSystemReadonlyFields = {
  _id?: string // uuid
  _schema?: string
  _org?: string
  _tags?: string[]
  _files?: {
    $relation?: Array<{
      entity_id?: { ... }
      _tags?: { ... }
    }>
  }
  _owners?: Array<{
    org_id: string
    user_id?: string
  }>
  _title?: string
  _created_at?: string // date-time
  _updated_at?: string // date-time
  _acl?: {
    view?: string[]
    edit?: string[]
    delete?: string[]
  }
}

BaseSystemFieldsRequired

type BaseSystemFieldsRequired = object

BaseTarget

type BaseTarget = {
  _schema?: "target"
  name?: string
  description?: string
  entity_schema?: string
  entity_filters?: {
    filter?: {
      items?: { ... }
      combination?: { ... }
    }
  }
}

BaseTargetRequired

type BaseTargetRequired = object

Target

type Target = {
  _id?: string // uuid
  _schema: "target"
  _org: string
  _tags?: string[]
  _files?: {
    $relation?: Array<{
      entity_id?: { ... }
      _tags?: { ... }
    }>
  }
  _owners?: Array<{
    org_id: string
    user_id?: string
  }>
  _title?: string
  _created_at?: string // date-time
  _updated_at?: string // date-time
  _acl?: {
    view?: string[]
    edit?: string[]
    delete?: string[]
  }
  name: string
  description?: string
  entity_schema?: string
  entity_filters?: {
    filter?: {
      items?: { ... }
      combination?: { ... }
    }
  }
  _purpose?: string[]
  _manifest?: string // uuid[]
  __additional?: Record<string, unknown>
}

TargetCreate

type TargetCreate = {
  _schema?: "target"
  name: string
  description?: string
  entity_schema?: string
  entity_filters?: {
    filter?: {
      items?: { ... }
      combination?: { ... }
    }
  }
  _tags?: string[]
  _purpose?: string[]
  _files?: {
    $relation?: Array<{
      entity_id?: { ... }
      _tags?: { ... }
    }>
  }
  _manifest?: string // uuid[]
  __additional?: Record<string, unknown>
}

TargetPatch

type TargetPatch = {
  _schema?: "target"
  name?: string
  description?: string
  entity_schema?: string
  entity_filters?: {
    filter?: {
      items?: { ... }
      combination?: { ... }
    }
  }
  _tags?: string[]
  _purpose?: string[]
  _files?: {
    $relation?: Array<{
      entity_id?: { ... }
      _tags?: { ... }
    }>
  }
  _manifest?: string // uuid[]
  __additional?: Record<string, unknown>
}