Package com.gentics.contentnode.rest.resource

Interface MCFileResource

@Produces("application/json") @Consumes("application/json") @Path("/file") public interface MCFileResource
Resource for handling multichannelling aspects of files

  • Method Details

    • getSyncableObjects

      @GET @Path("/usage/syncableObjects") ReferencedSyncableObjectsListResponse getSyncableObjects(@QueryParam("ids") List<Integer> fileIds, @QueryParam("srcNodeId") Integer srcNodeId, @QueryParam("dstNodeId") Integer dstNodeId) throws Exception
      Get objects which are directly or indirectly linked by the specified files, which can be synchronised to a master channel along with the files 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:
      fileIds - The IDs of the files to get linked objects for
      srcNodeId - The channel ID of the source channel
      dstNodeId - The channel ID of the target channel
      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 file from a channel into a master
      Parameters:
      id - id of the file
      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 pages 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 file
      Parameters:
      id - id of the file 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 files 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 file
      Parameters:
      id - id of the file 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 file.
      Parameters:
      id - The ID of the master file.
      Returns:
      A map of folder IDs to node IDs of localized copies.
      Throws:
      Exception

    • getLocalizationInfo

      @GET @Path("/localizationinfo") LocalizationInfo getLocalizationInfo(@QueryParam("id") List<Integer> ids, @QueryParam("nodeId") Integer nodeId) throws Exception
      Get localization info for a list of files for a given channel and all master channels
      Parameters:
      ids - list of file ids
      nodeId - id of the node to start with
      Returns:
      localization info
      Throws:
      Exception

    • getLocalizationInfo

      @GET @Path("/localizationinfo/{id}") LocalizationInfo getLocalizationInfo(@PathParam("id") Integer id, @QueryParam("nodeId") Integer nodeId) throws Exception
      Get localization info for a file for a given channel and all master channels
      Parameters:
      id - id of the file
      nodeId - id of the node to start with
      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 file
      Parameters:
      id - file 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 - file ID
      nodeId - 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 pages
      Parameters:
      ids - list of page 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 pages
      Parameters:
      ids - list of page IDs
      nodeId - node ID
      waitMs - wait timeout in milliseconds
      request - request object
      Returns:
      generic response
      Throws:
      Exception