Details

      Description

      Story

      As a developer
      I can create, read, update and delete the file plan root via a ReSTful public API
      So that the can develop 3rd party applications that utilize IG services

      Constraints

      • Swagger 2.0 documentation is considered part of the scope of this story
      • Alfresco ReST API guidelines must be followed

      Design Considerations

      • The characteristics of entities of this API could be considered as extensions of the core entities folder.
        This should be considered with reference to the existing core V1 API when designing this ReSTful API.
      • Should we consider the unfiled, hold and transfer containers as part of this API? They might be subject to change. Perhaps only
        consider the unfiled container as something special for now.

      Acceptance Criteria

      Given that a file plan exists
      And contains several root record categories
      When I use the API to get the children of the file plan
      Then I am given a list of the root record categories
      And their details

      See RM-3966

      Note: by default the "system" folders, holds, unfilled records and transfers, are not returned by this API.

      Given that a file plan exists
      When I ask the API to get me the unfilled record container
      Then I am given the unfiled record container
      And its details

      Note: for now we don't need to worry about getting the holds or transfers containers

      Given that a file plan exists
      When I ask the API for the details of the file plan
      Then I am given the details of the file plan

      Given that a file plan exists
      When I ask the API for the details of the file plan to include the allowableOperations property
      Then I am given the allowableOperations property with the update and create operations.

      Given that a file plan exists
      When I ask the API to modify the details of the file plan
      Then the details of the file are modified

      Note: the details of the file plan are limited to title and description.

      Given that a file plan exists
      When I ask the API to delete the file plan
      Then the 403 response code is returned.

      Given that RM site exists
      When I ask to create the file plan
      Then the 403 response code is returned.

      Given that the RM site doesn't exist
      When I use the API to get the File Plan/holds/unfilled/transfers
      Then I get the 404 response code

        Attachments

          Issue Links

            Structure

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  royw Roy Wetherall (Inactive)
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Time Tracking

                    Estimated:
                    Original Estimate - 1 day Original Estimate - 1 day
                    1d
                    Remaining:
                    Remaining Estimate - 0 minutes
                    0m
                    Logged:
                    Time Spent - 3 weeks, 1 hour
                    3w 1h

                      Structure Helper Panel