Create a Child Entity

POST 
/api/workspaces/:workspace_id/entities/:id/entities/

Create a child entity.

Note: The paginated response is optional in this endpoint, when client provides limit and offset query parameters client gets paginated response.

Request

Path Parameters

workspace_id stringrequired
id integerrequired

A unique integer value identifying this entity.

application/json

Body

required

properties objectnullablerequired
groups integer[]
entity_type integerrequired
name string

Possible values: non-empty and <= 128 characters

filename string

Possible values: non-empty and <= 128 characters

Responses

200

application/json

Schema

Schema

• Array [

id integer
name string
properties object
summary_status string
summary string
summary_updated_at string
summary_types string
deleted string
locked boolean
locked_by object
entity_type integerrequired
entity_type_name string
updated_at string
parent_count integer
actions string
param_types string
created_by integer
created_at string
last_updated_by integer
path integer
show_on_dashboard boolean

• ]

Example (from schema)

[
  {
    "id": 0,
    "name": "string",
    "properties": {},
    "summary_status": "string",
    "summary": "string",
    "summary_updated_at": "string",
    "summary_types": "string",
    "deleted": "string",
    "locked": true,
    "locked_by": {},
    "entity_type": 0,
    "entity_type_name": "string",
    "updated_at": "string",
    "parent_count": 0,
    "actions": "string",
    "param_types": "string",
    "created_by": 0,
    "created_at": "string",
    "last_updated_by": 0,
    "path": 0,
    "show_on_dashboard": false
  }
]

400

Validation error response.

It produces a validation error schema like below.

{
    "field1": ["Validation error"],
    "non_field_errors": ["Sample non field validation error"]
}

401

No authentication found or authentication is not correct.

403

Specified path is not allowed

Permission evaluation:

(Is Authenticated Organization Admin OR Workspace Context Permission) AND Is Tree App Workspace Context

Descriptions:

Is Authenticated Organization Admin : User must be an Organization Admin.

Workspace Context Permission : Workspace must be available to the User.

Is Tree App Workspace Context : Workspace should have a tree app.

Loading...