com.gentics.contentnode.rest.resource

Interface ContentRepositoryFragmentResource

@Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
 @Path(value="/cr_fragments")
public interface ContentRepositoryFragmentResource

Resource for handling ContentRepository Fragments

Method Summary

Modifier and Type	Method and Description
ContentRepositoryFragmentResponse	add(ContentRepositoryFragmentModel item) Create a new ContentRepository Fragment
ContentRepositoryFragmentEntryResponse	addEntry(String id, ContentRepositoryFragmentEntryModel item) Create a new ContentRepository Fragment Entry
javax.ws.rs.core.Response	delete(String id) Delete the ContentRepository Fragment with given id
javax.ws.rs.core.Response	deleteEntry(String id, String entryId) Delete the Fragment entry
ContentRepositoryFragmentResponse	get(String id) Get the ContentRepository Fragment with given id
ContentRepositoryFragmentEntryResponse	getEntry(String id, String entryId) Get a Fragment Entry
ContentRepositoryFragmentListResponse	list(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) List available ContentRepository Fragments. The result can be filtered by id globalId name and sorted by id globalId name
ContentRepositoryFragmentEntryListResponse	listEntries(String id, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging) Get the entries in the ContentRepository Fragment. The result can be filtered by id globalId tagname mapname foreignlinkAttribute foreignlinkAttributeRule category and sorted by id 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 id
ContentRepositoryFragmentEntryResponse	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 by

• id
• globalId
• name

and sorted by

• id
• globalId
• name

Parameters:

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - 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(value="/{id}")
ContentRepositoryFragmentResponse get(@PathParam(value="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(value="/{id}")
ContentRepositoryFragmentResponse update(@PathParam(value="id")
                                                                    String id,
                                                                    ContentRepositoryFragmentModel item)
                                                             throws Exception

Update ContentRepository Fragment with given id

Parameters:

id - internal or external ContentRepository Fragment ID

item - updated ContentRepository Fragment

Returns:

updated ContentRepository Fragment

Throws:

Exception

delete

@DELETE
 @Path(value="/{id}")
javax.ws.rs.core.Response delete(@PathParam(value="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(value="/{id}/entries")
ContentRepositoryFragmentEntryListResponse listEntries(@PathParam(value="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 by

• id
• globalId
• tagname
• mapname
• foreignlinkAttribute
• foreignlinkAttributeRule
• category

and sorted by

• id
• globalId
• tagname
• mapname
• objType
• attributeType
• targetType
• multivalue
• optimized
• filesystem
• foreignlinkAttribute
• foreignlinkAttributeRule
• category
• segmentfield
• displayfield
• urlfield

Parameters:

id - internal or external ID

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

list of entries

Throws:

Exception

addEntry

@POST
 @Path(value="/{id}/entries")
ContentRepositoryFragmentEntryResponse addEntry(@PathParam(value="id")
                                                                                    String id,
                                                                                    ContentRepositoryFragmentEntryModel item)
                                                                             throws Exception

Create a new ContentRepository Fragment Entry

Parameters:

id - internal or external ID of the ContentRepository Fragment

item - entry to create

Returns:

created entry

Throws:

Exception

getEntry

@GET
 @Path(value="/{id}/entries/{entryId}")
ContentRepositoryFragmentEntryResponse getEntry(@PathParam(value="id")
                                                                                             String id,
                                                                                             @PathParam(value="entryId")
                                                                                             String entryId)
                                                                                      throws Exception

Get a Fragment Entry

Parameters:

id - internal or external ID of the ContentRepository Fragment

entryId - internal or external ID of the entry

Returns:

response containing the entry

Throws:

Exception

updateEntry

@PUT
 @Path(value="/{id}/entries/{entryId}")
ContentRepositoryFragmentEntryResponse updateEntry(@PathParam(value="id")
                                                                                                String id,
                                                                                                @PathParam(value="entryId")
                                                                                                String entryId,
                                                                                                ContentRepositoryFragmentEntryModel item)
                                                                                         throws Exception

Update Fragment entry

Parameters:

id - internal or external ContentRepository Fragment ID

entryId - internal or external entry ID

item - updated entry

Returns:

updated entry

Throws:

Exception

deleteEntry

@DELETE
 @Path(value="/{id}/entries/{entryId}")
javax.ws.rs.core.Response deleteEntry(@PathParam(value="id")
                                                                                      String id,
                                                                                      @PathParam(value="entryId")
                                                                                      String entryId)
                                                                               throws Exception

Delete the Fragment entry

Parameters:

id - internal or external ContentRepository Fragment ID

entryId - internal or external entry ID

Returns:

response

Throws:

Exception