Package com.gentics.contentnode.rest.resource

Interface MCFolderResource

@Produces("application/json") @Consumes("application/json") @Path("/folder") public interface MCFolderResource
Resource for handling multichannelling aspects of folders

  • Method Details

    • getSyncableObjects

      @GET @Path("/usage/syncableObjects") ReferencedSyncableObjectsListResponse getSyncableObjects(@QueryParam("ids") List<Integer> folderIds, @QueryParam("srcNodeId") Integer srcNodeId, @QueryParam("dstNodeId") Integer dstNodeId, @QueryParam("recursive") Boolean recursive, @QueryParam("types") List<PushToMasterRequest.Type> types) throws Exception
      Get objects which are directly or indirectly linked by the specified folders, which can be synchronised to a master channel along with the folders themselves. Linked objects are pages, files and images specified in UrlPartTypes of content or object tags. Direct dependencies are in the pages, files and images files of the response. Indirect dependencies are mapped in dependencies.
      Parameters:
      folderIds - The IDs of the folders to get linked objects for
      srcNodeId - The channel ID of the source channel
      dstNodeId - The channel ID of the target channel
      recursive - Whether objects in subfolders should be collected (optional, default: false)
      types - The object types which should be synchronised (optional, default: all types)
      Throws:
      Exception

    • pushToMaster

      @POST @Path("/push2master/{id}") com.gentics.contentnode.rest.model.response.GenericResponse pushToMaster(@PathParam("id") Integer id, PushToMasterRequest request) throws Exception
      Push a folder from a channel into a master
      Parameters:
      id - id of the folder
      request - request
      Returns:
      generic response
      Throws:
      Exception

    • pushToMaster

      @POST @Path("/push2master") com.gentics.contentnode.rest.model.response.GenericResponse pushToMaster(MultiPushToMasterRequest request) throws Exception
      Push a list of folders from a channel into a master
      Parameters:
      request - request
      Returns:
      generic response
      Throws:
      Exception

    • unlocalize

      @POST @Path("/unlocalize/{id}") com.gentics.contentnode.rest.model.response.GenericResponse unlocalize(@PathParam("id") Integer id, UnlocalizeRequest request) throws Exception
      Unlocalize the given folder
      Parameters:
      id - id of the folder to unlocalize
      request - request
      Returns:
      generic response
      Throws:
      Exception

    • unlocalize

      @POST @Path("/unlocalize") com.gentics.contentnode.rest.model.response.GenericResponse unlocalize(MultiUnlocalizeRequest request) throws Exception
      Unlocalize folders in a channel
      Parameters:
      request - request
      Returns:
      generic response
      Throws:
      Exception

    • localize

      @POST @Path("/localize/{id}") com.gentics.contentnode.rest.model.response.GenericResponse localize(@PathParam("id") Integer id, LocalizeRequest request) throws Exception
      Localize the given folder
      Parameters:
      id - id of the folder to localize
      request - request
      Returns:
      generic response
      Throws:
      Exception

    • localizations

      @GET @Path("/localizations/{id}") LocalizationsResponse localizations(@PathParam("id") Integer id) throws Exception
      Get the IDs an their respective node IDs of localized copies of the specified folder.
      Parameters:
      id - The ID of the master folder.
      Returns:
      A map of folder IDs to node IDs of localized copies.
      Throws:
      Exception

    • getLocalizationInfo

      @GET @Path("/localizationinfo/{id}") LocalizationInfo getLocalizationInfo(@PathParam("id") String id, @QueryParam("nodeId") Integer nodeId, @QueryParam("recursive") boolean recursive) throws Exception
      Get localization info for a folder and all subitems for a given channel and all master channels
      Parameters:
      id - id of the folder. This can either be the local or global id
      nodeId - id of the node to start with
      recursive - true if the localization info shall be fetched recursively, false if not
      Returns:
      localization info
      Throws:
      Exception

    • disinherit

      @GET @Path("/disinherit/{id}") DisinheritResponse disinherit(@PathParam("id") String id, @QueryParam("nodeId") Integer nodeId) throws Exception
      Get the multichannelling exclusion and disinherit status of the folder
      Parameters:
      id - folder ID
      nodeId - node ID
      Returns:
      response containing the exclusion and disinherit status
      Throws:
      Exception

    • disinherit

      @POST @Path("/disinherit/{id}") com.gentics.contentnode.rest.model.response.GenericResponse disinherit(@PathParam("id") String id, @QueryParam("nodeId") Integer nodeId, @QueryParam("wait") @DefaultValue("0") long waitMs, DisinheritRequest request) throws Exception
      Set the multichannelling exclusion and disinherit status
      Parameters:
      id - folder ID
      nodeId - node ID
      waitMs - wait timeout in milliseconds
      request - request object
      Returns:
      generic response
      Throws:
      Exception

    • disinherit

      @GET @Path("/disinherit") MultiDisinheritResponse disinherit(@QueryParam("id") List<String> ids, @QueryParam("nodeId") Integer nodeId) throws Exception
      Get the multichannelling exclusion and disinherit status for a list of folders
      Parameters:
      ids - list of folder IDs
      nodeId - node ID
      Returns:
      response containing the exclusion and disinherit status
      Throws:
      Exception

    • disinherit

      @POST @Path("/disinherit") com.gentics.contentnode.rest.model.response.GenericResponse disinherit(@QueryParam("id") List<String> ids, @QueryParam("nodeId") Integer nodeId, @QueryParam("wait") @DefaultValue("0") long waitMs, DisinheritRequest request) throws Exception
      Set the multichannelling exclusion and disinherit status for a list of folders
      Parameters:
      ids - list of folder IDs
      nodeId - node ID
      waitMs - wait timeout in milliseconds
      request - request object
      Returns:
      generic response
      Throws:
      Exception