Supported Resources, Methods and API Features
The current scope of the REST API is limited to selected SuiteProjects Pro modules and object types.
The following table summarizes the methods available for supported resources. For more information about the endpoints and methods, see REST API Endpoint Reference.
|
Resources |
|
|
|
|
|
|---|---|---|---|---|---|
|
Attachments (Use the endpoints and methods specific to the object the attachments are associated with) |
|
|
|
|
— |
|
Contacts |
|
|
|
|
|
|
Customers |
— |
|
— |
— |
|
|
Expense reports |
|
|
|
|
|
|
Job codes |
|
|
|
|
|
|
Projects |
|
|
|
|
|
|
Project milestones |
— |
(objects with Task classification set to “Milestone” only) |
— |
— |
— |
|
Project phases |
— |
(objects with Task classification set to “Phase” only) |
— |
— |
— |
|
Project tasks |
(objects with Task classification set to “Task” only) |
(objects with Task classification set to “Task” only) |
— |
— |
— |
|
Published reports* |
— |
|
— |
— |
— |
|
Receipts |
|
|
|
|
|
|
Time entries |
|
|
— |
|
|
|
Users |
— |
|
— |
— |
|
The following table summarizes the API features available for supported resources. It includes two columns for the Expansion feature to show the resource endpoints for which the feature is available, and the referenced objects that can be expanded.
-
For more information about the Filtering feature, see Filtering.
-
For more information about the Pagination feature, see Pagination.
-
For more information about the Sorting feature, see Sorting.
-
For more information about the Expansion feature, see Referenced Objects and Expansion.
|
Resources |
Filtering |
Pagination |
Sorting |
Expansion (Endpoints) |
Expansion (Referenced Objects) |
|---|---|---|---|---|---|
|
Attachments (Use the endpoints and methods specific to the object the attachments are associated with) |
— |
— |
|
|
|
|
Contacts |
|
|
|
— |
— |
|
Customers |
|
|
|
|
— |
|
Expense reports |
|
|
|
|
— |
|
Job codes |
|
|
|
— |
— |
|
Projects |
|
|
|
|
— |
|
Project milestones |
|
|
|
|
— |
|
Project phases |
|
|
|
|
— |
|
Project stages (name only) |
— |
— |
— |
— |
|
|
Project tasks |
|
|
|
|
— |
|
Published reports* |
— |
(Only for rows of report data) |
— |
— |
— |
|
Receipts |
|
|
|
|
— |
|
Time entries |
|
|
|
|
— |
|
Users |
|
|
|
|
— |
|
Users (display name only) |
— |
— |
— |
— |
|
|
Workspaces |
— |
— |
— |
— |
|
* – Published reports are available only if the Business Intelligence (BI) Connector feature is enabled for your account. You can access BI Connector resources even if API access and REST API are not enabled for your account.