SAS Clinical Acceleration Repository

The SAS Clinical Acceleration Repository API provides the necessary endpoints for managing the clinical repository.

Audit

The operations for audit history.
get
Get the collection of audit entries
Internal-Use OnlyReturns a collection of audit entries. The default sort is timestamp:ascending:primary. Requires administrative privileges./audit/entries
get
Get the specified audit entry
Internal-Use OnlyReturns the specified audit entry. Requires administrative privileges./audit/entries/{entryId}
head
Determines whether the specified audit entry exists
Internal-Use OnlyChecks whether the specified audit entry exists. Requires administrative privileges./audit/entries/{entryId}
get
Get the collection of audit actions
Internal-Use OnlyReturns a collection of audit actions. The default sort is action:ascending:primary. Requires administrative privileges. This collection supports only basic filtering. In addition, only a single sort is supported, and sort strength is ignored./audit/actions

Repository

The operations for repository management.
get
Download repository content by filter as a ZIP file
Internal-Use OnlyDownloads repository content that satisfies the filter as a ZIP file and returns the stream on the response body./repository/files/content
post
Download repository content by search as a zip file
Internal-Use OnlyDownloads repository content as a ZIP file based on search criteria, including filter or file content search text, and returns the stream on the response body./repository/files/content
get
Get the collection of repository items including contexts, folders and files
Internal-Use OnlyReturns the collection of repository items by query./repository/items
get
Get the specified repository item
Internal-Use OnlyReturns the specified repository item./repository/items/{itemId}
head
Determine whether the specified repository item exists
Internal-Use OnlyChecks whether the specified repository item exists./repository/items/{itemId}
patch
Update the attributes of a repository item
Internal-Use OnlyUpdates the editable attributes of this repository item./repository/items/{itemId}
delete
Delete a repository item
Internal-Use OnlyDeletes a repository item. By default, the item is moved to the recycle bin. If the permanent parameter value is set to true, the item is permanently deleted./repository/items/{itemId}
get
Get the children of the specified repository item
Internal-Use OnlyReturns the children of the specified repository item./repository/items/{itemId}/children
head
Determine whether the specified repository item has children
Internal-Use OnlyChecks whether the specified repository item has children./repository/items/{itemId}/children
post
Create a new repository container
Internal-Use OnlyCreate a new repository context or folder./repository/items/{itemId}/children
post
Download repository content
Internal-Use OnlyDownloads repository content and returns the stream on the response body./repository/items/{itemId}/content
put
Upload repository content
Internal-Use OnlyUploads a single file to create a new file or updates the content of an existing file. You can also upload and expand a ZIP file to a container./repository/items/{itemId}/content
get
Returns the specified repository item by path
Internal-Use OnlyGet the specified repository item by path./repository/paths
get
Get the repository item permissions
Internal-Use OnlyReturns the repository item permissions./repository/items/{itemId}/permissions
head
Determine whether the specified repository item permissions exist
Internal-Use OnlyDetermines whether the specified repository item permissions exist./repository/items/{itemId}/permissions
patch
Update the repository item permissions
Internal-Use OnlyUpdate the repository item permissions./repository/items/{itemId}/permissions
get
Get the repository item owner
Internal-Use OnlyReturns the repository item owner./repository/items/{itemId}/owner
head
Determine whether the specified repository item owner exists
Internal-Use OnlyDetermines whether the specified repository item owner exists./repository/items/{itemId}/owner
put
Update the repository item owner
Internal-Use OnlyUpdate the repository item owner./repository/items/{itemId}/owner
get
Get the list of versions attached to the fileId
Internal-Use OnlyReturns the version history for the specified file./repository/items/{fileId}/versions
get
Get the specified version of the file with the matching ID
Internal-Use OnlyReturns the specified version of the specified file./repository/items/{fileId}/versions/{fileVersion}
get
Download specific repository file version content
Internal-Use OnlyDownloads the content of a specific version of a repository file. The content is returned as a stream on the response body./repository/items/{fileId}/versions/{fileVersion}/content

