SAS Clinical Acceleration Repository

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

Root

The operations for the root resource.

Get the links for the API

Internal-Use OnlyReturns the links to the top-level resources for the API.

Get the headers for the API

Internal-Use OnlyReturns the headers for the API. Also determines whether the service provided by the API is available.

Audit

The operations for audit history.

Get the collection of audit entries

Internal-Use OnlyReturns a collection of audit entries. The default sort is timestamp:ascending:primary. Requires administrative privileges.

Get the specified audit entry

Internal-Use OnlyReturns the specified audit entry. Requires administrative privileges.

/audit/entries/{entryId}

Determines whether the specified audit entry exists

Internal-Use OnlyChecks whether the specified audit entry exists. Requires administrative privileges.

/audit/entries/{entryId}

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.

Repository

The operations for repository management.

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

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 the collection of repository items

Internal-Use OnlyReturns the collection of repository items by query.

/repository/items

Get the specified repository item

Internal-Use OnlyReturns the specified repository item.

/repository/items/{itemId}

Determine whether the specified repository item exists

Internal-Use OnlyChecks whether the specified repository item exists.

/repository/items/{itemId}

Update the attributes of a repository item

Internal-Use OnlyUpdates the editable attributes of this repository item.

/repository/items/{itemId}

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 the children of the specified repository item

Internal-Use OnlyReturns the children of the specified repository item.

/repository/items/{itemId}/children

Determine whether the specified repository item has children

Internal-Use OnlyChecks whether the specified repository item has children.

/repository/items/{itemId}/children

Create a new repository container

Internal-Use OnlyCreate a new repository context or folder.

/repository/items/{itemId}/children

Download repository content

Internal-Use OnlyDownloads repository content and returns the stream on the response body.

/repository/items/{itemId}/content

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 the repository item permissions

Internal-Use OnlyReturns the repository item permissions.

/repository/items/{itemId}/permissions

Determine whether the specified repository item permissions exist

Internal-Use OnlyDetermines whether the specified repository item permissions exist.

/repository/items/{itemId}/permissions

Update the repository item permissions

Internal-Use OnlyUpdate the repository item permissions.

/repository/items/{itemId}/permissions

Get the repository item owner

Internal-Use OnlyReturns the repository item owner.

/repository/items/{itemId}/owner

Determine whether the specified repository item owner exists

Internal-Use OnlyDetermines whether the specified repository item owner exists.

/repository/items/{itemId}/owner

Update the repository item owner

Internal-Use OnlyUpdate the repository item owner.

/repository/items/{itemId}/owner

Get the list of versions attached to the fileId

Internal-Use OnlyReturns the version history for the specified file.

/repository/items/{fileId}/versions

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}

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

Types

The operations for types.

Get the collection of types

Internal-Use OnlyReturns a collection of types.

Get the specific type entry

Internal-Use OnlyReturns the specific type entry.

/types/{typeId}

Check whether the specified type exists

Internal-Use OnlyChecks whether the specified type exists.

/types/{typeId}

Membership

The operations for managing context membership.

Get the membership of a repository item

Internal-Use OnlyReturns the membership of a repository item.

/memberships/{membershipId}

Determine whether the specified context membership exists

Internal-Use OnlyDetermines whether the specified context membership exists.

/memberships/{membershipId}

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

Add or remove members from a context

Internal-Use OnlyAdds or removes members from a context.

/memberships/{membershipId}/members

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 assigned roles

Internal-Use OnlyReturns the roles assigned at the context.

Create a new role

Internal-Use OnlyAdds a new role.

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

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 the specified role

Internal-Use OnlyReturns role by ID.

/roles/{roleId}

Determine whether the specified role exists

Internal-Use OnlyCheck whether the specified role exists.

/roles/{roleId}

Update the attributes of a role

Internal-Use OnlyUpdates the editable attributes of this role.

/roles/{roleId}

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 the members of the specified role

Internal-Use OnlyReturns members of the role by ID.

/roles/{roleId}/members

Update the members of a role

Internal-Use OnlyUpdates the members of the role.

/roles/{roleId}/members

Get candidate members for role

Internal-Use OnlyReturns the users and groups that can be assigned to the role.

/roles/{roleId}/members/candidates

Get the privileges of the specified role

Internal-Use OnlyReturns the privileges of the role by ID.

/roles/{roleId}/privileges

Update the privileges for a role

Internal-Use OnlyUpdates the privileges of the role.

/roles/{roleId}/privileges

Get all privileges

Internal-Use OnlyReturns all privileges that can be defined to a role.

/roles/privileges

Groups

The operations for managing groups.

Get groups

Internal-Use OnlyReturns the groups assigned to the context.

Create a group

Internal-Use OnlyCreates a group.

Get the specified group

Internal-Use OnlyReturns the group by ID.

/groups/{groupId}

Determine whether the specified group exists

Internal-Use OnlyChecks whether the group exists.

/groups/{groupId}

Update group attributes

Internal-Use OnlyUpdates the attributes of a group.

/groups/{groupId}

Delete a group

Internal-Use OnlyDeletes a group.

/groups/{groupId}

Get assigned group members

Internal-Use OnlyReturns the members that are assigned to a group.

/groups/{groupId}/members

Update Group Members

Internal-Use OnlyAdds or removes members from a group.

/groups/{groupId}/members

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