@Produces(value={"application/json","application/xml"})
@Consumes(value={"application/json","application/xml"})
@Path(value="/contentrepositories")
public interface ContentRepositoryResource
Modifier and Type | Method and Description |
---|---|
ContentRepositoryResponse |
add(ContentRepositoryModel item)
Create a new ContentRepository
|
javax.ws.rs.core.Response |
addCrFragment(String id,
String crFragmentId)
Assign a ContentRepository Fragment to the ContentRepository
|
TagmapEntryResponse |
addEntry(String id,
TagmapEntryModel item)
Create a new tagmap entry
|
ContentRepositoryResponse |
check(String id)
Check the connectivity and structure of the given contentrepository
|
ContentRepositoryResponse |
checkData(String id)
Check the data in the given contentrepository
|
TagmapEntryConsistencyResponse |
checkEntryConsistency(String id)
Check consistency of tagmap entries and return inconsistencies
|
ContentRepositoryResponse |
copy(String id)
Copy a ContentRepotiroy
|
javax.ws.rs.core.Response |
delete(String id)
Delete the ContentRepository with given id
|
javax.ws.rs.core.Response |
deleteEntry(String id,
String entryId)
Delete the tagmap entry
|
ContentRepositoryResponse |
get(String id)
Get the ContentRepository with given id
|
ContentRepositoryFragmentResponse |
getCrFragment(String id,
String crFragmentId)
Get a ContentRepository Fragment assigned to the ContentRepository
|
TagmapEntryResponse |
getEntry(String id,
String entryId)
Get a tagmap entry
|
ContentRepositoryListResponse |
list(FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
List available ContentRepositories
|
ContentRepositoryFragmentListResponse |
listCrFragments(String id,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
Get the ContnetRepository Fragments assigned to the ContentRepository
|
TagmapEntryListResponse |
listEntries(String id,
boolean fragments,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
Get the entries in the ContentRepository
|
javax.ws.rs.core.Response |
removeCrFragment(String id,
String crFragmentId)
Remove the ContentRepository Fragment from the ContentRepository
|
ContentRepositoryResponse |
repair(String id)
Check and repair the connectivity and structure of the given contentrepository
|
ContentRepositoryResponse |
repairData(String id)
Check and repair the data in the given contentrepository
|
ContentRepositoryResponse |
update(String id,
ContentRepositoryModel item)
Update ContentRepository with given id
|
TagmapEntryResponse |
updateEntry(String id,
String entryId,
TagmapEntryModel item)
Update tagmap entry
|
@GET ContentRepositoryListResponse list(@BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
filter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@POST ContentRepositoryResponse add(ContentRepositoryModel item) throws Exception
item
- ContentRepository to createException
@GET @Path(value="/{id}") ContentRepositoryResponse get(@PathParam(value="id") String id) throws Exception
id
- internal or external ContentRepository IDException
@PUT @Path(value="/{id}") ContentRepositoryResponse update(@PathParam(value="id") String id, ContentRepositoryModel item) throws Exception
id
- internal or external ContentRepository IDitem
- updated ContentRepositoryException
@DELETE @Path(value="/{id}") javax.ws.rs.core.Response delete(@PathParam(value="id") String id) throws Exception
id
- internal or external ContentRepository IDException
@PUT @Path(value="/{id}/structure/check") ContentRepositoryResponse check(@PathParam(value="id") String id) throws Exception
id
- internal or external ContentRepository IDException
@PUT @Path(value="/{id}/structure/repair") ContentRepositoryResponse repair(@PathParam(value="id") String id) throws Exception
id
- internal or external ContentRepository IDException
@PUT @Path(value="/{id}/data/check") ContentRepositoryResponse checkData(@PathParam(value="id") String id) throws Exception
id
- internal or external ContentRepository IDException
@PUT @Path(value="/{id}/data/repair") ContentRepositoryResponse repairData(@PathParam(value="id") String id) throws Exception
id
- internal or external ContentRepository IDException
@PUT @Path(value="/{id}/copy") ContentRepositoryResponse copy(@PathParam(value="id") String id) throws Exception
id
- internal or external ID of the ContentRepository to copyException
@GET @Path(value="/{id}/entries") TagmapEntryListResponse listEntries(@PathParam(value="id") String id, @QueryParam(value="fragments") @DefaultValue(value="false") boolean fragments, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
id
- internal or external IDfragments
- true to include entries from assigned fragments, false (which is the default) to only list entries of the ContentRepository itselffilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@GET @Path(value="/{id}/entries/check") TagmapEntryConsistencyResponse checkEntryConsistency(@PathParam(value="id") String id) throws Exception
id
- internal or external IDException
@POST @Path(value="/{id}/entries") TagmapEntryResponse addEntry(@PathParam(value="id") String id, TagmapEntryModel item) throws Exception
id
- internal or external ID of the ContentRepositoryitem
- entry to createException
@GET @Path(value="/{id}/entries/{entryId}") TagmapEntryResponse getEntry(@PathParam(value="id") String id, @PathParam(value="entryId") String entryId) throws Exception
id
- internal or external ID of the ContentRepositoryentryId
- internal or external ID of the entryException
@PUT @Path(value="/{id}/entries/{entryId}") TagmapEntryResponse updateEntry(@PathParam(value="id") String id, @PathParam(value="entryId") String entryId, TagmapEntryModel item) throws Exception
id
- internal or external ContentRepository IDentryId
- internal or external entry IDitem
- updated entryException
@DELETE @Path(value="/{id}/entries/{entryId}") javax.ws.rs.core.Response deleteEntry(@PathParam(value="id") String id, @PathParam(value="entryId") String entryId) throws Exception
id
- internal or external ContentRepository IDentryId
- internal or external entry IDException
@GET @Path(value="/{id}/cr_fragments") ContentRepositoryFragmentListResponse listCrFragments(@PathParam(value="id") String id, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
id
- internal or external IDfilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@GET @Path(value="/{id}/cr_fragments/{crFragmentId}") ContentRepositoryFragmentResponse getCrFragment(@PathParam(value="id") String id, @PathParam(value="crFragmentId") String crFragmentId) throws Exception
id
- internal or external ID of the ContentRepositorycrFragmentId
- internal or external ID of the ContentRepository FragmentException
@PUT @Path(value="/{id}/cr_fragments/{crFragmentId}") javax.ws.rs.core.Response addCrFragment(@PathParam(value="id") String id, @PathParam(value="crFragmentId") String crFragmentId) throws Exception
id
- internal or external ContentRepository IDcrFragmentId
- internal or external ContentRepository Fragment IDException
@DELETE @Path(value="/{id}/cr_fragments/{crFragmentId}") javax.ws.rs.core.Response removeCrFragment(@PathParam(value="id") String id, @PathParam(value="crFragmentId") String crFragmentId) throws Exception
id
- internal or external ContentRepository IDcrFragmentId
- internal or external ContentRepository Fragment IDException
Copyright © 2019 Gentics Software. All rights reserved.