@Path(value="/linkChecker")
public interface LinkCheckerResource
Modifier and Type | Method and Description |
---|---|
CheckResponse |
checkLink(CheckExternalLinkRequest request)
Check an external link for validity
|
ExternalLinkList |
getLinks(String pageId)
Get the external links contained in a single page
|
PageList |
getPages(FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging,
LinkCheckerFilterParameterBean linkFilter)
Get list of pages containing external links
|
ExternalLinkStatistics |
getStats(Integer nodeId)
Get link checker statistics
|
GenericResponse |
updateLinkStatus(String pageId,
UpdateExternalLinkStatusRequest request)
Update the validity status for external links contained in the page.
|
@GET @Path(value="/stats") ExternalLinkStatistics getStats(@QueryParam(value="nodeId") Integer nodeId) throws Exception
nodeId
- optional node ID for getting node specific statisticsException
@GET @Path(value="/pages") PageList getPages(@BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging, @BeanParam LinkCheckerFilterParameterBean linkFilter) throws Exception
filter
- general filter parameterssorting
- sorting parameterspaging
- paging parameterslinkFilter
- link filter parametersException
@GET @Path(value="/pages/{id}") ExternalLinkList getLinks(@PathParam(value="id") String pageId) throws Exception
pageId
- page IDException
@POST @Path(value="/pages/{id}") GenericResponse updateLinkStatus(@PathParam(value="id") String pageId, UpdateExternalLinkStatusRequest request) throws Exception
pageId
- page IDrequest
- request containing external links with updated statusException
@POST @Path(value="/check") CheckResponse checkLink(CheckExternalLinkRequest request) throws Exception
request
- request containing the link to checkException
Copyright © 2019 Gentics Software. All rights reserved.