Membership

The operations for managing context membership.
get
Get the membership of a repository item
Internal-Use OnlyReturns the membership of a repository item./memberships/{membershipId}
head
Determine whether the specified context membership exists
Internal-Use OnlyDetermines whether the specified context membership exists./memberships/{membershipId}
get
Get the members of the specified context
Internal-Use OnlyReturns the members of the specified context, which includes assigned users and groups as well as groups explicitly created at the context./memberships/{membershipId}/members
patch
Add or remove members from a context
Internal-Use OnlyAdds or removes members from a context./memberships/{membershipId}/members
get
Get the users and groups that can be assigned to the membership of the specified context
Internal-Use OnlyReturns the users and groups that can be assigned to the membership of the specified context./memberships/{membershipId}/members/candidates

Roles

The operations for managing roles.
get
Get assigned roles
Internal-Use OnlyReturns the roles assigned at the context./roles
post
Create a new role
Internal-Use OnlyAdds a new role./roles
get
Get unassigned roles
Internal-Use OnlyReturns roles that are assigned at the parent context. These unassigned roles can be added as inherited roles./roles/unassigned
post
Create one or more inherited roles
Internal-Use OnlyCreates one or more inherited roles at the context from roles assigned at the parent context./roles/inherited
get
Get the specified role
Internal-Use OnlyReturns role by ID./roles/{roleId}
head
Determine whether the specified role exists
Internal-Use OnlyCheck whether the specified role exists./roles/{roleId}
patch
Update the attributes of a role
Internal-Use OnlyUpdates the editable attributes of this role./roles/{roleId}
delete
Delete a role
Internal-Use OnlyDeletes a role. If this is the original role definition (where the role was created), and it was assigned at any context below the current context, those inherited role assignments are also deleted./roles/{roleId}
get
Get the members of the specified role
Internal-Use OnlyReturns members of the role by ID./roles/{roleId}/members
patch
Update the members of a role
Internal-Use OnlyUpdates the members of the role./roles/{roleId}/members
get
Get candidate members for role
Internal-Use OnlyReturns the users and groups that can be assigned to the role./roles/{roleId}/members/candidates
get
Get the privileges of the specified role
Internal-Use OnlyReturns the privileges of the role by ID./roles/{roleId}/privileges
patch
Update the privileges for a role
Internal-Use OnlyUpdates the privileges of the role./roles/{roleId}/privileges
get
Get all privileges
Internal-Use OnlyReturns all privileges that can be defined to a role./roles/privileges

Groups

The operations for managing groups.
get
Get groups
Internal-Use OnlyReturns the groups assigned to the context./groups
post
Create a group
Internal-Use OnlyCreates a group./groups
get
Get the specified group
Internal-Use OnlyReturns the group by ID./groups/{groupId}
head
Determine whether the specified group exists
Internal-Use OnlyChecks whether the group exists./groups/{groupId}
patch
Update group attributes
Internal-Use OnlyUpdates the attributes of a group./groups/{groupId}
delete
Delete a group
Internal-Use OnlyDeletes a group./groups/{groupId}
get
Get assigned group members
Internal-Use OnlyReturns the members that are assigned to a group./groups/{groupId}/members
patch
Update Group Members
Internal-Use OnlyAdds or removes members from a group./groups/{groupId}/members
get
Get the users and groups that can be assigned as members to the specified group
Internal-Use OnlyReturns the users and groups that can be assigned as members to the specified group./groups/{groupId}/members/candidates

Workspace

