HTTP Method Mappings - EcoSys - Customization & Programming - Hexagon PPM

EcoSys Web Service API Usage Documentation

Language
English (United States)
Product
EcoSys
Search by Category
Customization & Programming
EcoSys Version
9.0

The HTTP method will be taken from the HTTP request itself. Alternatively, for write requests, The HTTP method can be overridden by specifying a URL parameter "_method", with valid values of "POST", "PUT", "PATCH", or "DELETE".

The following tables explains the mapping of HTTP and API methods.

HTTP Method

API Method

Rule Description

GET

Read

Read data based on provided parameters, does not change existing objects

POST

CreateOrUpdate

Update existing objects or create those that are not found

PUT

Create

Create new objects always, do not change existing objects

DELETE

Delete

Delete objects based on provided identifier(s)

PATCH *

Update

Update existing matching objects only

* This mode must be specified as "_method=PATCH" URL parameter, see below.

The HTTP method will be taken from the HTTP request itself. Alternatively, for write requests, you can override the HTTP method by specifying a URL parameter "_method", with valid values of "POST", "PUT", "PATCH", or "DELETE".

The "_method" parameter is not supported for "GET" HTTP requests, which are always only reads.

For example, to invoke an update-only write operation, add this URL parameter and submit the data through a POST method:

http://.../?_method=PATCH

API runtime parameters, if any are defined for the given API, are passed in using the defined syntax. Refer to Rest and SOAP Parameters and Options.