Get all Entities

GET 
/api/workspaces/:workspace_id/entities/

Get all entities.

Request

Path Parameters

workspace_id stringrequired

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.

limit integer

Possible values: >= 1

Number of results to return per page.

offset integer

The initial index from which to return the results.

entity_type string[]

Possible values: non-empty

Allows filtering on id (int) or class_name (string).

sort string[]

Possible values: non-empty

Allowed values: name, updated_at, summary_updated_at and/or summary.

name string

Possible values: non-empty

search string

Possible values: non-empty

Allow for fuzzy name match.

only_name boolean
created_by integer[]

Specify one or more user ids. This field is not allowed on public workspace entities endpoint.

last_updated_by integer[]

Specify one or more user ids. This field is not allowed on public workspace entities endpoint.

created_at_min date-time

Created after specified date (ISO format).

created_at_max date-time

Created before specified date (ISO format).

updated_at_min date-time

Updated after specified date (ISO format).

updated_at_max date-time

Updated before specified date (ISO format).

id integer[]

Filter on specific entity id.

Responses

200

application/json

Schema

Schema

count integerrequired

Count of all the objects in the result set.

results

object[]

required

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)

{
  "count": 0,
  "results": [
    {
      "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...