Skip to main content

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

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

    Default value: false

Loading...