Retention management changes

amps/ags/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/gs-core-api.yaml

@@ -40,7 +40,9 @@ tags:
     description: Retrieve and manage unfiled record folders
   - name: events
     description: Retrieve and manage retention events
-    
+  - name: retention-management
+    description: Retrieve and manage retention schedule
+
 paths:
   ## GS sites
   '/gs-sites':
@@ -104,7 +106,7 @@ paths:
         - gs-sites
       summary: Get the Records Management (RM) site
       description: |
- 
+
         Gets information for RM site.
 
       operationId: getRMSite
@@ -693,7 +695,7 @@ paths:
           description: New name clashes with an existing node in the current parent container
         '422':
           description: Model integrity exception, including node name with invalid characters
- ## Unfiled record folders
+  ## Unfiled record folders
   '/unfiled-record-folders/{unfiledRecordFolderId}':
     get:
       tags:
@@ -2158,7 +2160,6 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
-  
   '/events/{eventId}':
     get:
       tags:
@@ -2178,7 +2179,7 @@ paths:
             $ref: '#/definitions/EventEntry'
         '400':
           description: |
-            Invalid parameter: **eventId** is invalid    
+            Invalid parameter: **eventId** is invalid
         '401':
           description: Authentication failed
         '404':
@@ -2224,7 +2225,6 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
-  
   '/event-types':
     get:
       tags:
@@ -2251,7 +2251,123 @@ paths:
         default:
           description: Unexpected error
           schema:
-            $ref: '#/definitions/Error'          
+            $ref: '#/definitions/Error'
+
+  ## Retention-management
+  '/dispositionschedule/{storeType}/{storeId}/{nodeId}':
+    get:
+      tags:
+        - retention-management
+      summary: List all available retention schedule
+      description: |
+        Use this to get the information of a retention schedule applied on a category. Mandatory fields and properties are returned by default
+      operationId: getAllRetentionSteps
+      produces:
+        - application/json
+      parameters:
+        - $ref: '#/parameters/storeTypeParam'
+        - $ref: '#/parameters/storeIdParam'
+        - $ref: '#/parameters/nodeIdParam'
+        - $ref: '#/parameters/skipCountParam'
+        - $ref: '#/parameters/maxItemsParam'
+      responses:
+        '200':
+          description: Successful response
+          schema:
+            $ref: '#/definitions/RetentionSchedulePaging'
+        '400':
+          description: |
+            Invalid parameter: value of **maxItems** or **skipCount** is invalid
+        '401':
+          description: Authentication failed
+        '403':
+          description: Current user does not have permission to read retention schedule.
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+
+    post:
+      tags:
+        - retention-management
+      summary: Creates a retention schedule on a category in record management site.
+      description: |
+        Creates a retention schedule on a category in record management site with given details. 
+        Mandatory fields and properties are returned by default.
+      operationId: postRetentionSteps
+      parameters:
+        - $ref: '#/parameters/storeTypeParam'
+        - $ref: '#/parameters/storeIdParam'
+        - $ref: '#/parameters/nodeIdParam'
+        - in: body
+          name: retentionBodyCreate
+          description: The retention schedule.
+          required: true
+          schema:
+            $ref: '#/definitions/RetentionBody'
+
+      produces:
+        - application/json
+      responses:
+        '200':
+          description: Successful response
+          schema:
+            $ref: '#/definitions/RetentionSchedule'
+        '400':
+          description: |
+            Invalid parameter: **nodeId** is not a valid format
+        '401':
+          description: Authentication failed
+        '403':
+          description: Current user does not have permission to create retention schedule.
+        '404':
+          description: "**nodeId** does not exist"
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+  '/dispositionschedule/{storeType}/{storeId}/{nodeId}/{retentionScheduletId}':
+    put:
+      tags:
+        - retention-management
+      summary: Update a retention schedule on a category in record management site.
+      operationId: updateRetentionSteps
+      description: |
+        Update the a retention schedule on a category in record management site. Use this to change event display level or to change event type.
+      produces:
+        - application/json
+      parameters:
+        - $ref: '#/parameters/storeTypeParam'
+        - $ref: '#/parameters/storeIdParam'
+        - $ref: '#/parameters/nodeIdParam'
+        - $ref: '#/parameters/retentionIdParam'
+        - in: body
+          name: retentionBodyUpdate
+          description: The retention schedule to update.
+          required: true
+          schema:
+            $ref: '#/definitions/RetentionBody'
+      responses:
+        '200':
+          description: Successful response
+          schema:
+            $ref: '#/definitions/RetentionSchedule'
+        '400':
+          description: |
+            Invalid parameter: The update request is invalid or **eventId** is not a valid format or **eventBodyUpdate** is invalid
+        '401':
+          description: Authentication failed
+        '403':
+          description: Current user does not have permission to update events
+        '404':
+          description: "**eventId** does not exist"
+        '409':
+          description: Cannot update event. An event with the name **name** already exists
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+
 parameters:
   ## event
   eventIdParam:
