api/v2/activity_service.proto
Version: version not set
AuthService
/api/v2/auth/signin
POST
Summary
SignIn signs in the user with the given username and password.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| username |
query |
|
No |
string |
| password |
query |
|
No |
string |
| neverExpire |
query |
|
No |
boolean |
Responses
/api/v2/auth/signin/sso
POST
Summary
SignInWithSSO signs in the user with the given SSO code.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| idpId |
query |
|
No |
integer |
| code |
query |
|
No |
string |
| redirectUri |
query |
|
No |
string |
Responses
/api/v2/auth/signout
POST
Summary
SignOut signs out the user.
Responses
/api/v2/auth/signup
POST
Summary
SignUp signs up the user with the given username and password.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| username |
query |
|
No |
string |
| password |
query |
|
No |
string |
Responses
/api/v2/auth/status
POST
Summary
GetAuthStatus returns the current auth status of the user.
Responses
IdentityProviderService
/api/v2/identityProviders
GET
Responses
POST
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| identityProvider.name |
query |
The name of the identityProvider. Format: identityProviders/{id} |
No |
string |
| identityProvider.type |
query |
|
No |
string |
| identityProvider.title |
query |
|
No |
string |
| identityProvider.identifierFilter |
query |
|
No |
string |
| identityProvider.config.oauth2Config.clientId |
query |
|
No |
string |
| identityProvider.config.oauth2Config.clientSecret |
query |
|
No |
string |
| identityProvider.config.oauth2Config.authUrl |
query |
|
No |
string |
| identityProvider.config.oauth2Config.tokenUrl |
query |
|
No |
string |
| identityProvider.config.oauth2Config.userInfoUrl |
query |
|
No |
string |
| identityProvider.config.oauth2Config.scopes |
query |
|
No |
[ string ] |
| identityProvider.config.oauth2Config.fieldMapping.identifier |
query |
|
No |
string |
| identityProvider.config.oauth2Config.fieldMapping.displayName |
query |
|
No |
string |
| identityProvider.config.oauth2Config.fieldMapping.email |
query |
|
No |
string |
Responses
/api/v2/{identityProvider.name}
PATCH
Summary
UpdateIdentityProvider updates an identity provider.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| identityProvider.name |
path |
The name of the identityProvider. Format: identityProviders/{id} |
Yes |
string |
| identityProvider |
body |
The identityProvider to update. |
Yes |
{ "type": apiv2IdentityProviderType, "title": string, "identifierFilter": string, "config": apiv2IdentityProviderConfig } |
Responses
/api/v2/{name_1}
GET
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_1 |
path |
The name of the identityProvider to get. Format: identityProviders/{id} |
Yes |
string |
Responses
DELETE
Summary
DeleteIdentityProvider deletes an identity provider.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_1 |
path |
The name of the identityProvider to delete. Format: identityProviders/{id} |
Yes |
string |
Responses
InboxService
/api/v2/inboxes
GET
Summary
ListInboxes lists inboxes for a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| user |
query |
Format: users/{id} |
No |
string |
Responses
/api/v2/{inbox.name}
PATCH
Summary
UpdateInbox updates an inbox.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| inbox.name |
path |
The name of the inbox. Format: inboxes/{id} |
Yes |
string |
| inbox |
body |
|
Yes |
{ "sender": string, "receiver": string, "status": v2InboxStatus, "createTime": dateTime, "type": v2InboxType, "activityId": integer } |
Responses
/api/v2/{name_2}
GET
Summary
GetResource returns a resource by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_2 |
path |
The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
Yes |
string |
Responses
DELETE
Summary
DeleteInbox deletes an inbox.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_2 |
path |
The name of the inbox to delete. Format: inboxes/{id} |
Yes |
string |
Responses
LinkService
/api/v2/link_metadata
GET
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| link |
query |
|
No |
string |
Responses
MemoService
/api/v2/memos
GET
Summary
ListMemos lists memos with pagination and filter.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pageSize |
query |
The maximum number of memos to return. |
No |
integer |
| pageToken |
query |
A page token, received from a previous ListMemos call. Provide this to retrieve the subsequent page. |
No |
string |
| filter |
query |
Filter is used to filter memos returned in the list. Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']" |
No |
string |
Responses
POST
Summary
CreateMemo creates a memo.
Parameters
Responses
/api/v2/memos/stats
GET
Summary
GetUserMemosStats gets stats of memos for a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
query |
name is the name of the user to get stats for. Format: users/{id} |
No |
string |
| timezone |
query |
timezone location Format: uses tz identifier https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
No |
string |
| filter |
query |
Same as ListMemosRequest.filter |
No |
string |
Responses
/api/v2/memos:export
POST
Summary
ExportMemos exports memos.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| filter |
query |
Same as ListMemosRequest.filter |
No |
string |
Responses
/api/v2/memos:search
GET
Summary
SearchMemos searches memos.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| filter |
query |
Filter is used to filter memos returned. Format: "creator == users/{uid} && visibilities == ['PUBLIC', 'PROTECTED']" |
No |
string |
Responses
/api/v2/reactions/{reactionId}
DELETE
Summary
DeleteMemoReaction deletes a reaction for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| reactionId |
path |
|
Yes |
integer |
Responses
/api/v2/{memo.name}
PATCH
Summary
UpdateMemo updates a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| memo.name |
path |
The name of the memo. Format: memos/{id} id is the system generated id. |
Yes |
string |
| memo |
body |
|
Yes |
{ "uid": string, "rowStatus": v2RowStatus, "creator": string, "createTime": dateTime, "updateTime": dateTime, "displayTime": dateTime, "content": string, "visibility": v2Visibility, "pinned": boolean, "parentId": integer, "resources": [ v2Resource ], "relations": [ v2MemoRelation ], "reactions": [ v2Reaction ] } |
Responses
/api/v2/{name_3}
GET
Summary
GetMemo gets a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_3 |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
Responses
DELETE
Summary
DeleteResource deletes a resource by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_3 |
path |
The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
Yes |
string |
Responses
/api/v2/{name_4}
DELETE
Summary
DeleteMemo deletes a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_4 |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
Responses
GET
Summary
ListMemoComments lists comments for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
Responses
POST
Summary
CreateMemoComment creates a comment for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
| comment.content |
query |
|
No |
string |
| comment.visibility |
query |
|
No |
string |
Responses
/api/v2/{name}/reactions
GET
Summary
ListMemoReactions lists reactions for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
Responses
POST
Summary
UpsertMemoReaction upserts a reaction for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
| reaction.id |
query |
|
No |
integer |
| reaction.creator |
query |
The name of the creator. Format: users/{id} |
No |
string |
| reaction.contentId |
query |
|
No |
string |
| reaction.reactionType |
query |
|
No |
string |
Responses
/api/v2/{name}/relations
GET
Summary
ListMemoRelations lists relations for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
Responses
POST
Summary
SetMemoRelations sets relations for a memo.
Parameters
Responses
/api/v2/{name}/resources
GET
Summary
ListMemoResources lists resources for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
Responses
POST
Summary
SetMemoResources sets resources for a memo.
Parameters
Responses
ResourceService
/api/v2/resources
GET
Summary
ListResources lists all resources.
Responses
POST
Summary
CreateResource creates a new resource.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| resource.name |
query |
The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
No |
string |
| resource.uid |
query |
The user defined id of the resource. |
No |
string |
| resource.createTime |
query |
|
No |
dateTime |
| resource.filename |
query |
|
No |
string |
| resource.content |
query |
|
No |
byte |
| resource.externalLink |
query |
|
No |
string |
| resource.type |
query |
|
No |
string |
| resource.size |
query |
|
No |
string (int64) |
| resource.memo |
query |
The related memo. Format: memos/{id} |
No |
string |
Responses
/api/v2/resources:search
GET
Summary
SearchResources searches memos.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| filter |
query |
|
No |
string |
Responses
/api/v2/{name_2}
GET
Summary
GetResource returns a resource by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_2 |
path |
The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
Yes |
string |
Responses
DELETE
Summary
DeleteInbox deletes an inbox.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_2 |
path |
The name of the inbox to delete. Format: inboxes/{id} |
Yes |
string |
Responses
/api/v2/{name_3}
GET
Summary
GetMemo gets a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_3 |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
Responses
DELETE
Summary
DeleteResource deletes a resource by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_3 |
path |
The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
Yes |
string |
Responses
/api/v2/{resource.name}
PATCH
Summary
UpdateResource updates a resource.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| resource.name |
path |
The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
Yes |
string |
| resource |
body |
|
Yes |
{ "uid": string, "createTime": dateTime, "filename": string, "content": byte, "externalLink": string, "type": string, "size": string (int64), "memo": string } |
Responses
StorageService
/api/v2/storages
GET
Summary
ListStorages returns a list of storages.
Responses
POST
Summary
CreateStorage creates a new storage.
Parameters
Responses
/api/v2/storages/{id}
GET
Summary
GetStorage returns a storage by id.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
|
Yes |
integer |
Responses
DELETE
Summary
DeleteStorage deletes a storage by id.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
|
Yes |
integer |
Responses
/api/v2/storages/{storage.id}
PATCH
Summary
UpdateStorage updates a storage.
Parameters
Responses
TagService
/api/v2/tags
GET
Summary
ListTags lists tags.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| user |
query |
The creator of tags. Format: users/{id} |
No |
string |
Responses
DELETE
Summary
DeleteTag deletes a tag.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| tag.name |
query |
|
No |
string |
| tag.creator |
query |
The creator of tags. Format: users/{id} |
No |
string |
Responses
POST
Summary
UpsertTag upserts a tag.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
query |
|
No |
string |
Responses
/api/v2/tags/suggestion
GET
Summary
GetTagSuggestions gets tag suggestions from the user's memos.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| user |
query |
The creator of tags. Format: users/{id} |
No |
string |
Responses
/api/v2/tags:batchUpsert
POST
Summary
BatchUpsertTag upserts multiple tags.
Responses
/api/v2/tags:rename
PATCH
Summary
RenameTag renames a tag.
All related memos will be updated.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| user |
query |
The creator of tags. Format: users/{id} |
No |
string |
| oldName |
query |
|
No |
string |
| newName |
query |
|
No |
string |
Responses
UserService
/api/v2/users
GET
Summary
ListUsers returns a list of users.
Responses
POST
Summary
CreateUser creates a new user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| user |
body |
|
Yes |
v2User |
Responses
GET
Summary
SearchUsers searches users by filter.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| filter |
query |
Filter is used to filter users returned in the list. Format: "username == frank" |
No |
string |
Responses
/api/v2/{name}
GET
Summary
GetUser gets a user by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the user. Format: users/{id} |
Yes |
string |
Responses
DELETE
Summary
DeleteUser deletes a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the user. Format: users/{id} |
Yes |
string |
Responses
/api/v2/{name}/access_tokens
GET
Summary
ListUserAccessTokens returns a list of access tokens for a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the user. Format: users/{id} |
Yes |
string |
Responses
POST
Summary
CreateUserAccessToken creates a new access token for a user.
Parameters
Responses
/api/v2/{name}/access_tokens/{accessToken}
DELETE
Summary
DeleteUserAccessToken deletes an access token for a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the user. Format: users/{id} |
Yes |
string |
| accessToken |
path |
access_token is the access token to delete. |
Yes |
string |
Responses
/api/v2/{name}/setting
GET
Summary
GetUserSetting gets the setting of a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the user. Format: users/{id} |
Yes |
string |
Responses
/api/v2/{setting.name}
PATCH
Summary
UpdateUserSetting updates the setting of a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| setting.name |
path |
The name of the user. Format: users/{id} |
Yes |
string |
| setting |
body |
|
Yes |
{ "locale": string, "appearance": string, "memoVisibility": string } |
Responses
/api/v2/{user.name}
PATCH
Summary
UpdateUser updates a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| user.name |
path |
The name of the user. Format: users/{id} |
Yes |
string |
| user |
body |
|
Yes |
{ "id": integer, "role": UserRole, "username": string, "email": string, "nickname": string, "avatarUrl": string, "description": string, "password": string, "rowStatus": v2RowStatus, "createTime": dateTime, "updateTime": dateTime } |
Responses
WebhookService
/api/v2/webhooks
GET
Summary
ListWebhooks returns a list of webhooks.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| creatorId |
query |
|
No |
integer |
Responses
POST
Summary
CreateWebhook creates a new webhook.
Parameters
Responses
/api/v2/webhooks/{id}
GET
Summary
GetWebhook returns a webhook by id.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
|
Yes |
integer |
Responses
DELETE
Summary
DeleteWebhook deletes a webhook by id.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
|
Yes |
integer |
Responses
/api/v2/webhooks/{webhook.id}
PATCH
Summary
UpdateWebhook updates a webhook.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| webhook.id |
path |
|
Yes |
integer |
| webhook |
body |
|
Yes |
{ "creatorId": integer, "createdTime": dateTime, "updatedTime": dateTime, "rowStatus": v2RowStatus, "name": string, "url": string } |
Responses
WorkspaceService
/api/v2/workspace/profile
GET
Summary
GetWorkspaceProfile returns the workspace profile.
Responses
WorkspaceSettingService
/api/v2/workspace/settings
GET
Summary
ListWorkspaceSetting returns the list of settings.
Responses
/api/v2/workspace/{name}
GET
Summary
GetWorkspaceSetting returns the setting by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The resource name of the workspace setting. Format: settings/{setting} |
Yes |
string |
Responses
/api/v2/workspace/{setting.name}
PATCH
Summary
SetWorkspaceSetting updates the setting.
Parameters
Responses
ActivityService
/v2/activities/{id}
GET
Summary
GetActivity returns the activity with the given id.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
|
Yes |
integer |
Responses
Models
MemoServiceSetMemoRelationsBody
MemoServiceSetMemoResourcesBody
| Name |
Type |
Description |
Required |
| resources |
[ v2Resource ] |
|
No |
UserRole
| Name |
Type |
Description |
Required |
| UserRole |
string |
|
|
UserServiceCreateUserAccessTokenBody
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| expiresAt |
dateTime |
|
No |
| Name |
Type |
Description |
Required |
| memoId |
integer |
|
No |
| relatedMemoId |
integer |
|
No |
apiv2ActivityPayload
apiv2ActivityVersionUpdatePayload
| Name |
Type |
Description |
Required |
| version |
string |
|
No |
apiv2FieldMapping
| Name |
Type |
Description |
Required |
| identifier |
string |
|
No |
| displayName |
string |
|
No |
| email |
string |
|
No |
apiv2IdentityProvider
apiv2IdentityProviderConfig
apiv2IdentityProviderType
| Name |
Type |
Description |
Required |
| apiv2IdentityProviderType |
string |
|
|
apiv2OAuth2Config
| Name |
Type |
Description |
Required |
| clientId |
string |
|
No |
| clientSecret |
string |
|
No |
| authUrl |
string |
|
No |
| tokenUrl |
string |
|
No |
| userInfoUrl |
string |
|
No |
| scopes |
[ string ] |
|
No |
| fieldMapping |
apiv2FieldMapping |
|
No |
apiv2S3Config
| Name |
Type |
Description |
Required |
| endPoint |
string |
|
No |
| path |
string |
|
No |
| region |
string |
|
No |
| accessKey |
string |
|
No |
| secretKey |
string |
|
No |
| bucket |
string |
|
No |
| urlPrefix |
string |
|
No |
| urlSuffix |
string |
|
No |
| preSign |
boolean |
|
No |
apiv2Storage
apiv2StorageConfig
apiv2StorageType
| Name |
Type |
Description |
Required |
| apiv2StorageType |
string |
|
|
apiv2UserSetting
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| locale |
string |
The preferred locale of the user. |
No |
| appearance |
string |
The preferred appearance of the user. |
No |
| memoVisibility |
string |
The default visibility of the memo. |
No |
apiv2WorkspaceCustomProfile
| Name |
Type |
Description |
Required |
| title |
string |
|
No |
| description |
string |
|
No |
| logoUrl |
string |
|
No |
| locale |
string |
|
No |
| appearance |
string |
|
No |
apiv2WorkspaceGeneralSetting
| Name |
Type |
Description |
Required |
| instanceUrl |
string |
instance_url is the instance URL. |
No |
| disallowSignup |
boolean |
disallow_signup is the flag to disallow signup. |
No |
| disallowPasswordLogin |
boolean |
disallow_password_login is the flag to disallow password login. |
No |
| additionalScript |
string |
additional_script is the additional script. |
No |
| additionalStyle |
string |
additional_style is the additional style. |
No |
| customProfile |
apiv2WorkspaceCustomProfile |
custom_profile is the custom profile. |
No |
apiv2WorkspaceMemoRelatedSetting
| Name |
Type |
Description |
Required |
| disallowPublicVisible |
boolean |
disallow_public_share disallows set memo as public visible. |
No |
| displayWithUpdateTime |
boolean |
display_with_update_time orders and displays memo with update time. |
No |
apiv2WorkspaceSetting
apiv2WorkspaceStorageSetting
| Name |
Type |
Description |
Required |
| storageType |
apiv2WorkspaceStorageSettingStorageType |
storage_type is the storage type. |
No |
| activedExternalStorageId |
integer |
The id of actived external storage. |
No |
| localStoragePathTemplate |
string |
|
No |
| uploadSizeLimitMb |
string (int64) |
The max upload size in megabytes. |
No |
apiv2WorkspaceStorageSettingStorageType
- STORAGE_TYPE_DATABASE: STORAGE_TYPE_DATABASE is the database storage type.
- STORAGE_TYPE_LOCAL: STORAGE_TYPE_LOCAL is the local storage type.
- STORAGE_TYPE_EXTERNAL: STORAGE_TYPE_EXTERNAL is the external storage type.
| Name |
Type |
Description |
Required |
| apiv2WorkspaceStorageSettingStorageType |
string |
- STORAGE_TYPE_DATABASE: STORAGE_TYPE_DATABASE is the database storage type. - STORAGE_TYPE_LOCAL: STORAGE_TYPE_LOCAL is the local storage type. - STORAGE_TYPE_EXTERNAL: STORAGE_TYPE_EXTERNAL is the external storage type. |
|
googlerpcStatus
| Name |
Type |
Description |
Required |
| code |
integer |
|
No |
| message |
string |
|
No |
| details |
[ protobufAny ] |
|
No |
protobufAny
| Name |
Type |
Description |
Required |
| @type |
string |
|
No |
v2Activity
| Name |
Type |
Description |
Required |
| id |
integer |
|
No |
| creatorId |
integer |
|
No |
| type |
string |
|
No |
| level |
string |
|
No |
| createTime |
dateTime |
|
No |
| payload |
apiv2ActivityPayload |
|
No |
v2BatchUpsertTagResponse
| Name |
Type |
Description |
Required |
| v2BatchUpsertTagResponse |
object |
|
|
v2CreateIdentityProviderResponse
| Name |
Type |
Description |
Required |
| memo |
v2Memo |
|
No |
v2CreateMemoRequest
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| visibility |
v2Visibility |
|
No |
v2CreateMemoResponse
| Name |
Type |
Description |
Required |
| memo |
v2Memo |
|
No |
v2CreateResourceResponse
| Name |
Type |
Description |
Required |
| resource |
v2Resource |
|
No |
v2CreateStorageRequest
v2CreateStorageResponse
v2CreateUserAccessTokenResponse
v2CreateUserResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2CreateWebhookRequest
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| url |
string |
|
No |
v2CreateWebhookResponse
| Name |
Type |
Description |
Required |
| webhook |
v2Webhook |
|
No |
v2DeleteIdentityProviderResponse
| Name |
Type |
Description |
Required |
| v2DeleteIdentityProviderResponse |
object |
|
|
v2DeleteInboxResponse
| Name |
Type |
Description |
Required |
| v2DeleteInboxResponse |
object |
|
|
v2DeleteMemoReactionResponse
| Name |
Type |
Description |
Required |
| v2DeleteMemoReactionResponse |
object |
|
|
v2DeleteMemoResponse
| Name |
Type |
Description |
Required |
| v2DeleteMemoResponse |
object |
|
|
v2DeleteResourceResponse
| Name |
Type |
Description |
Required |
| v2DeleteResourceResponse |
object |
|
|
v2DeleteStorageResponse
| Name |
Type |
Description |
Required |
| v2DeleteStorageResponse |
object |
|
|
v2DeleteTagResponse
| Name |
Type |
Description |
Required |
| v2DeleteTagResponse |
object |
|
|
v2DeleteUserAccessTokenResponse
| Name |
Type |
Description |
Required |
| v2DeleteUserAccessTokenResponse |
object |
|
|
v2DeleteUserResponse
| Name |
Type |
Description |
Required |
| v2DeleteUserResponse |
object |
|
|
v2DeleteWebhookResponse
| Name |
Type |
Description |
Required |
| v2DeleteWebhookResponse |
object |
|
|
v2ExportMemosResponse
| Name |
Type |
Description |
Required |
| content |
byte |
|
No |
v2GetActivityResponse
| Name |
Type |
Description |
Required |
| activity |
v2Activity |
|
No |
v2GetAuthStatusResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2GetIdentityProviderResponse
v2GetLinkMetadataResponse
v2GetMemoResponse
| Name |
Type |
Description |
Required |
| memo |
v2Memo |
|
No |
v2GetResourceResponse
| Name |
Type |
Description |
Required |
| resource |
v2Resource |
|
No |
v2GetStorageResponse
v2GetTagSuggestionsResponse
| Name |
Type |
Description |
Required |
| tags |
[ string ] |
|
No |
v2GetUserMemosStatsResponse
| Name |
Type |
Description |
Required |
| stats |
object |
stats is the stats of memo creating/updating activities. key is the year-month-day string. e.g. "2020-01-01". |
No |
v2GetUserResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2GetUserSettingResponse
v2GetWebhookResponse
| Name |
Type |
Description |
Required |
| webhook |
v2Webhook |
|
No |
v2GetWorkspaceProfileResponse
v2GetWorkspaceSettingResponse
v2Inbox
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| sender |
string |
|
No |
| receiver |
string |
|
No |
| status |
v2InboxStatus |
|
No |
| createTime |
dateTime |
|
No |
| type |
v2InboxType |
|
No |
| activityId |
integer |
|
No |
v2InboxStatus
| Name |
Type |
Description |
Required |
| v2InboxStatus |
string |
|
|
v2InboxType
| Name |
Type |
Description |
Required |
| v2InboxType |
string |
|
|
v2LinkMetadata
| Name |
Type |
Description |
Required |
| title |
string |
|
No |
| description |
string |
|
No |
| image |
string |
|
No |
v2ListIdentityProvidersResponse
v2ListInboxesResponse
| Name |
Type |
Description |
Required |
| inboxes |
[ v2Inbox ] |
|
No |
| Name |
Type |
Description |
Required |
| memos |
[ v2Memo ] |
|
No |
v2ListMemoReactionsResponse
| Name |
Type |
Description |
Required |
| reactions |
[ v2Reaction ] |
|
No |
v2ListMemoRelationsResponse
v2ListMemoResourcesResponse
| Name |
Type |
Description |
Required |
| resources |
[ v2Resource ] |
|
No |
v2ListMemosResponse
| Name |
Type |
Description |
Required |
| memos |
[ v2Memo ] |
|
No |
| nextPageToken |
string |
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. |
No |
v2ListResourcesResponse
| Name |
Type |
Description |
Required |
| resources |
[ v2Resource ] |
|
No |
v2ListStoragesResponse
v2ListTagsResponse
| Name |
Type |
Description |
Required |
| tags |
[ v2Tag ] |
|
No |
v2ListUserAccessTokensResponse
v2ListUsersResponse
| Name |
Type |
Description |
Required |
| users |
[ v2User ] |
|
No |
v2ListWebhooksResponse
| Name |
Type |
Description |
Required |
| webhooks |
[ v2Webhook ] |
|
No |
v2ListWorkspaceSettingsResponse
v2Memo
| Name |
Type |
Description |
Required |
| name |
string |
The name of the memo. Format: memos/{id} id is the system generated id. |
No |
| uid |
string |
The user defined id of the memo. |
No |
| rowStatus |
v2RowStatus |
|
No |
| creator |
string |
|
No |
| createTime |
dateTime |
|
No |
| updateTime |
dateTime |
|
No |
| displayTime |
dateTime |
|
No |
| content |
string |
|
No |
| visibility |
v2Visibility |
|
No |
| pinned |
boolean |
|
No |
| parentId |
integer |
|
No |
| resources |
[ v2Resource ] |
|
No |
| relations |
[ v2MemoRelation ] |
|
No |
| reactions |
[ v2Reaction ] |
|
No |
v2MemoRelation
| Name |
Type |
Description |
Required |
| memo |
string |
|
No |
| relatedMemo |
string |
|
No |
| type |
v2MemoRelationType |
|
No |
v2MemoRelationType
| Name |
Type |
Description |
Required |
| v2MemoRelationType |
string |
|
|
v2Reaction
| Name |
Type |
Description |
Required |
| id |
integer |
|
No |
| creator |
string |
|
No |
| contentId |
string |
|
No |
| reactionType |
v2ReactionType |
|
No |
v2ReactionType
| Name |
Type |
Description |
Required |
| v2ReactionType |
string |
|
|
v2RenameTagResponse
| Name |
Type |
Description |
Required |
| tag |
v2Tag |
|
No |
v2Resource
| Name |
Type |
Description |
Required |
| name |
string |
The name of the resource. Format: resources/{id} id is the system generated unique identifier. |
No |
| uid |
string |
The user defined id of the resource. |
No |
| createTime |
dateTime |
|
No |
| filename |
string |
|
No |
| content |
byte |
|
No |
| externalLink |
string |
|
No |
| type |
string |
|
No |
| size |
string (int64) |
|
No |
| memo |
string |
|
No |
v2RowStatus
| Name |
Type |
Description |
Required |
| v2RowStatus |
string |
|
|
v2SearchMemosResponse
| Name |
Type |
Description |
Required |
| memos |
[ v2Memo ] |
|
No |
v2SearchResourcesResponse
| Name |
Type |
Description |
Required |
| resources |
[ v2Resource ] |
|
No |
v2SearchUsersResponse
| Name |
Type |
Description |
Required |
| users |
[ v2User ] |
|
No |
v2SetMemoRelationsResponse
| Name |
Type |
Description |
Required |
| v2SetMemoRelationsResponse |
object |
|
|
v2SetMemoResourcesResponse
| Name |
Type |
Description |
Required |
| v2SetMemoResourcesResponse |
object |
|
|
v2SetWorkspaceSettingResponse
v2SignInResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2SignInWithSSOResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2SignOutResponse
| Name |
Type |
Description |
Required |
| v2SignOutResponse |
object |
|
|
v2SignUpResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2Tag
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| creator |
string |
|
No |
v2UpdateIdentityProviderResponse
v2UpdateInboxResponse
| Name |
Type |
Description |
Required |
| inbox |
v2Inbox |
|
No |
v2UpdateMemoResponse
| Name |
Type |
Description |
Required |
| memo |
v2Memo |
|
No |
v2UpdateResourceResponse
| Name |
Type |
Description |
Required |
| resource |
v2Resource |
|
No |
v2UpdateStorageResponse
v2UpdateUserResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2UpdateUserSettingResponse
v2UpdateWebhookResponse
| Name |
Type |
Description |
Required |
| webhook |
v2Webhook |
|
No |
v2UpsertMemoReactionResponse
| Name |
Type |
Description |
Required |
| reaction |
v2Reaction |
|
No |
v2UpsertTagRequest
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
v2UpsertTagResponse
| Name |
Type |
Description |
Required |
| tag |
v2Tag |
|
No |
v2User
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| id |
integer |
The system generated uid of the user. |
No |
| role |
UserRole |
|
No |
| username |
string |
|
No |
| email |
string |
|
No |
| nickname |
string |
|
No |
| avatarUrl |
string |
|
No |
| description |
string |
|
No |
| password |
string |
|
No |
| rowStatus |
v2RowStatus |
|
No |
| createTime |
dateTime |
|
No |
| updateTime |
dateTime |
|
No |
v2UserAccessToken
| Name |
Type |
Description |
Required |
| accessToken |
string |
|
No |
| description |
string |
|
No |
| issuedAt |
dateTime |
|
No |
| expiresAt |
dateTime |
|
No |
v2Visibility
| Name |
Type |
Description |
Required |
| v2Visibility |
string |
|
|
v2Webhook
| Name |
Type |
Description |
Required |
| id |
integer |
|
No |
| creatorId |
integer |
|
No |
| createdTime |
dateTime |
|
No |
| updatedTime |
dateTime |
|
No |
| rowStatus |
v2RowStatus |
|
No |
| name |
string |
|
No |
| url |
string |
|
No |
v2WorkspaceProfile
| Name |
Type |
Description |
Required |
| owner |
string |
|
No |
| version |
string |
|
No |
| mode |
string |
mode is the instance mode (e.g. "prod", "dev" or "demo"). |
No |
