REST APIs

REST API to manage features within account groups (ADT-4447)

Added accountgroups REST API to allow admin users the ability to manage features in account groups.

Method Endpoint Description
GET /accountgroups/features/ Gets the list of users in a specific account group
PUT /accountgroups/{accountgroupid}/features/{featureid} Adds a user to an account group
DELETE /accountgroups/{accountgroupid}/features/{featureid} Removes a feature from an account group

REST API to manage the users in account groups (ADT-4448)

Added accountgroups REST API to allow admin users the ability to manage the users in account groups.

Method Endpoint Description
GET /accountgroups/{accountgroupid}/users/ Gets the list of features in an account group
PUT /accountgroups/{accountgroupid}/users/{userid} Adds a feature in anaccount group
DELETE /accountgroups/{accountgroupid}/users/{userid} Removes a user from an account group

REST API for Orchestration Scheduling (ADT-4642)

Added a REST API wrapper that can call existing Orchestration and Scheduling APIs. This allows calls to be made that can create, update, delete, and get a workflow schedule available in Orchestration. The REST API uses the workflow ID and schedule ID to run the API calls.

Method Endpoint Description
GET /workflows/{workflowid}/schedules Get list of schedules of a workflow
POST /workflows/{workflowid}/schedules Add new workflow schedule
GET /workflows/{workflowid}/schedules/{scheduleid} Get details of the given workflow schedule
DELETE /workflows/{workflowid}/schedules/{scheduleid} Delete the given workflow schedule

REST API for Exporting a Report in CSV (COOL-18212)

Added a REST API to allow users to export a report in a CSV format. Users can pass report parameters and then generate the report as a CSV.

Method Endpoint Description
GET /spaces/{spaceId}/reports Get list of reports for space
GET /spaces/{spaceId}/reports/{reportId} Get a report
POST /spaces/{spaceId}/reports/{reportId}/action Perform an action on a report

REST API for space commands (Multiple: IBBIT-3103, COOL-18299,COOL-18300,COOL-18402,COOL-18403,COOL-18400,COOL-18401,COOL-18230)

Added clearCacheInSpace REST API to perform space commands for a particular space, improving performance.

Method Endpoint Description
POST /spaces/{spaceId}/action Clears the cache for a particular space
Example: 
{
  "action": "clearcacheinspace"
}
These actions can be used with this REST API endpoint and do not require additional parameters in the request body:
  • clearcacheinspace:
  • cleardashboardcache:
  • rebuildindices:
  • resynchronizesubjectareas:
Example: 
{
  "action": "cleardashboardcache"
}
These actions do require additional parameters in the request body:
  • repointnetworks:
  • repointpackages:
    • existingParentSpaceId
    • newParentSpaceId
Example: 
{
  "action": "repointnetworks",
  "payload": 
           {     
             "childSpaceId": "1deb6b6d-81b4-4e15-96c6-d31d9c6318df",                                                                                                                    
"existingParentSpaceId": "1deb6b6d-81b4-4e15-96c6-d31d9c6318as",
"newParentSpaceId": "1deb6b6d-81b4-4e15-96c6-d31d9c6318as"   
           }
}
  • resynchronizefiles:
    • forceStateUpdate
Example: 
{
  "action": "resynchronizefiles",
  "payload": 
           {     
             "forceStateUpdate": false                                                                                                                  
           }
}
  • repointconnection:
    • fromConnectionId
    • toConnectionId
Example: 
{
  "action": "repointconnection",
  "payload": 
           {     
             "fromConnectionId": "1deb6b6d-81b4-4e15-96c6-d31d9c6318df",                                                                                                                    
"toConnectionId": "1deb6b6d-81b4-4e15-96c6-d31d9c6318as"   
           }
}