Projects

Loading...
The Projects API provides support for creating projects to group a set of objects, referenced resources, and participants (users or groups).

Projects

Contains the operations for the Project resource.
get
Get projects
Internal-Use OnlyReturns a list of projects. Standard paging, filtering, and sorting options are provided. The media type of the returned collection items is either application/vnd.sas.project.summary (default), or application/vnd.sas.project depending on the Accept-Item header. Default sorting for this collection is name:ascending. HEAD is also supported and returns status and headers only.
/projects
post
Create a new project
Internal-Use OnlyCreates a new empty project. Resources can be added to the project using the /projects/{projectId}/resources endpoint. Participants can be added to the project using the /projects/{projectId}/participants endpoint. Name uniqueness across projects is enforced. Only the name, description, imageUri, and properties fields are editable.
/projects
get
Get project
Internal-Use OnlyReturns the specified project. HEAD is also supported and returns status and headers only.
/projects/{projectId}
put
Update project
Internal-Use OnlyReplaces an existing project. Only the name, description, imageUri, and properties fields are editable.
/projects/{projectId}
delete
Delete project
Internal-Use OnlyThe specified project is deleted along with all participants and resources. If keepFolder=true is not specified, the underlying folder and all its content are deleted also.
/projects/{projectId}

Resources

Contains the operations for a Resource.
get
Get project resources
Internal-Use OnlyReturns a list of project resources. Standard paging, filtering, and sorting options are available. The media type of the returned collection items is application/vnd.sas.project.resource. Default sorting for this collection is name:ascending. HEAD is also supported and returns status and headers only.
/projects/{projectId}/resources
post
Add resource to project
Internal-Use OnlyAdds a new resource reference to the project. If the resource object referenced is already a member of this project, this operation fails with a 409 status (conflict).
/projects/{projectId}/resources
get
Get project resource
Internal-Use OnlyReturns the specified resource. HEAD is also supported and returns status and headers only.
/projects/{projectId}/resources/{resourceId}
put
Update project resource
Internal-Use OnlyReplaces an existing project resource.
/projects/{projectId}/resources/{resourceId}
delete
Remove resource from project
Internal-Use OnlyRemoves the specified resource from the project. This does not delete the target resource. The proper way to delete a resource is to use the resource's persistence service to delete it. That should generate an event that causes the projects service to clean up any members that have that target resource's URI.
/projects/{projectId}/resources/{resourceId}

Participants

Contains the operations for a Participant resource.
get
Get project participants
Internal-Use OnlyReturns a list of project participants. Standard paging, filtering, and options are available. The media type of the returned collection items is application/vnd.sas.project.participant. Default sorting for this collection is name:ascending. HEAD is also supported and returns status and headers only.
/projects/{projectId}/participants
post
Add participant to project
Internal-Use OnlyAdds a new participant to the project. If the participant referenced is already a participant of this project, this operation fails with a 409 status (conflict).
/projects/{projectId}/participants
get
Get project participant
Internal-Use OnlyReturns the specified participant. HEAD is also supported and returns status and headers only.
/projects/{projectId}/participants/{participantId}
put
Update project participant
Internal-Use OnlyReplaces an existing project participant.
/projects/{projectId}/participants/{participantId}
delete
Remove participant from project
Internal-Use OnlyRemoves the specified participant from the project. This does not delete the identity from the Identities service. If the corresponding identity is deleted from the Identity service, an event is generated and any associated participants are deleted. Since a project must have at least one owner, the last owner cannot be deleted. It is possible that the last owner could be removed if the corresponding identity is deleted from the Identities service. The project would be visible only to administrators who can delete the project or add a new owner.
/projects/{projectId}/participants/{participantId}

Activities

Contains the operations for an Activity resource.
get
Get project activities
Internal-Use OnlyReturns a list of project activities. Standard paging, filtering, and options are available. The media type of the returned collection items is application/vnd.sas.project.activity. Default sorting for this collection is timeStamp:ascending. HEAD is also supported and returns status and headers only.
/projects/{projectId}/activities
get
Get activities across all projects
Internal-Use OnlyReturns a list of activities across all projects. Standard paging, filtering, and options are available. The media type of the returned collection items is application/vnd.sas.project.activity. Default sorting for this collection is timeStamp:ascending. HEAD is also supported and returns status and headers only.
/activities