The operations for managing the current user workspace.
post
Update the file with the specified path
Internal-Use OnlyUpdate the file with the specified path./workspaces/@currentUser/files
get
Get the workspace item with the specified path
Internal-Use OnlyRetrieves the workspace item with the specified path./workspaces/@currentUser/items
head
Determine whether the workspace item with the specified path exists
Internal-Use OnlyChecks whether the workspace item with the specified path exists./workspaces/@currentUser/items
post
Create a folder at the specified path with the specified name
Internal-Use OnlyCreates a folder at the specified path with the specified name./workspaces/@currentUser/folders
post
Download workspace item content
Internal-Use OnlyDownloads one or more workspace items as defined by the paths specified in the request body. Paths can be to files or folders. If a single path is specified and it is to a file, that file is downloaded as a stream on the response. If it is a single path and it is to a folder or if multiple paths are provided, the items are downloaded to a ZIP file and returned as a stream on the response. For folders, all child items are downloaded to the ZIP file./workspaces/@currentUser/items/content

Clinical Workflow

The operations for managing clinical workflows.
get
Get clinical workflow definitions
Internal-Use OnlyReturns clinical workflow definitions defined with the specified repository context type./workflowDefinitions
get
Get clinical workflows
Internal-Use OnlyReturns clinical workflows defined at repository contexts to which the current user has read access./workflows
post
Create a clinical workflow
Internal-Use OnlyCreates a clinical workflow./workflows
get
Asynchronously update one or more clinical workflows
Internal-Use OnlyReturns a representation of the clinical workflow./workflows/{workflowId}
head
Determine whether the specified clinical workflow exists
Internal-Use OnlyChecks whether the clinical workflow exists./workflows/{workflowId}
patch
Update the specified clinical workflow
Internal-Use OnlyUpdates the editable attributes of this clinical workflow./workflows/{workflowId}
delete
Delete a clinical workflow
Internal-Use OnlyDeletes a clinical workflow./workflows/{workflowId}
get
Get the element setup for a specific clinical workflow
Internal-Use OnlyReturns workflow component information for a clinical workflow. This includes all items that have setup data that can be configured for the workflow -- user tasks, timers, clinical job tasks, notifications, and signal events./workflows/{workflowId}/elementdefinitions
get
Get an element setup for a specific clinical workflow
Internal-Use OnlyReturns workflow component information for a clinical workflow element. These can include user tasks, timers, clinical job tasks, notifications, and signal events./workflows/{workflowId}/elementdefinitions/{elementId}
head
Determine whether the specified clinical workflow element exists
Internal-Use OnlyChecks whether the clinical workflow element exists./workflows/{workflowId}/elementdefinitions/{elementId}
patch
Update the specified clinical workflow element
Internal-Use OnlyUpdates the specified clinical workflow element with the values specified./workflows/{workflowId}/elementdefinitions/{elementId}
get
Get the current elements of a clinical workflow
Internal-Use OnlyReturns the current active flow elements of the specified clinical workflow. Current element types could be -- user tasks, timers, clinical job tasks, notifications, and signal events./workflows/{workflowId}/currentElements
get
Get the completed elements of a clinical workflow
Internal-Use OnlyReturns the completed active flow elements of the specified clinical workflow. Completed element types could be -- user tasks, timers, clinical job tasks, notifications, and signal events./workflows/{workflowId}/completedElements
get
Get details for a completed user task
Internal-Use OnlyReturns full details for a completed user task./workflows/{workflowId}/completedTasks/{taskId}
get
Get clinical tasks
Internal-Use OnlyReturns clinical tasks/workflowTasks
get
Get the specified clinical task
Internal-Use OnlyReturns a representation of the clinical task./workflowTasks/{taskId}
head
Determine whether the specified clinical task exists
Internal-Use OnlyChecks whether the clinical task exists./workflowTasks/{taskId}
patch
Update the specified clinical task
Internal-Use OnlyUpdates the specified clinical task with the values specified./workflowTasks/{taskId}
put
Assign the specified clinical task
Internal-Use OnlyAssigns the specified user to the clinical task./workflowTasks/{taskId}/assignments
post
Complete the specified clinical task
Internal-Use OnlyCompletes the clinical task./workflowTasks/{taskId}/completedTask
put
Start the specified clinical task
Internal-Use OnlyStarts the clinical task./workflowTasks/{taskId}/startedTasks