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.

Query Parameters

privileged boolean

Whether the request is with elevated access.

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.

application/json

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

200

application/json

Schema

Schema

id integer
name string
properties objectnullable
summary_status string
summary string
summary_updated_at string
summary_types string
deleted string
locked boolean
locked_by objectnullable
entity_type integerrequired
entity_type_name string
updated_at string
parent_count integer
actions object[]nullable
param_types string
created_by integernullable
created_at string
last_updated_by integernullable
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": [
    {}
  ],
  "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 Writable Entity AND Locked By Other User Permission AND Is Not Editor App Workspace Context

Descriptions:

Locked By Other User Permission : Entity is Locked by another User

Is Not Editor App Workspace Context : Not available for editor type apps.

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

Workspace Context Permission : Checks whether the user has access rights to the context workspace.

Is Writable Entity : Checks whether the entity-relevant entity type allows saving.

Loading...