Interface DocumentResource
@CTAware
@Generated("")
@ProviderType
public interface DocumentResource
To access this resource, run:
curl -u your@email.com:yourpassword -D - http://localhost:8080/o/headless-delivery/v1.0
- Generated:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfacestatic interface -
Method Summary
Modifier and TypeMethodDescriptionvoiddeleteAssetLibraryDocumentByExternalReferenceCode(Long assetLibraryId, String externalReferenceCode) voiddeleteDocument(Long documentId) javax.ws.rs.core.ResponsedeleteDocumentBatch(String callbackURL, Object object) voiddeleteDocumentMyRating(Long documentId) voiddeleteSiteDocumentByExternalReferenceCode(Long siteId, String externalReferenceCode) getAssetLibraryDocumentByExternalReferenceCode(Long assetLibraryId, String externalReferenceCode) com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>getAssetLibraryDocumentPermissionsPage(Long assetLibraryId, String roleNames) com.liferay.portal.vulcan.pagination.Page<Document>getAssetLibraryDocumentsPage(Long assetLibraryId, Boolean flatten, String search, com.liferay.portal.vulcan.aggregation.Aggregation aggregation, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts) com.liferay.portal.vulcan.pagination.Page<Document>getAssetLibraryDocumentsRatedByMePage(Long assetLibraryId, com.liferay.portal.vulcan.pagination.Pagination pagination) getDocument(Long documentId) com.liferay.portal.vulcan.pagination.Page<Document>getDocumentFolderDocumentsPage(Long documentFolderId, Boolean flatten, String search, com.liferay.portal.vulcan.aggregation.Aggregation aggregation, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts) getDocumentMyRating(Long documentId) com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>getDocumentPermissionsPage(Long documentId, String roleNames) getDocumentRenderedContentByDisplayPageDisplayPageKey(Long documentId, String displayPageKey) getSiteDocumentByExternalReferenceCode(Long siteId, String externalReferenceCode) com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>getSiteDocumentPermissionsPage(Long siteId, String roleNames) com.liferay.portal.vulcan.pagination.Page<Document>getSiteDocumentsPage(Long siteId, Boolean flatten, String search, com.liferay.portal.vulcan.aggregation.Aggregation aggregation, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts) com.liferay.portal.vulcan.pagination.Page<Document>getSiteDocumentsRatedByMePage(Long siteId, com.liferay.portal.vulcan.pagination.Pagination pagination) patchDocument(Long documentId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) postAssetLibraryDocument(Long assetLibraryId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) javax.ws.rs.core.ResponsepostAssetLibraryDocumentBatch(Long assetLibraryId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) javax.ws.rs.core.ResponsepostAssetLibraryDocumentsPageExportBatch(Long assetLibraryId, String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.kernel.search.Sort[] sorts, String callbackURL, String contentType, String fieldNames) postDocumentFolderDocument(Long documentFolderId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) javax.ws.rs.core.ResponsepostDocumentFolderDocumentBatch(Long documentFolderId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) javax.ws.rs.core.ResponsepostDocumentFolderDocumentsPageExportBatch(Long documentFolderId, String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.kernel.search.Sort[] sorts, String callbackURL, String contentType, String fieldNames) postDocumentMyRating(Long documentId, Rating rating) postSiteDocument(Long siteId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) javax.ws.rs.core.ResponsepostSiteDocumentBatch(Long siteId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) javax.ws.rs.core.ResponsepostSiteDocumentsPageExportBatch(Long siteId, String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.kernel.search.Sort[] sorts, String callbackURL, String contentType, String fieldNames) putAssetLibraryDocumentByExternalReferenceCode(Long assetLibraryId, String externalReferenceCode, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>putAssetLibraryDocumentPermissionsPage(Long assetLibraryId, com.liferay.portal.vulcan.permission.Permission[] permissions) putDocument(Long documentId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) javax.ws.rs.core.ResponseputDocumentBatch(com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) putDocumentMyRating(Long documentId, Rating rating) com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>putDocumentPermissionsPage(Long documentId, com.liferay.portal.vulcan.permission.Permission[] permissions) putSiteDocumentByExternalReferenceCode(Long siteId, String externalReferenceCode, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>putSiteDocumentPermissionsPage(Long siteId, com.liferay.portal.vulcan.permission.Permission[] permissions) default voidsetContextAcceptLanguage(com.liferay.portal.vulcan.accept.language.AcceptLanguage contextAcceptLanguage) voidsetContextCompany(com.liferay.portal.kernel.model.Company contextCompany) default voidsetContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest) default voidsetContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse) default voidsetContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo) voidsetContextUser(com.liferay.portal.kernel.model.User contextUser) voidsetExpressionConvert(com.liferay.portal.odata.filter.ExpressionConvert<com.liferay.portal.kernel.search.filter.Filter> expressionConvert) voidsetFilterParserProvider(com.liferay.portal.odata.filter.FilterParserProvider filterParserProvider) voidsetGroupLocalService(com.liferay.portal.kernel.service.GroupLocalService groupLocalService) voidsetResourceActionLocalService(com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService) voidsetResourcePermissionLocalService(com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService) voidsetRoleLocalService(com.liferay.portal.kernel.service.RoleLocalService roleLocalService) voidsetSortParserProvider(com.liferay.portal.odata.sort.SortParserProvider sortParserProvider) voidsetVulcanBatchEngineExportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineExportTaskResource vulcanBatchEngineExportTaskResource) voidsetVulcanBatchEngineImportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineImportTaskResource vulcanBatchEngineImportTaskResource) default com.liferay.portal.kernel.search.filter.Filterdefault com.liferay.portal.kernel.search.filter.Filterdefault com.liferay.portal.kernel.search.Sort[]
-
Method Details
-
getAssetLibraryDocumentsPage
com.liferay.portal.vulcan.pagination.Page<Document> getAssetLibraryDocumentsPage(Long assetLibraryId, Boolean flatten, String search, com.liferay.portal.vulcan.aggregation.Aggregation aggregation, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts) throws Exception - Throws:
Exception
-
postAssetLibraryDocumentsPageExportBatch
javax.ws.rs.core.Response postAssetLibraryDocumentsPageExportBatch(Long assetLibraryId, String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.kernel.search.Sort[] sorts, String callbackURL, String contentType, String fieldNames) throws Exception - Throws:
Exception
-
postAssetLibraryDocument
Document postAssetLibraryDocument(Long assetLibraryId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) throws Exception - Throws:
Exception
-
postAssetLibraryDocumentBatch
javax.ws.rs.core.Response postAssetLibraryDocumentBatch(Long assetLibraryId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) throws Exception - Throws:
Exception
-
deleteAssetLibraryDocumentByExternalReferenceCode
void deleteAssetLibraryDocumentByExternalReferenceCode(Long assetLibraryId, String externalReferenceCode) throws Exception - Throws:
Exception
-
getAssetLibraryDocumentByExternalReferenceCode
Document getAssetLibraryDocumentByExternalReferenceCode(Long assetLibraryId, String externalReferenceCode) throws Exception - Throws:
Exception
-
putAssetLibraryDocumentByExternalReferenceCode
Document putAssetLibraryDocumentByExternalReferenceCode(Long assetLibraryId, String externalReferenceCode, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) throws Exception - Throws:
Exception
-
getAssetLibraryDocumentPermissionsPage
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> getAssetLibraryDocumentPermissionsPage(Long assetLibraryId, String roleNames) throws Exception - Throws:
Exception
-
putAssetLibraryDocumentPermissionsPage
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> putAssetLibraryDocumentPermissionsPage(Long assetLibraryId, com.liferay.portal.vulcan.permission.Permission[] permissions) throws Exception - Throws:
Exception
-
getAssetLibraryDocumentsRatedByMePage
com.liferay.portal.vulcan.pagination.Page<Document> getAssetLibraryDocumentsRatedByMePage(Long assetLibraryId, com.liferay.portal.vulcan.pagination.Pagination pagination) throws Exception - Throws:
Exception
-
getDocumentFolderDocumentsPage
com.liferay.portal.vulcan.pagination.Page<Document> getDocumentFolderDocumentsPage(Long documentFolderId, Boolean flatten, String search, com.liferay.portal.vulcan.aggregation.Aggregation aggregation, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts) throws Exception - Throws:
Exception
-
postDocumentFolderDocumentsPageExportBatch
javax.ws.rs.core.Response postDocumentFolderDocumentsPageExportBatch(Long documentFolderId, String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.kernel.search.Sort[] sorts, String callbackURL, String contentType, String fieldNames) throws Exception - Throws:
Exception
-
postDocumentFolderDocument
Document postDocumentFolderDocument(Long documentFolderId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) throws Exception - Throws:
Exception
-
postDocumentFolderDocumentBatch
javax.ws.rs.core.Response postDocumentFolderDocumentBatch(Long documentFolderId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) throws Exception - Throws:
Exception
-
deleteDocument
- Throws:
Exception
-
deleteDocumentBatch
- Throws:
Exception
-
getDocument
- Throws:
Exception
-
patchDocument
Document patchDocument(Long documentId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) throws Exception - Throws:
Exception
-
putDocument
Document putDocument(Long documentId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) throws Exception - Throws:
Exception
-
putDocumentBatch
javax.ws.rs.core.Response putDocumentBatch(com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) throws Exception - Throws:
Exception
-
deleteDocumentMyRating
- Throws:
Exception
-
getDocumentMyRating
- Throws:
Exception
-
postDocumentMyRating
- Throws:
Exception
-
putDocumentMyRating
- Throws:
Exception
-
getDocumentPermissionsPage
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> getDocumentPermissionsPage(Long documentId, String roleNames) throws Exception - Throws:
Exception
-
putDocumentPermissionsPage
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> putDocumentPermissionsPage(Long documentId, com.liferay.portal.vulcan.permission.Permission[] permissions) throws Exception - Throws:
Exception
-
getDocumentRenderedContentByDisplayPageDisplayPageKey
String getDocumentRenderedContentByDisplayPageDisplayPageKey(Long documentId, String displayPageKey) throws Exception - Throws:
Exception
-
getSiteDocumentsPage
com.liferay.portal.vulcan.pagination.Page<Document> getSiteDocumentsPage(Long siteId, Boolean flatten, String search, com.liferay.portal.vulcan.aggregation.Aggregation aggregation, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts) throws Exception - Throws:
Exception
-
postSiteDocumentsPageExportBatch
javax.ws.rs.core.Response postSiteDocumentsPageExportBatch(Long siteId, String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.kernel.search.Sort[] sorts, String callbackURL, String contentType, String fieldNames) throws Exception - Throws:
Exception
-
postSiteDocument
Document postSiteDocument(Long siteId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) throws Exception - Throws:
Exception
-
postSiteDocumentBatch
javax.ws.rs.core.Response postSiteDocumentBatch(Long siteId, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody, String callbackURL, Object object) throws Exception - Throws:
Exception
-
deleteSiteDocumentByExternalReferenceCode
void deleteSiteDocumentByExternalReferenceCode(Long siteId, String externalReferenceCode) throws Exception - Throws:
Exception
-
getSiteDocumentByExternalReferenceCode
Document getSiteDocumentByExternalReferenceCode(Long siteId, String externalReferenceCode) throws Exception - Throws:
Exception
-
putSiteDocumentByExternalReferenceCode
Document putSiteDocumentByExternalReferenceCode(Long siteId, String externalReferenceCode, com.liferay.portal.vulcan.multipart.MultipartBody multipartBody) throws Exception - Throws:
Exception
-
getSiteDocumentPermissionsPage
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> getSiteDocumentPermissionsPage(Long siteId, String roleNames) throws Exception - Throws:
Exception
-
putSiteDocumentPermissionsPage
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> putSiteDocumentPermissionsPage(Long siteId, com.liferay.portal.vulcan.permission.Permission[] permissions) throws Exception - Throws:
Exception
-
getSiteDocumentsRatedByMePage
com.liferay.portal.vulcan.pagination.Page<Document> getSiteDocumentsRatedByMePage(Long siteId, com.liferay.portal.vulcan.pagination.Pagination pagination) throws Exception - Throws:
Exception
-
setContextAcceptLanguage
default void setContextAcceptLanguage(com.liferay.portal.vulcan.accept.language.AcceptLanguage contextAcceptLanguage) -
setContextCompany
void setContextCompany(com.liferay.portal.kernel.model.Company contextCompany) -
setContextHttpServletRequest
default void setContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest) -
setContextHttpServletResponse
default void setContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse) -
setContextUriInfo
default void setContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo) -
setContextUser
void setContextUser(com.liferay.portal.kernel.model.User contextUser) -
setExpressionConvert
void setExpressionConvert(com.liferay.portal.odata.filter.ExpressionConvert<com.liferay.portal.kernel.search.filter.Filter> expressionConvert) -
setFilterParserProvider
void setFilterParserProvider(com.liferay.portal.odata.filter.FilterParserProvider filterParserProvider) -
setGroupLocalService
void setGroupLocalService(com.liferay.portal.kernel.service.GroupLocalService groupLocalService) -
setResourceActionLocalService
void setResourceActionLocalService(com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService) -
setResourcePermissionLocalService
void setResourcePermissionLocalService(com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService) -
setRoleLocalService
void setRoleLocalService(com.liferay.portal.kernel.service.RoleLocalService roleLocalService) -
setSortParserProvider
void setSortParserProvider(com.liferay.portal.odata.sort.SortParserProvider sortParserProvider) -
setVulcanBatchEngineExportTaskResource
void setVulcanBatchEngineExportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineExportTaskResource vulcanBatchEngineExportTaskResource) -
setVulcanBatchEngineImportTaskResource
void setVulcanBatchEngineImportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineImportTaskResource vulcanBatchEngineImportTaskResource) -
toFilter
-
toFilter
-
toSorts
-