Management API gRPC reference

Services

LibraryService

exabel.api.management.v1.LibraryService

Service to manage library items.

Method NameRequest TypeResponse TypeDescription
ListFoldersListFoldersRequestListFoldersResponseList all folders. Folders are returned without folder items.
GetFolderGetFolderRequestFolderGet a folder including its items.
CreateFolderCreateFolderRequestFolderCreate a folder.
UpdateFolderUpdateFolderRequestFolderUpdate a folder.
DeleteFolderDeleteFolderRequest.google.protobuf.EmptyDelete a folder.
ListItemsListItemsRequestListItemsResponseList all items of a specific type.
MoveItemsMoveItemsRequestMoveItemsResponseMove items to a folder.
ListFolderAccessorsListFolderAccessorsRequestListFolderAccessorsResponseList the accessors of a specific folder.
ShareFolderShareFolderRequest.google.protobuf.EmptyShare a folder with a group.
UnshareFolderUnshareFolderRequest.google.protobuf.EmptyRemove sharing of a folder with a group.

ListFolders

List all folders. Folders are returned without folder items.

Request: ListFoldersRequest

Response: ListFoldersResponse

GetFolder

Get a folder including its items.

Request: GetFolderRequest

Response: Folder

CreateFolder

Create a folder.

Request: CreateFolderRequest

Response: Folder

UpdateFolder

Update a folder.

Request: UpdateFolderRequest

Response: Folder

DeleteFolder

Delete a folder.

The folder must be empty.

Request: DeleteFolderRequest

Response: .google.protobuf.Empty

ListItems

List all items of a specific type.

Request: ListItemsRequest

Response: ListItemsResponse

MoveItems

Move items to a folder.

Request: MoveItemsRequest

Response: MoveItemsResponse

ListFolderAccessors

List the accessors of a specific folder.

Request: ListFolderAccessorsRequest

Response: ListFolderAccessorsResponse

ShareFolder

Share a folder with a group.

  • To grant write access to a group with only read access, call this method with the write flag set to true.
  • To revoke only write access from a group, call this method with the write flag set to false.

Request: ShareFolderRequest

Response: .google.protobuf.Empty

UnshareFolder

Remove sharing of a folder with a group.

This revokes both read and write access. To revoke only write access, use ShareFolder
with the write flag set to false.

Request: UnshareFolderRequest

Response: .google.protobuf.Empty

UserService

exabel.api.management.v1.UserService

Service to manage users and groups.

Supported operations are listing the current customer's user groups and users.

Method NameRequest TypeResponse TypeDescription
ListGroupsListGroupsRequestListGroupsResponseList all groups. Only groups for the current customer is returned.
ListUsersListUsersRequestListUsersResponseList all users in the current customer.

ListGroups

List all groups. Only groups for the current customer is returned.

Request: ListGroupsRequest

Response: ListGroupsResponse

ListUsers

List all users in the current customer.

Request: ListUsersRequest

Response: ListUsersResponse

Messages

Folder

exabel.api.management.v1.Folder

A folder.

FieldTypeLabelDescription
namestringThe folder resource name. Example: folders/123.
display_namestringThe display name.
writeboolWhether the caller has write access to the folder. Output only.
itemsFolderItemrepeatedThe items in the folder.

FolderAccessor

exabel.api.management.v1.FolderAccessor

An accessor of a folder.

FieldTypeLabelDescription
groupGroupThe group.
writeboolWhether the group has write access. Read access is implied.

FolderItem

exabel.api.management.v1.FolderItem

An item in a folder.

FieldTypeLabelDescription
parentstringThe parent folder resource name. Example folders/123'.
namestringThe folder item resource name. Example: derivedSignals/123 or models/987. Output only.
display_namestringThe display name.
item_typeFolderItemTypeThe item type.
descriptionstringA description of the folder item.
create_timegoogle.protobuf.TimestampThe timestamp the item was created.
update_timegoogle.protobuf.TimestampThe time the item was last updated.
created_bystringThe resource name of the user who created the item.
updated_bystringThe resource name of the user who last updated the item.

FolderItemType

An enum representing the type of a folder item.

