@datafire/amazonaws_workdocs

Client library for Amazon WorkDocs

Installation and Usage

npm install --save @datafire/amazonaws_workdocs

let amazonaws_workdocs = require('@datafire/amazonaws_workdocs').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_workdocs.DescribeActivities({}).then(data => {
  console.log(data);
});

Description

Actions

DescribeActivities

amazonaws_workdocs.DescribeActivities({}, context)

Input

• input object

Output

• output DescribeActivitiesResponse

InitiateDocumentVersionUpload

amazonaws_workdocs.InitiateDocumentVersionUpload({
  "ParentFolderId": ""
}, context)

Input

• input object
  • ContentCreatedTimestamp TimestampType
  • ContentModifiedTimestamp TimestampType
  • ContentType DocumentContentType
  • DocumentSizeInBytes SizeType
  • Id ResourceIdType
  • Name ResourceNameType
  • ParentFolderId required ResourceIdType

Output

Output schema unknown

DeleteDocument

amazonaws_workdocs.DeleteDocument({
  "DocumentId": ""
}, context)

Input

• input object
  • DocumentId required string

Output

Output schema unknown

GetDocument

amazonaws_workdocs.GetDocument({
  "DocumentId": ""
}, context)

Input

• input object
  • DocumentId required string

Output

• output GetDocumentResponse

UpdateDocument

amazonaws_workdocs.UpdateDocument({
  "DocumentId": ""
}, context)

Input

• input object
  • DocumentId required string
  • Name ResourceNameType
  • ParentFolderId ResourceIdType
  • ResourceState ResourceStateType

Output

Output schema unknown

GetDocumentPath

amazonaws_workdocs.GetDocumentPath({
  "DocumentId": ""
}, context)

Input

• input object
  • DocumentId required string

Output

• output GetDocumentPathResponse

DescribeDocumentVersions

amazonaws_workdocs.DescribeDocumentVersions({
  "DocumentId": ""
}, context)

Input

• input object
  • Limit string
  • Marker string
  • DocumentId required string

Output

• output DescribeDocumentVersionsResponse

AbortDocumentVersionUpload

