The Basics
The articles in this section describe an older version of the REST API. We recommend using REST API v3 whenever possible, which follows the latest standards and offers the best experience. For more information, visit REST API v3 Reference.
Review the information in this topic to quickly start working with the Fusion Manage REST API v1.
About the API
The Fusion Manage API is built on REST using resource-oriented URLs and HTTP features such as HTTP methods and HTTP response codes.
API Endpoint
Unless otherwise noted, all v1 API requests are relative to https://{yourtenant}/autodeskplm360.net/api/rest/v1, replacing {yourtenant} with the name of your Fusion Manage tenant. Note that the request protocol is always http
Login and Authentication
For an application to communicate with Fusion Manage through v1 of the API, it must first log in to the tenant to authenticate subsequent requests sent to the server. For detailed help, see Login and Authentication.
REST Operations
| Resource | GET | POST | PUT | DELETE |
|---|---|---|---|---|
Collection, e.g., /api/rest/v1/workspaces |
List the resources in the given collection | Create a new resource in the given collection | Replace the entire given collection | Delete the entire given collection |
Object, e.g., /api/rest/v1/workspaces/1 |
Retrieve the given resource in the collection | N/A | Replace the given resource in the collection | Delete the given resource in the collection |
Request Data
Request data is passed to the API in request headers and objects in the body of the request via HTTP calls made to the resource endpoints with the appropriate parameters. Objects can be passed in either JSON or XML format, and the selected format is indicated by appending .json or .xml to the endpoint, as appropriate, or by sending Content-Type = [application/json|application/xml] in the header of the request.
Documentation for each resource endpoint details the supported HTTP methods, URL and query parameters, and request headers. The documentation also contains the object schema in JSON format for the body of the request (as applicable) and the body of the response. Where possible, example requests and responses are also provided.
null value.HTTP Response Codes
| Status Code | Description |
|---|---|
| 200 OK | Request was successful. Mostly used for GET requests. |
| 201 Created | Resource was created successfully. Endpoint of the created resource returned in Location header. May also return the created resource in the response body. |
| 204 No Content | Request was successful but no content was sent in the response |
| 400 Bad Request | Endpoint cannot understand the request because of a syntax error |
| 401 Unauthorized | Current user does not have required permissions |
| 404 Not Found | Requested resource does not exist |
| 5xx | Server error |