@@ -2260,6 +2376,31 @@ parameters:
     description: The identifier of an event.
     required: true
     type: string
+    ## retention-management
+  storeTypeParam:
+    name: storeType
+    in: path
+    description: The identifier of store type.
+    required: true
+    type: string
+  storeIdParam:
+    name: storeId
+    in: path
+    description: The identifier of store Id.
+    required: true
+    type: string
+  nodeIdParam:
+    name: nodeId
+    in: path
+    description: The identifier of node id.
+    required: true
+    type: string
+  retentionIdParam:
+    name: retentionScheduletId
+    in: path
+    description: The identifier of a retention schedule.
+    required: true
+    type: string
   ## File plans
   filePlanEntryIncludeParam:
     name: include
@@ -2341,7 +2482,7 @@ parameters:
     description: Also include **source** (in addition to **entries**) with folder information on the parent node – the specified parent **unfiledContainerId**
     required: false
     type: boolean
-## Unfiled record folders
+  ## Unfiled record folders
   unfiledRecordFolderIdParam:
     name: unfiledRecordFolderId
     in: path
@@ -2675,15 +2816,15 @@ parameters:
     name: attachment
     in: query
     description: |
-       **true** enables a web browser to download the file as an attachment.
-       **false** means a web browser may preview the file in a new tab or window, but not
-       download the file.
+      **true** enables a web browser to download the file as an attachment.
+      **false** means a web browser may preview the file in a new tab or window, but not
+      download the file.
 
-       You can only set this parameter to **false** if the content type of the file is in the supported list;
-       for example, certain image files and PDF files.
+      You can only set this parameter to **false** if the content type of the file is in the supported list;
+      for example, certain image files and PDF files.
 
-       If the content type is not supported for preview, then a value of **false**  is ignored, and
-       the attachment will be returned in the response.
+      If the content type is not supported for preview, then a value of **false**  is ignored, and
+      the attachment will be returned in the response.
     required: false
     default: true
     type: boolean
@@ -2727,14 +2868,14 @@ definitions:
   FilePlan:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -2810,14 +2951,14 @@ definitions:
   UnfiledContainer:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -2863,16 +3004,16 @@ definitions:
   UnfiledContainerChild:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - isUnfiledRecordFolder
-    - isRecord
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - isUnfiledRecordFolder
+      - isRecord
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -2957,16 +3098,16 @@ definitions:
   UnfiledRecordFolder:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - isUnfiledRecordFolder
-    - isRecord
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - isUnfiledRecordFolder
+      - isRecord
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3016,16 +3157,16 @@ definitions:
   UnfiledRecordFolderChild:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - isUnfiledRecordFolder