amazonaws_workdocs.AbortDocumentVersionUpload({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

• input object
  • DocumentId required string
  • VersionId required string

Output

Output schema unknown

GetDocumentVersion

amazonaws_workdocs.GetDocumentVersion({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

• input object
  • DocumentId required string
  • VersionId required string

Output

• output GetDocumentVersionResponse

UpdateDocumentVersion

amazonaws_workdocs.UpdateDocumentVersion({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

• input object
  • DocumentId required string
  • VersionId required string
  • VersionStatus DocumentVersionStatus

Output

Output schema unknown

CreateComment

amazonaws_workdocs.CreateComment({
  "DocumentId": "",
  "VersionId": "",
  "Text": ""
}, context)

Input

• input object
  • DocumentId required string
  • VersionId required string
  • NotifyCollaborators BooleanType
  • ParentId CommentIdType
  • Text required CommentTextType
  • ThreadId CommentIdType
  • Visibility CommentVisibilityType

Output

Output schema unknown

DeleteComment

amazonaws_workdocs.DeleteComment({
  "DocumentId": "",
  "VersionId": "",
  "CommentId": ""
}, context)

Input

• input object
  • DocumentId required string
  • VersionId required string
  • CommentId required string

Output

Output schema unknown

DescribeComments

amazonaws_workdocs.DescribeComments({
  "DocumentId": "",
  "VersionId": ""
}, context)

Input

• input object
  • DocumentId required string
  • VersionId required string

Output

• output DescribeCommentsResponse

CreateFolder

amazonaws_workdocs.CreateFolder({
  "ParentFolderId": ""
}, context)

Input

• input object
  • Name ResourceNameType
  • ParentFolderId required ResourceIdType

Output

Output schema unknown

DeleteFolder

amazonaws_workdocs.DeleteFolder({
  "FolderId": ""
}, context)

Input

• input object
  • FolderId required string

Output

Output schema unknown

GetFolder

amazonaws_workdocs.GetFolder({
  "FolderId": ""
}, context)

Input

• input object
  • FolderId required string

Output

• output GetFolderResponse

UpdateFolder

amazonaws_workdocs.UpdateFolder({
  "FolderId": ""
}, context)

Input

• input object
  • FolderId required string
  • Name ResourceNameType
  • ParentFolderId ResourceIdType
  • ResourceState ResourceStateType

Output

Output schema unknown

DeleteFolderContents

amazonaws_workdocs.DeleteFolderContents({
  "FolderId": ""
}, context)

Input

• input object
  • FolderId required string

Output

Output schema unknown

DescribeFolderContents

amazonaws_workdocs.DescribeFolderContents({
  "FolderId": ""
}, context)

Input

• input object
  • Limit string
  • Marker string
  • FolderId required string

Output

• output DescribeFolderContentsResponse

GetFolderPath

amazonaws_workdocs.GetFolderPath({
  "FolderId": ""
}, context)

Input

• input object
  • FolderId required string

Output

• output GetFolderPathResponse

DescribeGroups

amazonaws_workdocs.DescribeGroups({}, context)

Input

• input object

Output

• output DescribeGroupsResponse

GetCurrentUser

amazonaws_workdocs.GetCurrentUser({}, context)

Input

• input object

Output

• output GetCurrentUserResponse

DescribeRootFolders

amazonaws_workdocs.DescribeRootFolders({}, context)

Input

• input object

Output

• output DescribeRootFoldersResponse

DescribeNotificationSubscriptions

amazonaws_workdocs.DescribeNotificationSubscriptions({
  "OrganizationId": ""
}, context)

Input

• input object
  • OrganizationId required string

Output

• output DescribeNotificationSubscriptionsResponse

CreateNotificationSubscription

amazonaws_workdocs.CreateNotificationSubscription({
  "OrganizationId": "",
  "Endpoint": "",
  "Protocol": "",
  "SubscriptionType": ""
}, context)

Input

• input object
  • OrganizationId required string
  • Endpoint required SubscriptionEndPointType
  • Protocol required SubscriptionProtocolType
  • SubscriptionType required SubscriptionType

Output

• output CreateNotificationSubscriptionResponse

DeleteNotificationSubscription

amazonaws_workdocs.DeleteNotificationSubscription({
  "OrganizationId": "",
  "SubscriptionId": ""
}, context)

Input

• input object
  • OrganizationId required string
  • SubscriptionId required string

Output

Output schema unknown

DeleteCustomMetadata

amazonaws_workdocs.DeleteCustomMetadata({
  "ResourceId": ""
}, context)

Input

• input object
  • ResourceId required string

Output

• output DeleteCustomMetadataResponse

CreateCustomMetadata

amazonaws_workdocs.CreateCustomMetadata({
  "ResourceId": "",
  "CustomMetadata": []
}, context)

Input

• input object
  • ResourceId required string
  • CustomMetadata required CustomMetadataMap

Output

• output CreateCustomMetadataResponse

DeleteLabels

amazonaws_workdocs.DeleteLabels({
  "ResourceId": ""
}, context)

Input

• input object
  • ResourceId required string

Output

• output DeleteLabelsResponse

CreateLabels

amazonaws_workdocs.CreateLabels({
  "ResourceId": "",
  "Labels": []
}, context)

Input

• input object
  • ResourceId required string
  • Labels required SharedLabels

Output

• output CreateLabelsResponse

RemoveAllResourcePermissions

amazonaws_workdocs.RemoveAllResourcePermissions({
  "ResourceId": ""
}, context)

Input

• input object
  • ResourceId required string

Output

Output schema unknown

DescribeResourcePermissions

amazonaws_workdocs.DescribeResourcePermissions({
  "ResourceId": ""
}, context)

Input

• input object
  • ResourceId required string

Output

• output DescribeResourcePermissionsResponse

AddResourcePermissions

amazonaws_workdocs.AddResourcePermissions({
  "ResourceId": "",
  "Principals": []
}, context)

Input

• input object
  • ResourceId required string
  • NotificationOptions NotificationOptions
  • Principals required SharePrincipalList

Output

Output schema unknown

RemoveResourcePermission

amazonaws_workdocs.RemoveResourcePermission({
  "ResourceId": "",
  "PrincipalId": ""
}, context)

Input

• input object
  • ResourceId required string
  • PrincipalId required string

Output

Output schema unknown

DescribeUsers

amazonaws_workdocs.DescribeUsers({}, context)

Input

• input object
  • Limit string
  • Marker string

Output

• output DescribeUsersResponse

CreateUser

amazonaws_workdocs.CreateUser({
  "Username": "",
  "GivenName": "",
  "Surname": "",
  "Password": ""
}, context)

Input

• input object
  • EmailAddress EmailAddressType
  • GivenName required UserAttributeValueType
  • OrganizationId IdType
  • Password required PasswordType
  • StorageRule StorageRuleType
  • Surname required UserAttributeValueType
  • TimeZoneId TimeZoneIdType
  • Username required UsernameType

Output

Output schema unknown

DeleteUser

amazonaws_workdocs.DeleteUser({
  "UserId": ""
}, context)

Input

• input object
  • UserId required string

Output

Output schema unknown

UpdateUser

amazonaws_workdocs.UpdateUser({
  "UserId": ""
}, context)

Input

• input object
  • UserId required string
  • GivenName UserAttributeValueType
  • GrantPoweruserPrivileges BooleanEnumType
  • Locale LocaleType
  • StorageRule StorageRuleType
  • Surname UserAttributeValueType
  • TimeZoneId TimeZoneIdType
  • Type UserType

Output

• output UpdateUserResponse

DeactivateUser

amazonaws_workdocs.DeactivateUser({
  "UserId": ""
}, context)

Input

• input object
  • UserId required string

Output

Output schema unknown

ActivateUser

amazonaws_workdocs.ActivateUser({
  "UserId": ""
}, context)

Input

• input object
  • UserId required string

Output

• output ActivateUserResponse

Definitions

AbortDocumentVersionUploadRequest

• AbortDocumentVersionUploadRequest object

ActivateUserRequest

• ActivateUserRequest object

ActivateUserResponse

• ActivateUserResponse object
  • User User

Activity

• Activity object: Describes the activity information.
  • CommentMetadata CommentMetadata
  • Initiator UserMetadata
  • OrganizationId IdType
  • OriginalParent ResourceMetadata
  • Participants Participants
  • ResourceMetadata ResourceMetadata
  • TimeStamp TimestampType
  • Type ActivityType

ActivityType

• ActivityType string (values: DOCUMENT_CHECKED_IN, DOCUMENT_CHECKED_OUT, DOCUMENT_RENAMED, DOCUMENT_VERSION_UPLOADED, DOCUMENT_VERSION_DELETED, DOCUMENT_RECYCLED, DOCUMENT_RESTORED, DOCUMENT_REVERTED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, DOCUMENT_SHARE_PERMISSION_CHANGED, DOCUMENT_SHAREABLE_LINK_CREATED, DOCUMENT_SHAREABLE_LINK_REMOVED, DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED, DOCUMENT_MOVED, DOCUMENT_COMMENT_ADDED, DOCUMENT_COMMENT_DELETED, DOCUMENT_ANNOTATION_ADDED, DOCUMENT_ANNOTATION_DELETED, FOLDER_CREATED, FOLDER_DELETED, FOLDER_RENAMED, FOLDER_RECYCLED, FOLDER_RESTORED, FOLDER_SHARED, FOLDER_UNSHARED, FOLDER_SHARE_PERMISSION_CHANGED, FOLDER_SHAREABLE_LINK_CREATED, FOLDER_SHAREABLE_LINK_REMOVED, FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED, FOLDER_MOVED)

AddResourcePermissionsRequest

• AddResourcePermissionsRequest object
  • NotificationOptions NotificationOptions
  • Principals required SharePrincipalList

AddResourcePermissionsResponse

• AddResourcePermissionsResponse object
  • ShareResults ShareResultsList

AuthenticationHeaderType

• AuthenticationHeaderType string

BooleanEnumType

• BooleanEnumType string (values: TRUE, FALSE)

BooleanType

• BooleanType boolean

Comment

• Comment object: Describes a comment.
  • CommentId required CommentIdType
  • Contributor User
  • CreatedTimestamp TimestampType
  • ParentId CommentIdType
  • RecipientId IdType
  • Status CommentStatusType
  • Text CommentTextType
  • ThreadId CommentIdType
  • Visibility CommentVisibilityType

CommentIdType

• CommentIdType string

CommentList

• CommentList array
  • items Comment

CommentMetadata

• CommentMetadata object: Describes the metadata of a comment.
  • CommentId CommentIdType
  • CommentStatus CommentStatusType
  • Contributor User
  • CreatedTimestamp TimestampType
  • RecipientId IdType

CommentStatusType

• CommentStatusType string (values: DRAFT, PUBLISHED, DELETED)

CommentTextType

• CommentTextType string

CommentVisibilityType

• CommentVisibilityType string (values: PUBLIC, PRIVATE)

ConcurrentModificationException

• ConcurrentModificationException object: The resource hierarchy is changing.
  • Message ErrorMessageType

CreateCommentRequest

• CreateCommentRequest object
  • NotifyCollaborators BooleanType
  • ParentId CommentIdType
  • Text required CommentTextType
  • ThreadId CommentIdType
  • Visibility CommentVisibilityType

CreateCommentResponse

• CreateCommentResponse object
  • Comment Comment

CreateCustomMetadataRequest

• CreateCustomMetadataRequest object
  • CustomMetadata required CustomMetadataMap

CreateCustomMetadataResponse

• CreateCustomMetadataResponse object

CreateFolderRequest

• CreateFolderRequest object
  • Name ResourceNameType
  • ParentFolderId required ResourceIdType

CreateFolderResponse

• CreateFolderResponse object
  • Metadata FolderMetadata

CreateLabelsRequest

• CreateLabelsRequest object
  • Labels required SharedLabels

CreateLabelsResponse

• CreateLabelsResponse object

CreateNotificationSubscriptionRequest

• CreateNotificationSubscriptionRequest object
  • Endpoint required SubscriptionEndPointType
  • Protocol required SubscriptionProtocolType
  • SubscriptionType required SubscriptionType

CreateNotificationSubscriptionResponse

• CreateNotificationSubscriptionResponse object
  • Subscription Subscription

CreateUserRequest

• CreateUserRequest object
  • EmailAddress EmailAddressType
  • GivenName required UserAttributeValueType
  • OrganizationId IdType
  • Password required PasswordType
  • StorageRule StorageRuleType
  • Surname required UserAttributeValueType
  • TimeZoneId TimeZoneIdType
  • Username required UsernameType

CreateUserResponse

• CreateUserResponse object
  • User User

CustomMetadataKeyList

• CustomMetadataKeyList array
  • items CustomMetadataKeyType

CustomMetadataKeyType

• CustomMetadataKeyType string

CustomMetadataLimitExceededException

• CustomMetadataLimitExceededException object: The limit has been reached on the number of custom properties for the specified resource.
  • Message ErrorMessageType

CustomMetadataMap

• CustomMetadataMap array
  • items object
    • key CustomMetadataKeyType
    • value CustomMetadataValueType

CustomMetadataValueType

• CustomMetadataValueType string

DeactivateUserRequest

• DeactivateUserRequest object

DeactivatingLastSystemUserException

• DeactivatingLastSystemUserException object: The last user in the organization is being deactivated.

DeleteCommentRequest

• DeleteCommentRequest object

DeleteCustomMetadataRequest

• DeleteCustomMetadataRequest object

DeleteCustomMetadataResponse

• DeleteCustomMetadataResponse object

DeleteDocumentRequest

• DeleteDocumentRequest object

DeleteFolderContentsRequest

• DeleteFolderContentsRequest object

DeleteFolderRequest

• DeleteFolderRequest object

DeleteLabelsRequest

• DeleteLabelsRequest object

DeleteLabelsResponse

• DeleteLabelsResponse object

DeleteNotificationSubscriptionRequest

• DeleteNotificationSubscriptionRequest object

DeleteUserRequest

• DeleteUserRequest object

DescribeActivitiesRequest

• DescribeActivitiesRequest object

DescribeActivitiesResponse

• DescribeActivitiesResponse object
  • Marker MarkerType
  • UserActivities UserActivities

DescribeCommentsRequest

• DescribeCommentsRequest object

DescribeCommentsResponse

• DescribeCommentsResponse object
  • Comments CommentList
  • Marker MarkerType

DescribeDocumentVersionsRequest

• DescribeDocumentVersionsRequest object

DescribeDocumentVersionsResponse

• DescribeDocumentVersionsResponse object
  • DocumentVersions DocumentVersionMetadataList
  • Marker PageMarkerType

DescribeFolderContentsRequest

• DescribeFolderContentsRequest object

DescribeFolderContentsResponse

• DescribeFolderContentsResponse object
  • Documents DocumentMetadataList
  • Folders FolderMetadataList
  • Marker PageMarkerType

DescribeGroupsRequest

• DescribeGroupsRequest object

DescribeGroupsResponse

• DescribeGroupsResponse object
  • Groups GroupMetadataList
  • Marker MarkerType

DescribeNotificationSubscriptionsRequest

• DescribeNotificationSubscriptionsRequest object

DescribeNotificationSubscriptionsResponse

• DescribeNotificationSubscriptionsResponse object
  • Marker PageMarkerType
  • Subscriptions SubscriptionList

DescribeResourcePermissionsRequest

• DescribeResourcePermissionsRequest object

DescribeResourcePermissionsResponse

• DescribeResourcePermissionsResponse object
  • Marker PageMarkerType
  • Principals PrincipalList

DescribeRootFoldersRequest

• DescribeRootFoldersRequest object

DescribeRootFoldersResponse

• DescribeRootFoldersResponse object
  • Folders FolderMetadataList
  • Marker PageMarkerType

DescribeUsersRequest

• DescribeUsersRequest object

DescribeUsersResponse

• DescribeUsersResponse object
  • Marker PageMarkerType
  • TotalNumberOfUsers SizeType
  • Users OrganizationUserList

DocumentContentType

• DocumentContentType string

DocumentLockedForCommentsException

• DocumentLockedForCommentsException object: This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
  • Message ErrorMessageType

DocumentMetadata

• DocumentMetadata object: Describes the document.
  • CreatedTimestamp TimestampType
  • CreatorId IdType
  • Id ResourceIdType
  • Labels SharedLabels
  • LatestVersionMetadata DocumentVersionMetadata
  • ModifiedTimestamp TimestampType
  • ParentFolderId ResourceIdType
  • ResourceState ResourceStateType

DocumentMetadataList

• DocumentMetadataList array
  • items DocumentMetadata

DocumentSourceType

• DocumentSourceType string (values: ORIGINAL, WITH_COMMENTS)

DocumentSourceUrlMap

• DocumentSourceUrlMap array
  • items object
    • key DocumentSourceType
    • value UrlType

DocumentStatusType

• DocumentStatusType string (values: INITIALIZED, ACTIVE)

DocumentThumbnailType

• DocumentThumbnailType string (values: SMALL, SMALL_HQ, LARGE)

DocumentThumbnailUrlMap

• DocumentThumbnailUrlMap array
  • items object
    • key DocumentThumbnailType
    • value UrlType

DocumentVersionIdType

• DocumentVersionIdType string

DocumentVersionMetadata

• DocumentVersionMetadata object: Describes a version of a document.
  • ContentCreatedTimestamp TimestampType
  • ContentModifiedTimestamp TimestampType
  • ContentType DocumentContentType
  • CreatedTimestamp TimestampType
  • CreatorId IdType
  • Id DocumentVersionIdType
  • ModifiedTimestamp TimestampType
  • Name ResourceNameType
  • Signature HashType
  • Size SizeType
  • Source DocumentSourceUrlMap
  • Status DocumentStatusType
  • Thumbnail DocumentThumbnailUrlMap

DocumentVersionMetadataList

• DocumentVersionMetadataList array
  • items DocumentVersionMetadata

DocumentVersionStatus

• DocumentVersionStatus string (values: ACTIVE)

DraftUploadOutOfSyncException

• DraftUploadOutOfSyncException object: This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.
  • Message ErrorMessageType

EmailAddressType

• EmailAddressType string

EntityAlreadyExistsException

• EntityAlreadyExistsException object: The resource already exists.
  • Message ErrorMessageType

EntityIdList

• EntityIdList array
  • items IdType

EntityNotExistsException

• EntityNotExistsException object: The resource does not exist.
  • EntityIds EntityIdList
  • Message ErrorMessageType

ErrorMessageType

• ErrorMessageType string

FailedDependencyException

• FailedDependencyException object: The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
  • Message ErrorMessageType

FieldNamesType

• FieldNamesType string

FolderContentType

• FolderContentType string (values: ALL, DOCUMENT, FOLDER)

FolderMetadata

• FolderMetadata object: Describes a folder.
  • CreatedTimestamp TimestampType
  • CreatorId IdType
  • Id ResourceIdType
  • Labels SharedLabels
  • LatestVersionSize SizeType
  • ModifiedTimestamp TimestampType
  • Name ResourceNameType
  • ParentFolderId ResourceIdType
  • ResourceState ResourceStateType
  • Signature HashType
  • Size SizeType

FolderMetadataList

• FolderMetadataList array
  • items FolderMetadata

GetCurrentUserRequest

• GetCurrentUserRequest object

GetCurrentUserResponse

• GetCurrentUserResponse object
  • User User

GetDocumentPathRequest

• GetDocumentPathRequest object

GetDocumentPathResponse

• GetDocumentPathResponse object
  • Path ResourcePath

GetDocumentRequest

• GetDocumentRequest object

GetDocumentResponse

• GetDocumentResponse object
  • CustomMetadata CustomMetadataMap
  • Metadata DocumentMetadata

GetDocumentVersionRequest

• GetDocumentVersionRequest object

GetDocumentVersionResponse

• GetDocumentVersionResponse object
  • CustomMetadata CustomMetadataMap
  • Metadata DocumentVersionMetadata

GetFolderPathRequest

• GetFolderPathRequest object

GetFolderPathResponse

• GetFolderPathResponse object
  • Path ResourcePath

GetFolderRequest

• GetFolderRequest object

GetFolderResponse

• GetFolderResponse object
  • CustomMetadata CustomMetadataMap
  • Metadata FolderMetadata

GroupMetadata

• GroupMetadata object: Describes the metadata of a user group.
  • Id IdType
  • Name GroupNameType

GroupMetadataList

• GroupMetadataList array
  • items GroupMetadata

GroupNameType

• GroupNameType string

HashType

• HashType string

HeaderNameType

• HeaderNameType string

HeaderValueType

• HeaderValueType string

IdType

• IdType string

IllegalUserStateException

• IllegalUserStateException object: The user is undergoing transfer of ownership.
  • Message ErrorMessageType

InitiateDocumentVersionUploadRequest

• InitiateDocumentVersionUploadRequest object
  • ContentCreatedTimestamp TimestampType
  • ContentModifiedTimestamp TimestampType
  • ContentType DocumentContentType
  • DocumentSizeInBytes SizeType
  • Id ResourceIdType
  • Name ResourceNameType
  • ParentFolderId required ResourceIdType

InitiateDocumentVersionUploadResponse

• InitiateDocumentVersionUploadResponse object
  • Metadata DocumentMetadata
  • UploadMetadata UploadMetadata

InvalidArgumentException

• InvalidArgumentException object: The pagination marker or limit fields are not valid.
  • Message ErrorMessageType

InvalidOperationException

• InvalidOperationException object: The operation is invalid.
  • Message ErrorMessageType

InvalidPasswordException

• InvalidPasswordException object: The password is invalid.
  • Message ErrorMessageType

LimitExceededException

• LimitExceededException object: The maximum of 100,000 folders under the parent folder has been exceeded.
  • Message ErrorMessageType

LimitType

• LimitType integer

LocaleType

• LocaleType string (values: en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default)

MarkerType

• MarkerType string

MessageType

• MessageType string

NotificationOptions

• NotificationOptions object: Set of options which defines notification preferences of given action.
  • EmailMessage MessageType
  • SendEmail BooleanType

OrderType

• OrderType string (values: ASCENDING, DESCENDING)

OrganizationUserList

• OrganizationUserList array
  • items User

PageMarkerType

• PageMarkerType string

Participants

• Participants object: Describes the users or user groups.
  • Groups GroupMetadataList
  • Users UserMetadataList

PasswordType

• PasswordType string

PermissionInfo

• PermissionInfo object: Describes the permissions.
  • Role RoleType
  • Type RolePermissionType

PermissionInfoList

• PermissionInfoList array
  • items PermissionInfo

PositiveIntegerType

• PositiveIntegerType integer

PositiveSizeType

• PositiveSizeType integer

Principal

• Principal object: Describes a resource.
  • Id IdType
  • Roles PermissionInfoList
  • Type PrincipalType

PrincipalList

• PrincipalList array
  • items Principal

PrincipalType

• PrincipalType string (values: USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION)

ProhibitedStateException

• ProhibitedStateException object: The specified document version is not in the INITIALIZED state.
  • Message ErrorMessageType

RemoveAllResourcePermissionsRequest

• RemoveAllResourcePermissionsRequest object

RemoveResourcePermissionRequest

• RemoveResourcePermissionRequest object

ResourceAlreadyCheckedOutException

• ResourceAlreadyCheckedOutException object: The resource is already checked out.
  • Message ErrorMessageType

ResourceIdType

• ResourceIdType string

ResourceMetadata

• ResourceMetadata object: Describes the metadata of a resource.
  • Id ResourceIdType
  • Name ResourceNameType
  • OriginalName ResourceNameType
  • Owner UserMetadata
  • ParentId ResourceIdType
  • Type ResourceType
  • VersionId DocumentVersionIdType

ResourceNameType

• ResourceNameType string

ResourcePath

• ResourcePath object: Describes the path information of a resource.
  • Components ResourcePathComponentList

ResourcePathComponent

• ResourcePathComponent object: Describes the resource path.
  • Id IdType
  • Name ResourceNameType

ResourcePathComponentList

• ResourcePathComponentList array
  • items ResourcePathComponent

ResourceSortType

• ResourceSortType string (values: DATE, NAME)

ResourceStateType

• ResourceStateType string (values: ACTIVE, RESTORING, RECYCLING, RECYCLED)

ResourceType

• ResourceType string (values: FOLDER, DOCUMENT)

RolePermissionType

• RolePermissionType string (values: DIRECT, INHERITED)

RoleType

• RoleType string (values: VIEWER, CONTRIBUTOR, OWNER, COOWNER)

SearchQueryType

• SearchQueryType string

ServiceUnavailableException

• ServiceUnavailableException object: One or more of the dependencies is unavailable.
  • Message ErrorMessageType

SharePrincipal

• SharePrincipal object: Describes the recipient type and ID, if available.
  • Id required IdType
  • Role required RoleType
  • Type required PrincipalType

SharePrincipalList

• SharePrincipalList array
  • items SharePrincipal

ShareResult

• ShareResult object: Describes the share results of a resource.
  • PrincipalId IdType
  • Role RoleType
  • ShareId ResourceIdType
  • Status ShareStatusType
  • StatusMessage MessageType

ShareResultsList

• ShareResultsList array
  • items ShareResult

ShareStatusType

• ShareStatusType string (values: SUCCESS, FAILURE)

SharedLabel

• SharedLabel string

SharedLabels

• SharedLabels array
  • items SharedLabel

SignedHeaderMap

• SignedHeaderMap array
  • items object
    • key HeaderNameType
    • value HeaderValueType

SizeType

• SizeType integer

StorageLimitExceededException

• StorageLimitExceededException object: The storage limit has been exceeded.
  • Message ErrorMessageType

StorageLimitWillExceedException

• StorageLimitWillExceedException object: The storage limit will be exceeded.
  • Message ErrorMessageType

StorageRuleType

• StorageRuleType object: Describes the storage for a user.
  • StorageAllocatedInBytes PositiveSizeType
  • StorageType StorageType

StorageType

• StorageType string (values: UNLIMITED, QUOTA)

Subscription

• Subscription object: Describes a subscription.
  • EndPoint SubscriptionEndPointType
  • Protocol SubscriptionProtocolType
  • SubscriptionId IdType

SubscriptionEndPointType

• SubscriptionEndPointType string

SubscriptionList

• SubscriptionList array
  • items Subscription

SubscriptionProtocolType

• SubscriptionProtocolType string (values: HTTPS)

SubscriptionType

• SubscriptionType string (values: ALL)

TimeZoneIdType

• TimeZoneIdType string

TimestampType

• TimestampType string

TooManyLabelsException

• TooManyLabelsException object: The limit has been reached on the number of labels for the specified resource.
  • Message ErrorMessageType

TooManySubscriptionsException

• TooManySubscriptionsException object: You've reached the limit on the number of subscriptions for the WorkDocs instance.
  • Message ErrorMessageType

UnauthorizedOperationException

• UnauthorizedOperationException object: The operation is not permitted.

UnauthorizedResourceAccessException

• UnauthorizedResourceAccessException object: The caller does not have access to perform the action on the resource.
  • Message ErrorMessageType

UpdateDocumentRequest

• UpdateDocumentRequest object
  • Name ResourceNameType
  • ParentFolderId ResourceIdType
  • ResourceState ResourceStateType

UpdateDocumentVersionRequest

• UpdateDocumentVersionRequest object
  • VersionStatus DocumentVersionStatus

UpdateFolderRequest

• UpdateFolderRequest object
  • Name ResourceNameType
  • ParentFolderId ResourceIdType
  • ResourceState ResourceStateType

UpdateUserRequest

• UpdateUserRequest object
  • GivenName UserAttributeValueType
  • GrantPoweruserPrivileges BooleanEnumType
  • Locale LocaleType
  • StorageRule StorageRuleType
  • Surname UserAttributeValueType
  • TimeZoneId TimeZoneIdType
  • Type UserType

UpdateUserResponse

• UpdateUserResponse object
  • User User

UploadMetadata

• UploadMetadata object: Describes the upload.
  • SignedHeaders SignedHeaderMap
  • UploadUrl UrlType

UrlType

• UrlType string

User

• User object: Describes a user.
  • CreatedTimestamp TimestampType
  • EmailAddress EmailAddressType
  • GivenName UserAttributeValueType
  • Id IdType
  • Locale LocaleType
  • ModifiedTimestamp TimestampType
  • OrganizationId IdType
  • RecycleBinFolderId ResourceIdType
  • RootFolderId ResourceIdType
  • Status UserStatusType
  • Storage UserStorageMetadata
  • Surname UserAttributeValueType
  • TimeZoneId TimeZoneIdType
  • Type UserType
  • Username UsernameType

UserActivities

• UserActivities array
  • items Activity

UserAttributeValueType

• UserAttributeValueType string

UserFilterType

• UserFilterType string (values: ALL, ACTIVE_PENDING)

UserIdsType

• UserIdsType string

UserMetadata

• UserMetadata object: Describes the metadata of the user.
  • EmailAddress EmailAddressType
  • GivenName UserAttributeValueType
  • Id IdType
  • Surname UserAttributeValueType
  • Username UsernameType

UserMetadataList

• UserMetadataList array
  • items UserMetadata

UserSortType

• UserSortType string (values: USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED)

UserStatusType

• UserStatusType string (values: ACTIVE, INACTIVE, PENDING)

UserStorageMetadata

• UserStorageMetadata object: Describes the storage for a user.
  • StorageRule StorageRuleType
  • StorageUtilizedInBytes SizeType

UserType

• UserType string (values: USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER)

UsernameType

• UsernameType string