Services

LibraryService

exabel.api.management.v1.LibraryService

Service to manage library items.

Requests to the LibraryService are executed in the context of the customer's service account (SA).
The SA is a special user that is a member of the customer user group, giving it access to all
folders that are shared with this user group, but not to private folders.

Method Name	Request Type	Response Type	Description
ListFolders	ListFoldersRequest	ListFoldersResponse	Lists all folders.
GetFolder	GetFolderRequest	Folder	Gets a folder including its items.
CreateFolder	CreateFolderRequest	Folder	Creates a folder.
UpdateFolder	UpdateFolderRequest	Folder	Updates a folder.
DeleteFolder	DeleteFolderRequest	.google.protobuf.Empty	Deletes a folder.
ListItems	ListItemsRequest	ListItemsResponse	Lists all items of a specific type.
MoveItems	MoveItemsRequest	MoveItemsResponse	Moves items to a folder.
ListFolderAccessors	ListFolderAccessorsRequest	ListFolderAccessorsResponse	Lists the accessors of a specific folder.
ShareFolder	ShareFolderRequest	.google.protobuf.Empty	Shares a folder with a group.
UnshareFolder	UnshareFolderRequest	.google.protobuf.Empty	Removes sharing of a folder with a group.
SearchItems	SearchItemsRequest	SearchItemsResponse	Search for folder items.

ListFolders

Lists all folders.

Folders are returned without folder items - use the "Get folder" or "List folder items"
methods to get folder items.

Request: ListFoldersRequest

Response: ListFoldersResponse

GetFolder

Gets a folder including its items.

The folder will be returned with its items.

Request: GetFolderRequest

Response: Folder

CreateFolder

Creates a folder.

Only the display name and description can be set. Items must be added to the new folder
subsequently with the "Move folder items" method.

The folder will be created as private to the service account user. To let other users access
this folder, you must also share it with the "Share folder" method.

It is also possible to create a folder type by calling UpdateFolder
with allow_missing set to true.

Request: CreateFolderRequest

Response: Folder

UpdateFolder

Updates a folder.

Only the display name and description can be updated. Items must be added to a folder with the
"Move folder items" method.

This can also be used to create an entity by setting allow_missing to true.

Note that this method will update all fields unless update_mask is set.

Request: UpdateFolderRequest

Response: Folder

DeleteFolder

Deletes a folder.

The folder must be empty before it can be deleted. Use the "Move folder items" if needed to
move items into another folder.

Request: DeleteFolderRequest

Response: .google.protobuf.Empty

ListItems

Lists all items of a specific type.

List all folder items of a specific type (e.g. derived signal, dashboard). To get all items in
a folder, use the "Get folder" method instead.

Request: ListItemsRequest

Response: ListItemsResponse

MoveItems

Moves items to a folder.

Specify the target folder that items should be moved into. The service account must have write
access to all items that you want to move.

Request: MoveItemsRequest

Response: MoveItemsResponse

ListFolderAccessors

Lists the accessors of a specific folder.

An accessor is a user group with either read-only or read/write access.

Request: ListFolderAccessorsRequest

Response: ListFolderAccessorsResponse

ShareFolder

Shares a folder with a group.

You may find the user group resource names from the "List groups" method in the UserService.

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

Removes sharing of a folder with a group.

This revokes both read and write access. To revoke only write access, use the "Share folder"
method with the write flag set to false.

Request: UnshareFolderRequest

Response: .google.protobuf.Empty

SearchItems

Search for folder items.

Search for all folder items or items of a specific type (e.g. derived signal, dashboard) across all folders.

Request: SearchItemsRequest

Response: SearchItemsResponse

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 Name	Request Type	Response Type	Description
ListGroups	ListGroupsRequest	ListGroupsResponse	Lists all groups. Only groups for the current customer is returned.
ListUsers	ListUsersRequest	ListUsersResponse	Lists all users in the current customer.

ListGroups

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

List all user groups in your customer, including the users in each user group.

Request: ListGroupsRequest

Response: ListGroupsResponse

ListUsers

Lists all users in the current customer.

List all users in your customer

Request: ListUsersRequest

Response: ListUsersResponse

Messages

Folder

exabel.api.management.v1.Folder

A folder.

Field	Type	Label	Description
name	string		Unique resource name of the folder, e.g. `folders/123`. In the "Create folder" method, this is ignored and may be left empty.
display_name	string		Appears in the Exabel Library in the list of folders.
write	bool		Whether the API caller has write access to the folder.
items	FolderItem	repeated	List of items in the folder. To add or remove folder items, use the "Move folder items" method.
description	string		The description of the folder.

FolderAccessor

exabel.api.management.v1.FolderAccessor

An accessor of a folder.

Field	Type	Label	Description
group	Group		User group that has access to the folder.
write	bool		Whether the user group has write access. Read access is implied.

FolderItem

exabel.api.management.v1.FolderItem

An item in a folder.

Field	Type	Description
parent	string	Resource name of the parent folder, e.g. `folders/123`.
name	string	Resource name of the item, e.g. `derivedSignals/123` or `models/987`.
display_name	string	Appears in the Exabel Library when viewing items in a folder, and also when the item is opened.
description	string	Appears in the Exabel Library under each item, and when the item is opened.
item_type	FolderItemType	Item type.
create_time	google.protobuf.Timestamp	When the item was created.
update_time	google.protobuf.Timestamp	When the item was last updated.
created_by	string	Resource name of the user who created the item.
updated_by	string	Resource name of the user who last updated the item.

