RestApiCategories.platformAdministration.desc

platform_administration

Viya_35

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

Projects

Replaces an existing project. Only the name, description, imageUri, and properties fields are editable.

The representation used to update a project.

Update Project

The ETag that was returned from a GET, POST, or PUT request of this project.

If-Match

The identifier of a specific project and MUST exactly match project.id sent in the body of the request.

projectId

Project

The request succeeded. The project was updated.

The ISO8601 date string representing the timestamp of the last update to this project.

Last-Modified

A tag that identifies the current revision of the object.

ETag

Error

application/vnd.sas.error

The request could not be completed. The project name already exists.

The ETag provided does not match the current version of the object.

The ETag was not provided when updating an existing type.

Update project

The representation of a project-related activity. These could be created/modified/deleted events for the project itself, a participant or resource, or a member of the underlying folder.

Activity

A collection of activity representations.

Activity Collection

The list of links to top-level resources and operations available from the root of the API.

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Base Collection

baseCollection

The representation used to create a new participant.

Create Participant

The representation used to create a new project.

Create Project

The representation used to create a new resource.

Create Resource

error

A link to a related operation or resource.

Link

Links to related resources and operations.

Links

Participant

A collection of participant representations.

Participant Collection

Project Collection

Resource

A collection of resource representations.

Resource Collection

The representation of a project role. These specify the level of permissions that participants are granted within a project.

Role

Role Collection

The representation used to update a participant.

Update Participant

The representation used to update a resource.

Update Resource

The action associated with this activity (such as create, update, and delete.).

The URIs of the projects containing the resource that is the target of this activity.

Additional properties that could be specified for the activity type.

The name of the resource that is the target of this activity.

The type of the resource that is the target of this activity.

The URI of the resource that is the target of this activity.

The date and time that the activity was triggered.

The authenticated user that triggered the activity.

The version number of the API representation. This is version 1.

application/vnd.sas.api

A space-delimited list of media types from which an `Accept` header may be constructed.

If populated indicates the number of items in the collection.

The number of items that were requested for the collection.

The zero-based index of the first item in the collection.

The version number of the collection representation. This representation is version 2.

The URI of the participant. This must be a valid URI pointing to a user or group from the Identities service.

The role of the participant in the project.

URI to image used as the project avatar.  If a URI is not supplied on a POST request, then a default URI is substituted.  Null or blank values are allowed on a PUT request.

Additional properties that could be specified for the project.

Additional properties that could be specified for the resource.

The URI of the item that the resource represents.

Messages that provide additional details about the cause of the error.

A message that describes how to resolve the error.

The version number of the error representation. This representation is version 2.

If this is a link to a container, `itemType` is the media type or link type for the items in the container.

The relationship of the link to the resource.

The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type for the link.

The participant avatar URI.  This attribute is read-only and is obtained from the Identities service.  This attribute cannot be used in a filter query.

The timestamp of the participant object's creation.

The identifier of a specific participant.

The user who last updated this participant.

The timestamp of the last participant object modification.

The name of the participant.  This attribute is read-only and is obtained from the Identities service.  This attribute cannot be used in a filter query.

The type of participant from the Identities service. This attribute is read-only and is obtained from the Identities service.  This attribute cannot be used in a filter query.

The array of participant representations.

URI of the project's folder.  This is a read-only property.

The number of participants in the project with type 'group'.  This is a read-only property.

The timestamp of the last project modification.

The number of participants in the project with type 'user'.  This is a read-only property.

Resource object type. This should match a type from the Types service. This attribute is read-only and is obtained from the target object if possible.  This attribute cannot be used in a filter query.

The timestamp of the resource object's creation.

Description of the resource object. This attribute is read-only and is obtained from the target object if possible.  This attribute cannot be used in a filter query.

Error message returned by the resourceUri. This is a read-only property.

The timestamp of the last resource object modification.

Name of the resource object. This attribute is read-only and is obtained from the target object if possible.  This attribute cannot be used in a filter query.

HTTP status code returned by the resourceUri. This is a read-only property.

SAS Developers

Returns a list of links to the top-level collections through the API.  HEAD is also supported and returns status and headers only.

The request was invalid. The service is not available.

Returns 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.

The offset of the first activity to return. The default is 0.

start

Maximum number of activities to return. The default is 20.

limit

