Platform

Changes to REST API

New extensions to the REST API.

Filter Set Cache Refresh

When using an OAuth 2.0 access token to authenticate API requests, the API uses cached filter set information —information about objects which the authenticated user can access according to the filter set assigned to that user— to optimize performance. By default, read requests using a valid access token do not include objects created after the access token was issued, even if the user can access the new objects in the UI. If new objects are expected, you can clear and regenerate the cached filter set information by sending a POST request to the filter set cache refresh endpoint.

To clear and regenerate the filter set cache, send the following POST request to the filter set cache refresh endpoint. Replace <account-id> in the following sample code with your account-specific domain. For more information about your account-specific domain, see Your Account URLs.

POST /rest/v1/session/cache/refresh HTTP/1.1
Host: <account-domain>
Content-Type: application/json
Authorization: Bearer <OAuth2_access_token>

{"filterSet": true}

Subsequent GET requests to resource endpoints return the latest available data including any objects that were created recently.

Important:

Use requests to the filter set cache refresh endpoint sparingly to avoid performance deterioration. After you send a request to the filter set cache refresh endpoint, you should not send any further request to this endpoint unless you expect objects created after the filter set information cache was last generated in the response.

Each access token scope has its own filter set caching mechanism. If using the same access token with the REST, XML and SOAP API in your integration, clearing the cache for REST API requests does not clear the cache for XML API and SOAP API requests.

For more information, see Filter Set Cache Refresh.

New Resource Endpoints and Methods

The following resource is available: ThreadedMessage – See Threaded Messages and ThreadedMessage object properties.

Note:

Threaded message records are messages posted by an employee about an object of a supported type. Currently, the only supported type in the SuiteProjects Pro is Project. For a description of threaded messages in the SuiteProjects Pro UI, see Project Discussions.

The following endpoints and methods are available:

POST /projects/{id}/threaded-messages/ – See Insert a Project Discussion Message
GET /projects/{id}/threaded-messages/ – See Get the List of Project Discussion Messages
PUT /projects/{id}/threaded-messages/{messages_id} – See Update a Project Discussion Message
DELETE /projects/{id}/threaded-messages/{messages_id} – See Delete a Project Discussion Message

Extended Coverage for Referenced Objects and Expansion Feature

The Referenced Objects and Expansion feature can be used to expand the name of the referenced assignment groups assigned to a project task. The expand parameter now supports the object attributes listed in the following table. For more information about the expansion feature, see Referenced Objects and Expansion.

Main response object	Attribute	Referenced object type
`ProjectTask`	`assignedGroups`	`projectGroupDisplayName`

Main response object

Attribute

Referenced object type

ProjectTask

assignedGroups

projectGroupDisplayName

New Object Properties

The following object properties are now available. See ProjectTask Object Properties and User object properties.

Object type	Property	Description
`ProjectTask`	`assignedGroups`	The assignment groups assigned to this task. Array of internal IDs for assignment group objects.
`ProjectTask`	`assignedUsers`	The users directly assigned to this task. Excludes users assigned to the task as part of an assignment group only. Array of internal IDs for user objects.
`User`	`displayName`	The display name of the user, formatted as `<first name> <last name>`, where `<first name>` is the user's first name [`firstName`] and `<last name>` is the user's last name [`lastName`].

Object type

Property

Description

ProjectTask

assignedGroups

The assignment groups assigned to this task. Array of internal IDs for assignment group objects.

ProjectTask

assignedUsers

The users directly assigned to this task. Excludes users assigned to the task as part of an assignment group only. Array of internal IDs for user objects.

User

displayName

The display name of the user, formatted as <first name> <last name>, where <first name> is the user's first name [firstName] and <last name> is the user's last name [lastName].

Changes to SOAP API and XML API

Clear the filter set cache when using OAuth 2.0 access token to authenticate a read request.

Set the clear_filter_cache attribute to 1 to clear the filter set cache and read the latest available data including any objects that were created recently.

Important:

Use the clear_filter_cache attribute sparingly to avoid performance deterioration. After you use the attribute in a read request, you should not use it again in subsequent read requests unless you expect objects created after the filter set information cache was last generated in the response.

Each access token scope has its own filter set caching mechanism. If using the same access token with the REST, XML and SOAP API in your integration, clearing the cache for XML API requests does not clear the cache for REST API and SOAP API requests.

For more information about reading objects using the SOAP API and XML API, see Reading Objects and Read Attributes.