SearchResult

exabel.api.management.v1.SearchResult

A search result.

Field	Type	Label	Description
item	FolderItem		The folder item.

FolderItemType

An enum representing the type of a folder item.

Name	Number	Description
FOLDER_ITEM_TYPE_INVALID	0	Invalid item type.
DERIVED_SIGNAL	1	Derived signal.
PREDICTION_MODEL	2	Prediction model.
PORTFOLIO_STRATEGY	3	Portfolio strategy.
DASHBOARD	4	Dashboard.
DRILL_DOWN	5	Company or entity drill down view.
TAG	6	Static tag.
SCREEN	7	Screen.
FINANCIAL_MODEL	8	Financial model.
CHART	9	Chart.

CreateFolderRequest

exabel.api.management.v1.CreateFolderRequest

Field	Type	Label	Description
folder	Folder		The folder to create. Only the display name and description can be set.

DeleteFolderRequest

exabel.api.management.v1.DeleteFolderRequest

Field	Type	Label	Description
name	string		The resource name of the folder to delete, for example `folders/1`.

GetFolderRequest

exabel.api.management.v1.GetFolderRequest

Field	Type	Label	Description
name	string		The folder resource name.

ListFolderAccessorsRequest

exabel.api.management.v1.ListFolderAccessorsRequest

Field	Type	Label	Description
name	string		The folder resource name.

ListFolderAccessorsResponse

exabel.api.management.v1.ListFolderAccessorsResponse

Field	Type	Label	Description
folder_accessors	FolderAccessor	repeated	List of user groups with access to the folder. This does not include the users in each user group - those may be queried through the UserService.

ListFoldersRequest

exabel.api.management.v1.ListFoldersRequest

Request to ListFolders.

No fields

ListFoldersResponse

exabel.api.management.v1.ListFoldersResponse

Response from ListFolders.

Field	Type	Label	Description
folders	Folder	repeated	List of accessible folders.

The items field for each folder will be empty when listing folders - use the "Get folder" or "List folder items" methods to retrieve items. |

ListItemsRequest

exabel.api.management.v1.ListItemsRequest

Field	Type	Label	Description
parent	string		The folder to list items from. Optional.
item_type	FolderItemType		Specify an item type to list.

ListItemsResponse

exabel.api.management.v1.ListItemsResponse

Field	Type	Label	Description
items	FolderItem	repeated	List of folder items.

MoveItemsRequest

exabel.api.management.v1.MoveItemsRequest

Field	Type	Label	Description
items	string	repeated	List of resource names of the items to move, e.g. `models/123` or `derivedSignals/987`.
target_folder	string		The resource name of the target folder, for example `folders/10`.

MoveItemsResponse

exabel.api.management.v1.MoveItemsResponse

No fields

SearchItemsRequest

exabel.api.management.v1.SearchItemsRequest

Field	Type	Description
folder	string	Resource name of the folder to search in. Only "folders/-", meaning all folders, is supported.
query	string	Search query.
item_type	FolderItemType	The type of items to search for. If not set, all types are included in the result.
page_token	string	Token for a specific page of results, as returned from a previous search request with the same query parameters.
page_size	int32	Maximum number of results to return. Defaults to 20.

SearchItemsResponse

exabel.api.management.v1.SearchItemsResponse

Field	Type	Label	Description
results	SearchResult	repeated	Search results.
next_page_token	string		Continuation token.

ShareFolderRequest

exabel.api.management.v1.ShareFolderRequest

Field	Type	Description
folder	string	Resource name of the folder to share.
group	string	Resource name of the user group to share the folder with.
write	bool	Whether the user group should have write access.

UnshareFolderRequest

exabel.api.management.v1.UnshareFolderRequest

Field	Type	Label	Description
folder	string		Resource name of the folder to unshare.
group	string		Resource name of the user group to unshare the folder from.

UpdateFolderRequest

exabel.api.management.v1.UpdateFolderRequest

Field	Type	Label	Description
folder	Folder		The updated folder. The resource name must be set. Only the display name, and description can be set.
update_mask	google.protobuf.FieldMask		Use this to update only selected fields. For example, specify `display_name` to update only the display name. If `allow_missing` is set, this field is ignored. Currently, only the display name and description may be modified.

For REST requests, this is a comma-separated string. |
| allow_missing | bool | | If set to true, a new folder will be created if it did not exist, and update_mask is ignored. |

Group

exabel.api.management.v1.Group

A group.

Field	Type	Label	Description
name	string		Unique resource name of the user group, e.g. `groups/123`.
display_name	string		Display name of the user group, shown in the Library when sharing a folder with any of the customer user groups.
users	User	repeated	List of users in this user group. Only populated for some responses (refer to documentation for each method).

User

exabel.api.management.v1.User

A user.

Field	Type	Description
name	string	Unique resource name of the user, e.g. `users/123`.
email	string	User's email.
blocked	bool	Whether 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.

Field	Type	Label	Description
groups	Group	repeated	List of user groups, including users in each user group.

ListUsersRequest

exabel.api.management.v1.ListUsersRequest

Request to ListUsers.

No fields

ListUsersResponse

exabel.api.management.v1.ListUsersResponse

Response from ListUsers.

Field	Type	Label	Description
users	User	repeated	List of users.