Package com.gentics.contentnode.rest.resource

Interface MCPageResource

@Produces("application/json") @Consumes("application/json") @Path("/page") public interface MCPageResource
Resource for handling multichannelling aspects of pages.

  • Method Details

    • getSyncableObjects

      @GET @Path("/usage/syncableObjects") ReferencedSyncableObjectsListResponse getSyncableObjects(@QueryParam("ids") List<Integer> pageIds, @QueryParam("srcNodeId") Integer srcNodeId, @QueryParam("dstNodeId") Integer dstNodeId) throws Exception
      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 page from a channel into a master
      Parameters:
      id - id of the page
      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 page
      Parameters:
      id - id of the page 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 pages 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 page
      Parameters:
      id - id of the page to localize
      request - request
      Returns:
      generic response
      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 pages for a given channel and all master channels
      Parameters:
      ids - list of page 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 page for a given channel and all master channels
      Parameters:
      id - id of the page
      nodeId - id of the node to start with
      Returns:
      localization info
      Throws:
      Exception

    • localizations

      @GET @Path("/localizations/{id}") LocalizationsResponse localizations(@PathParam("id") Integer id, @QueryParam("status") @DefaultValue("false") boolean addStatus) throws Exception
      Get the IDs an their respective node IDs of localized copies of the specified page.
      Parameters:
      id - The ID of the master page.
      addStatus - When true information about the pages statuses will be added to the response.
      Returns:
      A map of page IDs to node IDs of localized copies, with optional status information.
      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 page
      Parameters:
      id - page 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 - page 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 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