Skip to content

Latest commit

 

History

History
129 lines (84 loc) · 2.95 KB

item-update.md

File metadata and controls

129 lines (84 loc) · 2.95 KB

Item Update

item_update_controller = client.item_update

Class Name

ItemUpdateController

Methods

Get Metadata Editor Info

Gets metadata editor info for an item.

def get_metadata_editor_info(self,
                            item_id)

Parameters

Parameter Type Tags Description
item_id uuid|string Template, Required The item id.

Response Type

MetadataEditorInfo

Example Usage

item_id = '0000130e-0000-0000-0000-000000000000'

result = item_update_controller.get_metadata_editor_info(item_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Item not found. ProblemDetailsException

Update Item

Updates an item.

def update_item(self,
               item_id,
               body)

Parameters

Parameter Type Tags Description
item_id uuid|string Template, Required The item id.
body BaseItemDto Body, Required The new item properties.

Response Type

void

Example Usage

item_id = '0000130e-0000-0000-0000-000000000000'
body = BaseItemDto()

result = item_update_controller.update_item(item_id, body)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Item not found. ProblemDetailsException

Update Item Content Type

Updates an item's content type.

def update_item_content_type(self,
                            item_id,
                            content_type=None)

Parameters

Parameter Type Tags Description
item_id uuid|string Template, Required The item id.
content_type string Query, Optional The content type of the item.

Response Type

void

Example Usage

item_id = '0000130e-0000-0000-0000-000000000000'

result = item_update_controller.update_item_content_type(item_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Item not found. ProblemDetailsException