Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None

      Description

      Story

      As a developer
      I can create, read, update and delete record categories 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.

      Acceptance Criteria

      Given that a file plan exists
      When I ask the API to create a root record category
      Then it is created as a root record category

      Given that a record category exists
      When I ask the API to create a record category
      Then it is created within the record category

      Given that a record category exists
      And contains a number of record categories and record folders
      When I ask the APi to get me the children of the record category
      Then I am returned the contained record categories and record folders
      And their details

      Note: It may be desirable to have a parameter on the API that allows the return of just record categories, record folders or both

      Given that a record category exists
      When I ask the API for the details of the record category
      Then I am given the details of the record category

      Given that a record category exists
      When I ask the API to update the details of the record category
      Then the details of the record category are updated

      Note: the details of a record category does not include the details of the disposition schedule. It does include any custom meta-data.

      Given that a record category exists
      When I ask the API to delete the record category
      Then the record category and all its contents is deleted

        Attachments

          Structure

            Activity

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day
                  1d

                    Structure Helper Panel