NameNumberDescription
FOLDER_ITEM_TYPE_INVALID0Invalid item type.
DERIVED_SIGNAL1Derived signal.
PREDICTION_MODEL2Prediction model.
PORTFOLIO_STRATEGY3Portfolio strategy.
DASHBOARD4Dashboard.
DRILL_DOWN5Company or entity drill down view.
TAG6Static tag.
SCREEN7Screen.
FINANCIAL_MODEL8Financial model.

CreateFolderRequest

exabel.api.management.v1.CreateFolderRequest

FieldTypeLabelDescription
folderFolderThe folder to create. Only the display name can be set.

DeleteFolderRequest

exabel.api.management.v1.DeleteFolderRequest

FieldTypeLabelDescription
namestringThe resource name of the folder to delete, for example folders/1.

GetFolderRequest

exabel.api.management.v1.GetFolderRequest

FieldTypeLabelDescription
namestringThe folder resource name.

ListFolderAccessorsRequest

exabel.api.management.v1.ListFolderAccessorsRequest

FieldTypeLabelDescription
namestringThe folder resource name.

ListFolderAccessorsResponse

exabel.api.management.v1.ListFolderAccessorsResponse

FieldTypeLabelDescription
folder_accessorsFolderAccessorrepeatedThe folder accessors. The groups will not be populated with users.

ListFoldersRequest

exabel.api.management.v1.ListFoldersRequest

Request to ListFolders.

No fields

ListFoldersResponse

exabel.api.management.v1.ListFoldersResponse

Response from ListFolders.

FieldTypeLabelDescription
foldersFolderrepeatedThe accessible folders. The items field within the folders is empty.

ListItemsRequest

exabel.api.management.v1.ListItemsRequest

FieldTypeLabelDescription
parentstringThe folder to list items from. Optional.
item_typeFolderItemTypeThe item type.

ListItemsResponse

exabel.api.management.v1.ListItemsResponse

FieldTypeLabelDescription
itemsFolderItemrepeatedThe folder items.

MoveItemsRequest

exabel.api.management.v1.MoveItemsRequest

FieldTypeLabelDescription
itemsstringrepeatedThe resource names of the items to move, for example models/123 or derivedSignals/987.
target_folderstringThe resource name of the target folder, for example folders/10.

MoveItemsResponse

exabel.api.management.v1.MoveItemsResponse

No fields

ShareFolderRequest

exabel.api.management.v1.ShareFolderRequest

FieldTypeLabelDescription
folderstringThe resource name of the folder to share.
groupstringThe resource name of the group to share the folder with.
writeboolWhether the group should have write permissions.

UnshareFolderRequest

exabel.api.management.v1.UnshareFolderRequest

FieldTypeLabelDescription
folderstringThe resource name of the folder to unshare.
groupstringThe resource name of the group to unshare the folder with.

UpdateFolderRequest

exabel.api.management.v1.UpdateFolderRequest

FieldTypeLabelDescription
folderFolderThe updated folder. The resource name must be set. Only the display name can be set.
update_maskgoogle.protobuf.FieldMaskThe update mask to apply to the resource. Only the fields mentioned in this mask will be modified. If allow_missing is set, this field is ignored. Currently, only the display name may be modified.
allow_missingboolIf set to true, and the resource is not found, a new resource will be created. The provided folder resource name will then be ignored. If this is set, update_mask is ignored.

Group

exabel.api.management.v1.Group

A group.

FieldTypeLabelDescription
namestringThe group resource name. Example: groups/123.
display_namestringThe display name.
usersUserrepeatedThe users in this group. Only populated for some responses.

User

exabel.api.management.v1.User

A user.

FieldTypeLabelDescription
namestringThe user resource name. Example: users/123.
emailstringThe user's email.
blockedboolWhether the user is blocked from accessing the system.

ListGroupsRequest

exabel.api.management.v1.ListGroupsRequest

Request to ListGroups.

No fields

ListGroupsResponse

exabel.api.management.v1.ListGroupsResponse

Response from ListGroups.

FieldTypeLabelDescription
groupsGrouprepeatedThe returned groups.

ListUsersRequest

exabel.api.management.v1.ListUsersRequest

Request to ListUsers.

No fields

ListUsersResponse

exabel.api.management.v1.ListUsersResponse

Response from ListUsers.

FieldTypeLabelDescription
usersUserrepeatedThe returned users.