Discover Available Methods and Fetch the Endpoint Reference for Users

OPTIONS /users/ — Use this method to discover the methods available and fetch the OpenAPI 3.0 JSON endpoint reference for users.

Parameters

None

Response definitions

A successful request returns the OpenAPI 3.0 JSON endpoint reference in the response body. The JSON object returned contains metadata information about the resource endpoint. It is similar to the Generated API Documentation JSON, only it is restricted to the resource endpoint path specified in the request.

The response also includes the following header:

Header	Description
`Access-Control-Allow-Methods`	A comma-separated list of HTTP methods available for the requested resource collection endpoint.

Header

Description

Access-Control-Allow-Methods

A comma-separated list of HTTP methods available for the requested resource collection endpoint.

Sample request

            OPTIONS /rest/v1/users/ HTTP/1.1
Host: company-id.app.netsuitesuiteprojectspro.com
Authorization: Bearer <OAuth2_access_token>

In the example, <OAuth2_access_token> is the OAuth 2.0 access token obtained for the client application connecting to SuiteProjects Pro. See Authentication.

Sample response

The response includes the OpenAPI 3.0 endpoint reference for the resource endpoint as a JSON object in the response body, as well as the following headers:

            Content-Type: application/json; charset=utf-8
Content-Length: 6955
Connection: keep-alive
Cache-control: no-cache, no-store, pre-check=0, post-check=0, must-revalidate, max-age=0, s-max-age=0
Pragma: no-cache
Expires: 0
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type
Access-Control-Max-Age: 86400
Vary: Accept-Encoding,User-Agent
Content-Encoding: gzip