Interface ContentRepositoryFragmentResource


  • @Produces("application/json")
    @Consumes("application/json")
    @Path("/cr_fragments")
    public interface ContentRepositoryFragmentResource
    Resource for handling ContentRepository Fragments
    • Method Detail

      • 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
      • 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 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
      • 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 Fragment
        entryId - internal or external ID of the entry
        Returns:
        response containing the 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 ID
        entryId - internal or external entry ID
        Returns:
        response
        Throws:
        Exception