Interface ContentRepositoryResource


  • @Produces("application/json")
    @Consumes("application/json")
    @Path("/contentrepositories")
    public interface ContentRepositoryResource
    Resource for handling ContentRepositories
    • Method Detail

      • list

        @GET
        ContentRepositoryListResponse list​(@BeanParam
                                           FilterParameterBean filter,
                                           @BeanParam
                                           SortParameterBean sorting,
                                           @BeanParam
                                           PagingParameterBean paging,
                                           @BeanParam
                                           PermsParameterBean perms)
                                    throws Exception
        List available ContentRepositories.
        The result can be filtered by
        • id
        • globalId
        • name
        • crType
        • dbType
        • username
        • url
        • basepath
        and sorted by
        • id
        • globalId
        • name
        • crType
        • dbType
        • username
        • url
        • basepath
        • instantPublishing
        • languageInformation
        • permissionInformation
        • diffDelete
        • checkDate
        • checkStatus
        • statusDate
        • dataStatus
        Parameters:
        filter - filter parameters
        sorting - sorting parameters
        paging - paging parameters
        perms - permissions parameters
        Returns:
        List of ContentRepositories
        Throws:
        Exception
      • get

        @GET
        @Path("/{id}")
        ContentRepositoryResponse get​(@PathParam("id")
                                      String id)
                               throws Exception
        Get the ContentRepository 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 with given id
        Parameters:
        id - internal or external ContentRepository ID
        Returns:
        response
        Throws:
        Exception
      • check

        @PUT
        @Path("/{id}/structure/check")
        ContentRepositoryResponse check​(@PathParam("id")
                                        String id,
                                        @QueryParam("wait") @DefaultValue("0")
                                        long waitMs)
                                 throws Exception
        Check the connectivity and structure of the given contentrepository
        Parameters:
        id - internal or external ContentRepository ID
        waitMs - wait timeout in ms. When set to 0, response will be sent, when the action completes
        Returns:
        response
        Throws:
        Exception
      • repair

        @PUT
        @Path("/{id}/structure/repair")
        ContentRepositoryResponse repair​(@PathParam("id")
                                         String id,
                                         @QueryParam("wait") @DefaultValue("0")
                                         long waitMs)
                                  throws Exception
        Check and repair the connectivity and structure of the given contentrepository
        Parameters:
        id - internal or external ContentRepository ID
        waitMs - wait timeout in ms. When set to 0, response will be sent, when the action completes
        Returns:
        response
        Throws:
        Exception
      • checkData

        @PUT
        @Path("/{id}/data/check")
        ContentRepositoryResponse checkData​(@PathParam("id")
                                            String id)
                                     throws Exception
        Check the data in the given contentrepository
        Parameters:
        id - internal or external ContentRepository ID
        Returns:
        response
        Throws:
        Exception
      • repairData

        @PUT
        @Path("/{id}/data/repair")
        ContentRepositoryResponse repairData​(@PathParam("id")
                                             String id)
                                      throws Exception
        Check and repair the data in the given contentrepository
        Parameters:
        id - internal or external ContentRepository ID
        Returns:
        response
        Throws:
        Exception
      • copy

        @PUT
        @Path("/{id}/copy")
        ContentRepositoryResponse copy​(@PathParam("id")
                                       String id)
                                throws Exception
        Copy a ContentRepotiroy
        Parameters:
        id - internal or external ID of the ContentRepository to copy
        Returns:
        response containing the copy
        Throws:
        Exception
      • listEntries

        @GET
        @Path("/{id}/entries")
        TagmapEntryListResponse listEntries​(@PathParam("id")
                                            String id,
                                            @QueryParam("fragments") @DefaultValue("false")
                                            boolean fragments,
                                            @BeanParam
                                            FilterParameterBean filter,
                                            @BeanParam
                                            SortParameterBean sorting,
                                            @BeanParam
                                            PagingParameterBean paging)
                                     throws Exception
        Get the entries in the ContentRepository.
        The result can be filtered by
        • id
        • globalId
        • tagname
        • mapname
        • foreignlinkAttribute
        • foreignlinkAttributeRule
        • category
        • fragmentName
        and sorted by
        • id
        • globalId
        • tagname
        • mapname
        • object
        • attributeType
        • targetType
        • multivalue
        • optimized
        • filesystem
        • foreignlinkAttribute
        • foreignlinkAttributeRule
        • category
        • segmentfield
        • displayfield
        • urlfield
        • fragmentName
        Parameters:
        id - internal or external ID
        fragments - true to include entries from assigned fragments, false (which is the default) to only list entries of the ContentRepository itself
        filter - filter parameters
        sorting - sorting parameters
        paging - paging parameters
        Returns:
        list of entries
        Throws:
        Exception
      • checkEntryConsistency

        @GET
        @Path("/{id}/entries/check")
        TagmapEntryConsistencyResponse checkEntryConsistency​(@PathParam("id")
                                                             String id)
                                                      throws Exception
        Check consistency of tagmap entries and return inconsistencies
        Parameters:
        id - internal or external ID
        Returns:
        consistency check result
        Throws:
        Exception
      • addEntry

        @POST
        @Path("/{id}/entries")
        TagmapEntryResponse addEntry​(@PathParam("id")
                                     String id,
                                     TagmapEntryModel item)
                              throws Exception
        Create a new tagmap entry
        Parameters:
        id - internal or external ID of the ContentRepository
        item - entry to create
        Returns:
        created entry
        Throws:
        Exception
      • getEntry

        @GET
        @Path("/{id}/entries/{entryId}")
        TagmapEntryResponse getEntry​(@PathParam("id")
                                     String id,
                                     @PathParam("entryId")
                                     String entryId)
                              throws Exception
        Get a tagmap entry
        Parameters:
        id - internal or external ID of the ContentRepository
        entryId - internal or external ID of the entry
        Returns:
        response containing the entry
        Throws:
        Exception
      • updateEntry

        @PUT
        @Path("/{id}/entries/{entryId}")
        TagmapEntryResponse updateEntry​(@PathParam("id")
                                        String id,
                                        @PathParam("entryId")
                                        String entryId,
                                        TagmapEntryModel item)
                                 throws Exception
        Update tagmap entry
        Parameters:
        id - internal or external ContentRepository ID
        entryId - internal or external entry ID
        item - 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 tagmap entry
        Parameters:
        id - internal or external ContentRepository ID
        entryId - internal or external entry ID
        Returns:
        response
        Throws:
        Exception
      • getCrFragment

        @GET
        @Path("/{id}/cr_fragments/{crFragmentId}")
        ContentRepositoryFragmentResponse getCrFragment​(@PathParam("id")
                                                        String id,
                                                        @PathParam("crFragmentId")
                                                        String crFragmentId)
                                                 throws Exception
        Get a ContentRepository Fragment assigned to the ContentRepository
        Parameters:
        id - internal or external ID of the ContentRepository
        crFragmentId - internal or external ID of the ContentRepository Fragment
        Returns:
        response containing the ContentRepository Fragment
        Throws:
        Exception
      • addCrFragment

        @PUT
        @Path("/{id}/cr_fragments/{crFragmentId}")
        javax.ws.rs.core.Response addCrFragment​(@PathParam("id")
                                                String id,
                                                @PathParam("crFragmentId")
                                                String crFragmentId)
                                         throws Exception
        Assign a ContentRepository Fragment to the ContentRepository
        Parameters:
        id - internal or external ContentRepository ID
        crFragmentId - internal or external ContentRepository Fragment ID
        Returns:
        Response
        Throws:
        Exception
      • removeCrFragment

        @DELETE
        @Path("/{id}/cr_fragments/{crFragmentId}")
        javax.ws.rs.core.Response removeCrFragment​(@PathParam("id")
                                                   String id,
                                                   @PathParam("crFragmentId")
                                                   String crFragmentId)
                                            throws Exception
        Remove the ContentRepository Fragment from the ContentRepository
        Parameters:
        id - internal or external ContentRepository ID
        crFragmentId - internal or external ContentRepository Fragment ID
        Returns:
        response
        Throws:
        Exception
      • getRoles

        @GET
        @Path("/{id}/roles")
        MeshRolesResponse getRoles​(@PathParam("id")
                                   String id)
                            throws Exception
        Get the roles currently set in the datasource used in the roles object property for the Mesh ContentRepository
        Parameters:
        id - ID of the Mesh ContentRepository
        Returns:
        response containing list of role names
        Throws:
        Exception
      • getAvailableRoles

        @GET
        @Path("/{id}/availableroles")
        MeshRolesResponse getAvailableRoles​(@PathParam("id")
                                            String id)
                                     throws Exception
        Get the roles available in the Mesh instance for the Mesh ContentRepository
        Parameters:
        id - ID of the Mesh ContentRepository
        Returns:
        response containing list of role names
        Throws:
        Exception
      • setRoles

        @POST
        @Path("/{id}/roles")
        MeshRolesResponse setRoles​(@PathParam("id")
                                   String id,
                                   MeshRolesRequest request)
                            throws Exception
        Set the roles to be used in the datasource of the roles object property for the Mesh ContentRepository
        Parameters:
        id - ID of the Mesh ContentRepository
        request - request containing the roles to set
        Returns:
        response containing the list of set role names
        Throws:
        Exception