-    - isRecord
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - isUnfiledRecordFolder
+      - isRecord
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3110,14 +3251,14 @@ definitions:
   RecordCategory:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3160,14 +3301,14 @@ definitions:
   RecordCategoryChild:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3262,14 +3403,14 @@ definitions:
   RecordFolder:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3348,14 +3489,14 @@ definitions:
   Record:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3408,14 +3549,14 @@ definitions:
   TransferContainer:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3459,12 +3600,12 @@ definitions:
   TransferContainerChild:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3549,12 +3690,12 @@ definitions:
   Transfer:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - parentId
     properties:
       id:
         type: string
@@ -3604,14 +3745,14 @@ definitions:
   TransferChild:
     type: object
     required:
-    - id
-    - name
-    - nodeType
-    - createdAt
-    - createdByUser
-    - modifiedAt
-    - modifiedByUser
-    - parentId
+      - id
+      - name
+      - nodeType
+      - createdAt
+      - createdByUser
+      - modifiedAt
+      - modifiedByUser
+      - parentId
     properties:
       id:
         type: string
@@ -4015,4 +4156,119 @@ definitions:
         description: The association used to determine whether automatic events of this type are complete
       actionOnAssociatedNode:
         type: string
-        description: If an association name is set for this event type then it is possible to require an action to be completed on the associated node
+        description: If an association name is set for this event type then it is possible to require an action to be completed on the associated node
+  RetentionBody:
+    type: object
+    required:
+      - name
+      - description
+      - period
+      - periodProperty
+      - eligibleOnFirstCompleteEvent
+      - events
+    properties:
+      name:
+        type: string
+        description: this is retention schedule name
+      description:
+        type: string
+        description: this is retention schedule description
+      period:
+        type: string
+        description: this is retention schedule period
+      periodProperty:
+        type: string
+        description: this is retention schedule periodProperty
+      eligibleOnFirstCompleteEvent:
+        type: boolean
+        description: this is retention schedule eligibleOnFirstCompleteEvent
+        default: true
+      combineDispositionStepConditions:
+        type: boolean
+        description: this is retention schedule combineDispositionStepConditions
+        default: false
+      events:
+        $ref: '#/definitions/Events'
+  Events:
+    type: object
+    description: List of events for the retion schedule
+    required:
+      - name
+    properties:
+      name:
+        type: string
+        description: Name of the event.
+
+  RetentionSchedulePaging:
+    type: object
+    properties:
+      list:
+        type: object
+        properties:
+          pagination:
+            $ref: '#/definitions/Pagination'
+          entries:
+            type: array
+            items:
+              $ref: '#/definitions/RetentionScheduleEntry'
+
+  RetentionScheduleEntry:
+    type: object
+    required:
+      - entry
+    properties:
+      entry:
+        $ref: '#/definitions/RetentionData'
+  RetentionData:
+    type: object
+    properties:
+      authority:
+        type: string
+        description: this is retention schedule authority name
+      instructions:
+        type: string
+        description: this is retention schedule instructions
+      unpublishedUpdates:
+        type: boolean
+        description: this is retention schedule unpublishedUpdates
+        default: false
+      publishInProgress :
+        type: boolean
+        description: this is retention schedule publishInProgress
+        default: false
+      recordLevelDisposition:
+        type: boolean
+        description: this is retention schedule recordLevelDisposition
+        default: false
+      canStepsBeRemoved:
+        type: boolean
+        description: this is retention schedule canStepsBeRemoved
+        default: true
+      actions:
+        $ref: '#/definitions/RetentionSchedule'
+
+  RetentionSchedule:
+    type: object
+    properties:
+      name:
+        type: string
+        description: Name of the retention schedule.
+      label:
+        type: string
+        description: Label of the retention schedule.
+      description:
+        type: string
+        description: this is retention schedule description
+      period:
+        type: string
+        description: this is retention schedule period
+      combineDispositionStepConditions:
+        type: boolean
+        description: this is retention schedule combineDispositionStepConditions
+        default: false
+      eligibleOnFirstCompleteEvent:
+        type: boolean
+        description: this is retention schedule eligibleOnFirstCompleteEvent
+        default: true
+      events:
+        $ref: '#/definitions/Events'