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
InboxService
/api/v2/inboxes
GET
Summary
ListInboxes lists inboxes for a user.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| user |
query |
Format: users/{username} |
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/{uid} |
Yes |
string |
| inbox |
body |
|
Yes |
{ "sender": string, "receiver": string, "status": v2InboxStatus, "createTime": dateTime, "type": v2InboxType, "activityId": integer } |
Responses
/api/v2/{name_1}
GET
Summary
GetResource returns a resource by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_1 |
path |
|
Yes |
string |
Responses
DELETE
Summary
DeleteInbox deletes an inbox.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_1 |
path |
The name of the inbox to delete. Format: inboxes/{uid} |
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/{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": apiv2RowStatus, "creator": string, "createTime": dateTime, "updateTime": dateTime, "displayTime": dateTime, "content": string, "visibility": v2Visibility, "pinned": boolean, "parentId": integer, "resources": [ v2Resource ], "relations": [ v2MemoRelation ], "reactions": [ apiv2Reaction ] } |
Responses
/api/v2/{name_2}
GET
Summary
GetMemo gets a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_2 |
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_2 |
path |
|
Yes |
string |
Responses
/api/v2/{name_3}
DELETE
Summary
DeleteMemo deletes a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_3 |
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}/reactions/{reactionId}
DELETE
Summary
DeleteMemoReaction deletes a reaction for a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name |
path |
The name of the memo. Format: memos/{id} |
Yes |
string |
| reactionId |
path |
|
Yes |
integer |
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 |
| filename |
query |
|
No |
string |
| externalLink |
query |
|
No |
string |
| type |
query |
|
No |
string |
| memoId |
query |
|
No |
integer |
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_1}
GET
Summary
GetResource returns a resource by name.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_1 |
path |
|
Yes |
string |
Responses
DELETE
Summary
DeleteInbox deletes an inbox.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_1 |
path |
The name of the inbox to delete. Format: inboxes/{uid} |
Yes |
string |
Responses
/api/v2/{name_2}
GET
Summary
GetMemo gets a memo.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| name_2 |
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_2 |
path |
|
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, "externalLink": string, "type": string, "size": string (int64), "memoId": integer } |
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
/api/v2/users:search
GET
Summary
SearchUsers searches users by filter.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| filter |
query |
|
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, "telegramUserId": 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": apiv2RowStatus, "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": apiv2RowStatus, "name": string, "url": string } |
Responses
WorkspaceService
/api/v2/workspace/profile
GET
Summary
GetWorkspaceProfile returns the workspace profile.
Responses
WorkspaceSettingService
/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
| Name |
Located in |
Description |
Required |
Schema |
| setting.name |
path |
name is the name of the setting. Format: settings/{setting} |
Yes |
string |
| setting |
body |
setting is the setting to update. |
Yes |
{ "generalSetting": apiv2WorkspaceGeneralSetting } |
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 |
apiv2Reaction
| Name |
Type |
Description |
Required |
| id |
integer |
|
No |
| creator |
string |
|
No |
| contentId |
string |
|
No |
| reactionType |
apiv2ReactionType |
|
No |
apiv2ReactionType
| Name |
Type |
Description |
Required |
| apiv2ReactionType |
string |
|
|
apiv2RowStatus
| Name |
Type |
Description |
Required |
| apiv2RowStatus |
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 |
| telegramUserId |
string |
The telegram user id of the user. |
No |
apiv2Webhook
| Name |
Type |
Description |
Required |
| id |
integer |
|
No |
| creatorId |
integer |
|
No |
| createdTime |
dateTime |
|
No |
| updatedTime |
dateTime |
|
No |
| rowStatus |
apiv2RowStatus |
|
No |
| name |
string |
|
No |
| url |
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 |
apiv2WorkspaceSetting
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| generalSetting |
apiv2WorkspaceGeneralSetting |
general_setting is the general setting of workspace. |
No |
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 |
|
|
| 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 |
v2CreateUserAccessTokenResponse
v2CreateUserResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2CreateWebhookRequest
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| url |
string |
|
No |
v2CreateWebhookResponse
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 |
|
|
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 |
v2GetLinkMetadataResponse
v2GetMemoResponse
| Name |
Type |
Description |
Required |
| memo |
v2Memo |
|
No |
v2GetResourceResponse
| Name |
Type |
Description |
Required |
| resource |
v2Resource |
|
No |
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
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 |
v2ListInboxesResponse
| Name |
Type |
Description |
Required |
| inboxes |
[ v2Inbox ] |
|
No |
| Name |
Type |
Description |
Required |
| memos |
[ v2Memo ] |
|
No |
v2ListMemoReactionsResponse
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 |
v2ListTagsResponse
| Name |
Type |
Description |
Required |
| tags |
[ v2Tag ] |
|
No |
v2ListUserAccessTokensResponse
v2ListUsersResponse
| Name |
Type |
Description |
Required |
| users |
[ v2User ] |
|
No |
v2ListWebhooksResponse
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 |
apiv2RowStatus |
|
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 |
[ apiv2Reaction ] |
|
No |
v2MemoRelation
| Name |
Type |
Description |
Required |
| memo |
string |
|
No |
| relatedMemo |
string |
|
No |
| type |
v2MemoRelationType |
|
No |
v2MemoRelationType
| Name |
Type |
Description |
Required |
| v2MemoRelationType |
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 |
| externalLink |
string |
|
No |
| type |
string |
|
No |
| size |
string (int64) |
|
No |
| memoId |
integer |
|
No |
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 |
v2UpdateInboxResponse
| Name |
Type |
Description |
Required |
| inbox |
v2Inbox |
|
No |
v2UpdateMemoResponse
| Name |
Type |
Description |
Required |
| memo |
v2Memo |
|
No |
v2UpdateResourceResponse
| Name |
Type |
Description |
Required |
| resource |
v2Resource |
|
No |
v2UpdateUserResponse
| Name |
Type |
Description |
Required |
| user |
v2User |
|
No |
v2UpdateUserSettingResponse
v2UpdateWebhookResponse
v2UpsertMemoReactionResponse
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 |
apiv2RowStatus |
|
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 |
|
|
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 |
| disallowSignup |
boolean |
disallow_signup is whether the signup is disallowed. |
No |
| disablePasswordLogin |
boolean |
disable_password_login is whether the password login is disabled. |
No |
| additionalScript |
string |
additional_script is the additional script. |
No |
| additionalStyle |
string |
additional_style is the additional style. |
No |
