IRPCObjectTypesAdmin.ChangeObjectTypeItemIcon

View as Markdown

Administration API / specialized admin session idempotent

Sets or clears the icon of a value list item.

Service	Object type administration `MFiles.IRPCObjectTypesAdmin`
gRPC method	`/MFiles.IRPCObjectTypesAdmin/ChangeObjectTypeItemIcon`
HTTP (mf-http-grpc)	`POST /grpc/v1/change-object-type-item-icon`
Request	`ChangeObjectTypeItemIconRequest`
Response	`ChangeObjectTypeItemIconResponse`
Book and level	Administration API, specialized
Kind	admin
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	yes
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Requires change_metadata_structure and license_allows_modifications.
Fails with "Access denied." for lists whose items cannot have icons.
Does not change the metadata structure version: clients see the new icon when they reload the list's items.

Request: ChangeObjectTypeItemIconRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

Field	Type	Description
`obj_id`	`ObjID`	The item: `type` is the value list ID, `item_id.internal_id` the item ID.
`obj_id.type`	`int32`	The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID).
`obj_id.item_id`	`ItemID`	The ID of the object within its type, in `item_id.internal_id`.
`obj_id.item_id.internal_id`	`int32`	The ID of the object or value list item.
`obj_id.item_id.external_repository_id`	`ExternalRepositoryID`	Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault.
`icon`	`Bytes`	The new icon, or unset to remove it.
`icon.value`	`bytes`	Array of bytes.

Response: ChangeObjectTypeItemIconResponse

No fields.