Get Entity by Id

GET 
/api/workspaces/:workspace_id/entities/:id/

Get a single entity by its id.

Request

Path Parameters

workspace_id stringrequired
id integerrequired

A unique integer value identifying this entity.

Query Parameters

properties boolean

Whether or not to include entity.properties.

clean_params boolean

Whether or not to clean the params before returning.

param_types boolean

Whether or not to include entity.param_types.

summary_types boolean

Whether or not to include entity.summary_types.

privileged boolean

Whether or not the request should be done with elevated access.

Responses

200

application/json

Schema

Schema

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) OR Public Permission)

Descriptions:

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

Public Permission : Checks corresponding workspace is public.

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

Loading...