Api references

CHEAT SHEET (126 operations)

• AdSync
  • POST Ad2PortalSyncFinalizer(SnTaskResult result) : void
• Authentication
  • POST CreateApiKey() : ApiKey
  • POST CreateClient(string name, string type, string userName) : Client
  • POST CreateSecret(string clientId, DateTime? validTill) : ClientSecret
  • POST DeleteApiKey(string apiKey) : void
  • POST DeleteApiKeys() : void
  • POST DeleteApiKeys() : void
  • POST DeleteClient(string clientId) : void
  • POST DeleteSecret(string clientId, string secretId) : void
  • GET GetApiKeys() : object
  • GET GetClientRequestParameters(string clientType) : object
  • GET GetClients() : object
  • GET GetClientsForRepository() : object
  • POST RegenerateSecretForRepository(string clientId, string secretId, DateTime? validTill) : ClientSecret
  • POST ValidateCredentials(string userName, string password) : CredentialValidationResult
• Binary
  • POST FinalizeBlobUpload(string token, long fullSize, string fieldName, string fileName) : string
  • POST FinalizeContent() : string
  • GET GetBinaryToken(string fieldName) : string
  • POST StartBlobUpload(long fullSize, string fieldName) : string
  • POST StartBlobUploadToParent(string name, string contentType, long fullSize, string fieldName) : string
  • POST Upload(long? FileLength, string ContentType, string PropertyName, string FileText, bool? Overwrite, int? ContentId, string FileName, string ChunkToken, bool? UseChunk, string create) : object
• Collaboration
  • POST Approve() : Content
  • POST CheckIn(string checkInComments) : Content
  • POST CheckOut() : Content
  • POST ForceUndoCheckOut() : Content
  • POST Publish() : Content
  • POST Reject(string rejectReason) : Content
  • POST RestoreVersion(string version) : Content
  • POST UndoCheckOut() : Content
• Content and Schema
  • GET GetMetadata() : string
  • GET GetNameFromDisplayName(string displayName) : string
  • GET GetOpenApiDocument() : string
  • GET GetSchema(string contentTypeName) : object
• Content Management
  • POST CopyBatch(string targetPath, object[] paths) : BatchActionResponse
  • POST Delete(bool permanent) : object
  • POST DeleteBatch(bool permanent, object[] paths) : BatchActionResponse
  • GET Import(string path, object data) : object
  • POST MoveBatch(string targetPath, object[] paths) : BatchActionResponse
  • GET OpenTree(string rootPath, bool withLeaves, bool withSystem) : object
  • POST Restore(string destination, bool? newname) : void
• Content Types
  • POST AddAllowedChildTypes(string[] contentTypes) : string
  • GET CheckAllowedChildTypesOfFolders() : Dictionary<string, List<string>>
  • GET GetAllContentTypes() : Content[]
  • GET GetAllowedChildTypesFromCTD() : Content[]
  • POST RemoveAllowedChildTypes(string[] contentTypes) : string
• Deprecated
  • GET CheckIndexIntegrity(bool recurse) : object
• Indexing
  • POST BackupIndex(string target) : BackupResponse
  • POST CancelIndexBackup() : BackupResponse
  • GET GetIndexDocument(int versionId) : IDictionary<string, object>
  • GET GetIndexDocumentByDocumentId(int documentId) : IDictionary<string, object>
  • GET GetIndexProperties() : IndexProperties
  • GET GetInvertedIndex(string fieldName) : IDictionary<string, object
  • GET GetRecentIndexingActivities() : IndexingActivityHistory
  • GET GetWholeInvertedIndex() : void
  • GET QueryIndexBackup() : BackupResponse
  • POST RebuildIndex(bool recursive, IndexRebuildLevel rebuildLevel) : void
  • POST RebuildIndexSubtree() : void
  • POST RefreshIndexAndCleanActivities() : void
  • POST RefreshIndexSubtree() : void
  • POST ResetRecentIndexingActivities() : IndexingActivityHistory
• Office Online Editing
  • GET GetWopiData(string action) : object
  • GET WopiOpenEdit() : object
  • GET WopiOpenView() : object
• Other
  • GET GetDashboardData() : object
  • GET GetRepositoryType() : object
  • GET GetVersionInfo() : RepositoryVersionView
