Skip to main content

Update Entity by Id

PUT 

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

Update entity by its id.

Request

Path Parameters

    workspace_id stringrequired
    id integerrequired

    A unique integer value identifying this entity.

Body

required

    name stringrequired

    Possible values: non-empty

    Entity name.

    properties objectrequired

    Entity properties to be saved.

    filename stringrequired

    Possible values: non-empty

    File name of the entity if entity is a member of file entity type.

    message stringrequired

    Possible values: non-empty

    Revision message.

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...