v1

latestOpenAPI 3.0.32026-07-1251711.0 KB

Target

createTarget

Create a new target entity

post/v1/target

Request body

_schema'target'

namestring required

The description for the target

descriptionstring

The description of the target

entity_schemastring

The schema of the target entities

_tagsstring[] nullable

_purposestring[] nullable

_manifeststring[]

Manifest ID used to create/update the entity

__additionalobject nullable

Additional fields that are not part of the schema

Example request

{
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "__additional": {}
}

Response

Target entity response

_idstring uuid

_schema'target' required

_orgstring required

Organization Id the entity belongs to

_tagsstring[] nullable

_titlestring

_created_atstring date-time

_updated_atstring date-time

namestring required

The description for the target

descriptionstring

The description of the target

entity_schemastring

The schema of the target entities

_purposestring[] nullable

_manifeststring[]

Manifest ID used to create/update the entity

__additionalobject nullable

Additional fields that are not part of the schema

Example response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_acl": {
    "view": [
      "org:456"
    ],
    "edit": [
      "org:456"
    ],
    "delete": [
      "org:456"
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "__additional": {}
}

All 5 operations