• Permissions
  • GET GetAcl() : object
  • GET GetAllowedUsers(string[] permissions) : Content[]
  • GET GetChildrenPermissionInfo(string identity) : GetChildrenPermissionInfoResponse
  • GET GetPermissionInfo(string identity) : GetSinglePermissionInfoResponse
  • GET GetPermissionOverview(string identity) : object
  • GET GetPermissions(string identity) : object
  • GET GetRelatedIdentities(string permissionLevel, string identityKind) : Content[]
  • GET GetRelatedIdentitiesByPermissions(string permissionLevel, string identityKind, string[] permissions) : Content[]
  • GET GetRelatedItems(string permissionLevel, bool explicitOnly, string memberPath, string[] permissions) : Content[]
  • GET GetRelatedItemsOneLevel(string permissionLevel, string memberPath, string[] permissions) : Content[]
  • GET GetRelatedPermissions(string permissionLevel, bool explicitOnly, string memberPath, string[] includedTypes) : IDictionary<PermissionType, int>
  • GET HasPermission(string[] permissions, string user) : bool
  • POST SetPermissions(string inheritance) : Content
  • POST SetPermissions(SetPermissionsRequest r) : Content
  • POST TakeLockOver(string user) : string
  • POST TakeOwnership(string userOrGroup) : void
• Preview
  • POST CheckPreviews(bool generateMissing) : CheckPreviewsResponse
  • POST DocumentPreviewFinalizer(SnTaskResult result) : Task
  • GET GetExistingPreviewImages() : GetExistingPreviewImagesResponse[]
  • POST GetPageCount() : int
  • GET GetPreviewImages() : Content[]
  • POST GetPreviewsFolder(bool empty) : GetPreviewsFolderResponse
  • GET PreviewAvailable(int page) : PreviewAvailableResponse
  • POST RegeneratePreviews() : RegeneratePreviewsResponse
  • POST SetInitialPreviewProperties() : void
  • POST SetPageCount(int pageCount) : void
  • POST SetPreviewStatus(PreviewStatus status) : void
• Queries
  • GET GetQueries(bool onlyPublic) : Content[]
  • POST SaveQuery(string query, string displayName, string queryType, string uiFilters) : object
• Security
  • GET CheckSecurityConsistency() : SecurityConsistencyResult
  • POST CopyExplicitEntriesOfEveryoneToVisitor(string[] exceptList) : string
  • POST Decrypt(string text) : string
  • POST Encrypt(string text) : string
  • GET GetRecentSecurityActivities() : SenseNet.Security.Messaging.SecurityActivityHistory
  • GET MissingExplicitEntriesOfVisitorComparedToEveryone() : string[]
  • GET ProtectedPaths() : string[]
• Sharing
  • GET GetSharing() : object
  • POST RemoveSharing(string id) : object
  • POST Share(string token, SharingLevel level, SharingMode mode, bool sendNotification) : object
• Tools
  • GET Ancestors() : Content[]
  • GET GeDatabaseUsagePeriod(TimeWindow? timeWindow, DateTime? time) : object
  • GET GetApiUsageList(DateTime? maxTime, int count) : ApiUsageListItemViewModel[]
  • GET GetApiUsagePeriod(TimeWindow? timeWindow, DateTime? time) : object
  • GET GetApiUsagePeriods(TimeWindow? timeWindow) : object
  • GET GetContentCountInTree() : int
  • GET GetDatabaseUsage(bool force) : DatabaseUsage
• Users and Groups
  • POST AddMembers(int[] contentIds) : object
  • POST ChangePassword(string password) : void
  • POST CreateLocalUser(string loginName, string password, string email) : Content
  • POST CreateUserByProvider(string provider, string userId, string claims) : Content
  • GET GetParentGroups(bool directOnly) : Content[]
  • POST RemoveMembers(int[] contentIds) : object
  • POST SendChangePasswordMail(string email, string returnUrl) : Task
  • POST SendChangePasswordMail(string returnUrl) : Task
• WebHooks
  • POST FireWebHook(string path, WebHookEventType eventType) : Content
  • POST FireWebHook(int nodeId, WebHookEventType eventType) : Content
  • GET GetWebHookUsageList(DateTime? maxTime, int count) : WebHookUsageListItemViewModel[]
  • GET GetWebHookUsageList(DateTime? maxTime, int count) : WebHookUsageListItemViewModel[]
  • GET GetWebHookUsagePeriod(TimeWindow? timeWindow, DateTime? time) : object
  • GET GetWebHookUsagePeriods(TimeWindow? timeWindow) : object