Uploaded image for project: 'Service Packs and Hot Fixes'
  1. Service Packs and Hot Fixes
  2. MNT-21966

Allowable operations and optional properties for Checkin/Checkout


    • Type: Feature
    • Status: Need Info
    • Resolution: Unresolved
    • Affects Version/s: 6.2
    • Fix Version/s: None
    • Component/s: ACS REST API
    • Labels:


      As a developer using the REST API I want the list of allowable operations for a node to reflect it's checked out/locked state and the ability to request the id of working copy node or the original source node so that my client can properly handle checked out and locked content.

      Acceptance Criteria

      • An optional property named isWorkingCopy is available via the include mechanism for node listings
      • An optional property named workingCopyId is available via the include mechanism for the originally checked out node, it contains the id of the working copy node
        • If the node is not checked out or is a working copy the property will not be present
      • An optional property named checkoutSourceId is available via the include mechanism for the working copy node, it contains the id of the node the working copy is related to
        • If the node is not a working copy the property will not be present
      • The list of allowableOperations for a node includes one or more of the following values depending on the state of the node (see table below):
        • checkout
        • lock
        • unlock
        • checkin
        • cancel-checkout

      The table below shows the allowableOperations that should be returned for various node states for a user with write permission or the admin user. All other combinations or if the user only has read only permission, no additional options should be added to allowableOperations.

      isLocked isCheckedOut isWorkingCopy allowableOperations
      true false false unlock
      true true true cancel-checkout,checkin
      false false false lock,checkout

      In additional to the rules above the "delete" allowableOperation should also be removed from working copy nodes and an attempt to delete a working copy node should be prevented as was done in REPO-160 for individual site folders. The error message should instruct the client to use the cancel checkout endpoint instead.


          Issue Links




                • Assignee:
                  sashcraft Scott Ashcraft
                • Votes:
                  2 Vote for this issue
                  3 Start watching this issue


                  • Created:

                    Structure Helper Panel