The criteria for filtering the activities. See [Filtering in REST APIs](https://developer.sas.com/apis/rest/Topics/#filters).

filter

The criteria for sorting the activities. See [Sorting in REST APIs](https://developer.sas.com/apis/rest/Topics/#sorting).

sortBy

Return activities with the specified resourceUri.

resourceUri

To get activities occurred since the timestamp.

since

Returns 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.

The desired project representation. If no Accept-Item is specified, application/vnd.sas.project.summary items are returned.

Accept-Item

The offset of the first project to return. The default is 0.

The maximum number of projects to return. The default is 20.

The criteria for filtering the projects. See [Filtering in REST APIs](https://developer.sas.com/apis/rest/Topics/#filters).

The criteria for sorting the projects. See [Sorting in REST APIs](https://developer.sas.com/apis/rest/Topics/#sorting).

Return projects containing only a resource with the specified resourceUri. This should be the URI of the underlying resource object itself and not the vnd.sas.project.resource object's URI.

Return projects containing only a participant with the specified identityUri. This should be the URI of the actual user or group object from the Identities service.

identityUri

The request succeeded. The list of projects was returned.

The request was invalid. An invalid filter or combination of request parameters was provided.

Creates 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.

This endpoint is used when the "Projects" folder has been deleted from the Folder service by an administrator. All of the projects need to be restored. Restarting the projects service restores the "Projects" folder, but not all the folders that were in it prior to deletion. This end point restores these folders.

Synchronizes a projects database with folders.

The 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.

If true, the underlying folder and all its content is not deleted. The default is false.

keepFolder

Returns the specified project.  HEAD is also supported and returns status and headers only.

Returns 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.

The request succeeded. The project activities were returned.

Returns 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.

The offset of the first participant to return. The default is 0.

Maximum number of participants to return. The default is 20.

The criteria for filtering the participants. See [Filtering in REST APIs](https://developer.sas.com/apis/rest/Topics/#filters).

The criteria for sorting the participants. See [Sorting in REST APIs](https://developer.sas.com/apis/rest/Topics/#sorting).

Adds 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).

A tag that identifies this revision of this object.

The request could not be completed. The URI already exists as a participant of this project.

Removes 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.

participantId

The request was invalid. Cannot delete the last owner. A project must have at least one owner.

The project or participant does not exist.

Returns the specified participant.  HEAD is also supported and returns status and headers only.

The request succeeded. The project participant was returned.

The ISO8601 timestamp representing the last time this participant was updated.

Replaces an existing project participant.

The ETag that was returned from a GET, POST, or PUT of this object.

The request succeeded. The participant was updated.

The ISO8601 date string representing the timestamp of the last update to this participant.

Returns 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.

The offset of the first resource to return. The default is 0.

Maximum number of resources to return. The default is 20.

The criteria for filtering the resources. See [Filtering in REST APIs](https://developer.sas.com/apis/rest/Topics/#filters).

The criteria for sorting the resources. See [Sorting in REST APIs](https://developer.sas.com/apis/rest/Topics/#sorting).

The request succeeded. The project resources were returned.

Adds 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).

The request could not be completed. The URI already exists as a resource of this project.

Removes the specified resource from the project. <b>This does not delete the target resource.</b> 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.

resourceId

Returns the specified resource.  HEAD is also supported and returns status and headers only.

The request succeeded. The project's resource was returned.

The ISO8601 timestamp representing the last time this member was updated.

The request succeeded. The project resource was updated.

The ISO8601 date string representing the timestamp of the last update to this member.

Returns the set of valid roles for participants of a project. The media type of the returned collection items is application/vnd.sas.project.role. Default sorting for this collection is name:ascending.  HEAD is also supported and returns status and headers only.

The offset of the first role to return. The default is 0.

Maximum number of roles to return. The default is 20.

The request succeeded. The set of valid roles for participants of a project was returned.

Status	Meaning	Description
200	OK	The request succeeded. The project was updated.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	The project does not exist.		Schema
409	Conflict	The request could not be completed. The project name already exists.		Schema
412	Precondition Failed	The ETag provided does not match the current version of the object.		Schema
428	Precondition Required	The ETag was not provided when updating an existing type.		Schema

Update project

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses

Name	Type	Required	Description
name	string	true	The identifier of a specific project.
description	string	false	The project's description.
imageUri	string<uri>	false	URI to image used as the project avatar. If a URI is not supplied on a POST request, then a default URI is substituted. Null or blank values are allowed on a PUT request.
properties	object	false	Additional properties that could be specified for the project.
version	integer	false	The version of the object.
id	string<object-id>	false	The identifier of a specific project.