Interface ContentRepositoryFragmentResource
-
@Produces("application/json") @Consumes("application/json") @Path("/cr_fragments") public interface ContentRepositoryFragmentResource
Resource for handling ContentRepository Fragments
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ContentRepositoryFragmentResponse
add(ContentRepositoryFragmentModel item)
Create a new ContentRepository FragmentContentRepositoryFragmentEntryResponse
addEntry(String id, ContentRepositoryFragmentEntryModel item)
Create a new ContentRepository Fragment Entryjavax.ws.rs.core.Response
delete(String id)
Delete the ContentRepository Fragment with given idjavax.ws.rs.core.Response
deleteEntry(String id, String entryId)
Delete the Fragment entryContentRepositoryFragmentResponse
get(String id)
Get the ContentRepository Fragment with given idContentRepositoryFragmentEntryResponse
getEntry(String id, String entryId)
Get a Fragment EntryContentRepositoryFragmentListResponse
list(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms)
List available ContentRepository Fragments.
The result can be filtered byid
globalId
name
and sorted byid
globalId
name
ContentRepositoryFragmentEntryListResponse
listEntries(String id, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging)
Get the entries in the ContentRepository Fragment.
The result can be filtered byid
globalId
tagname
mapname
foreignlinkAttribute
foreignlinkAttributeRule
category
and sorted byid
globalId
tagname
mapname
objType
attributeType
targetType
multivalue
optimized
filesystem
foreignlinkAttribute
foreignlinkAttributeRule
category
segmentfield
displayfield
urlfield
ContentRepositoryFragmentResponse
update(String id, ContentRepositoryFragmentModel item)
Update ContentRepository Fragment with given idContentRepositoryFragmentEntryResponse
updateEntry(String id, String entryId, ContentRepositoryFragmentEntryModel item)
Update Fragment entry
-
-
-
Method Detail
-
list
@GET ContentRepositoryFragmentListResponse list(@BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging, @BeanParam PermsParameterBean perms) throws Exception
List available ContentRepository Fragments.
The result can be filtered byid
globalId
name
id
globalId
name
- Parameters:
filter
- filter parameterssorting
- sorting parameterspaging
- paging parametersperms
- permissions parameters- Returns:
- List of ContentRepository Fragments
- Throws:
Exception
-
add
@POST ContentRepositoryFragmentResponse add(ContentRepositoryFragmentModel item) throws Exception
Create a new ContentRepository Fragment- Parameters:
item
- ContentRepository Fragment to create- Returns:
- created ContentRepository Fragment
- Throws:
Exception
-
get
@GET @Path("/{id}") ContentRepositoryFragmentResponse get(@PathParam("id") String id) throws Exception
Get the ContentRepository Fragment with given id- Parameters:
id
- internal or external ContentRepository ID- Returns:
- Response containing the ContentRepository
- Throws:
Exception
-
update
@PUT @Path("/{id}") ContentRepositoryFragmentResponse update(@PathParam("id") String id, ContentRepositoryFragmentModel item) throws Exception
Update ContentRepository Fragment with given id- Parameters:
id
- internal or external ContentRepository Fragment IDitem
- updated ContentRepository Fragment- Returns:
- updated ContentRepository Fragment
- Throws:
Exception
-
delete
@DELETE @Path("/{id}") javax.ws.rs.core.Response delete(@PathParam("id") String id) throws Exception
Delete the ContentRepository Fragment with given id- Parameters:
id
- internal or external ContentRepository Fragment ID- Returns:
- response
- Throws:
Exception
-
listEntries
@GET @Path("/{id}/entries") ContentRepositoryFragmentEntryListResponse listEntries(@PathParam("id") String id, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
Get the entries in the ContentRepository Fragment.
The result can be filtered byid
globalId
tagname
mapname
foreignlinkAttribute
foreignlinkAttributeRule
category
id
globalId
tagname
mapname
objType
attributeType
targetType
multivalue
optimized
filesystem
foreignlinkAttribute
foreignlinkAttributeRule
category
segmentfield
displayfield
urlfield
- Parameters:
id
- internal or external IDfilter
- filter parameterssorting
- sorting parameterspaging
- paging parameters- Returns:
- list of entries
- Throws:
Exception
-
addEntry
@POST @Path("/{id}/entries") ContentRepositoryFragmentEntryResponse addEntry(@PathParam("id") String id, ContentRepositoryFragmentEntryModel item) throws Exception
Create a new ContentRepository Fragment Entry- Parameters:
id
- internal or external ID of the ContentRepository Fragmentitem
- entry to create- Returns:
- created entry
- Throws:
Exception
-
getEntry
@GET @Path("/{id}/entries/{entryId}") ContentRepositoryFragmentEntryResponse getEntry(@PathParam("id") String id, @PathParam("entryId") String entryId) throws Exception
Get a Fragment Entry- Parameters:
id
- internal or external ID of the ContentRepository FragmententryId
- internal or external ID of the entry- Returns:
- response containing the entry
- Throws:
Exception
-
updateEntry
@PUT @Path("/{id}/entries/{entryId}") ContentRepositoryFragmentEntryResponse updateEntry(@PathParam("id") String id, @PathParam("entryId") String entryId, ContentRepositoryFragmentEntryModel item) throws Exception
Update Fragment entry- Parameters:
id
- internal or external ContentRepository Fragment IDentryId
- internal or external entry IDitem
- updated entry- Returns:
- updated entry
- Throws:
Exception
-
deleteEntry
@DELETE @Path("/{id}/entries/{entryId}") javax.ws.rs.core.Response deleteEntry(@PathParam("id") String id, @PathParam("entryId") String entryId) throws Exception
Delete the Fragment entry- Parameters:
id
- internal or external ContentRepository Fragment IDentryId
- internal or external entry ID- Returns:
- response
- Throws:
Exception
-
-