Rest and SOAP Parameters and Options - 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 table below provides a list of Rest Parameters and Options, all of which are optional, but is typically included at least to provide the username and password credentials for the call:

Element Name

Type & Values

Description

Available for Rest

Available for SOAP

Example

username

string

EcoSys application username for authentication

Y

Y

http://.../ecosys/api/restxml/Sample/?_username=admin&_password=examplepass

password

string

EcoSys application password for authentication

Y

Y

http://.../ecosys/api/restxml/Sample/?_username=admin&_password=examplepass

pageSize

numerical

The number of rows specified will be returned and a link to the next page will be included in the next response except for the last page.

Since paging option requests returning a large set of data in smaller chunks, it reduces the load and memory usage of the system.

Gateway will make the API call using the specified page size and return all objects into an output file by automatically retrieving the next page until there are no more pages to retrieve. So, the last page will not have a nextPage element, which indicates that there is no data to retrieve.

The following subject areas support paging for API Read option:

  • Cost Object

  • Task

  • Working Forecast Transaction

  • Actual Transaction

  • Version

  • Unit Rate Table

  • Exchange Rate Table &

  • Category Value (Cost Object Category, Task Category, etc.)

Y

N

http://.../ecosys/api/restxml/Sample/?_pageSize=100

Result:

<SampleProjectResult>
<SampleProject>
</SampleProject>

<nextPage>
<![CDATA[http://.../?_pageId=a2b93782-fd47-44d0-9d53f7c81a62c395&_startRow=101&_count=100]]>
</nextPage>
</ SampleProjectResult >

includeMetaData

true | false

Requests <Meta> and <Performance> data in response

Y

Y

http://.../ecosys/api/restxml/Sample/?__includeMetaData=true

Result:
<Performance>
<ElapsedSeconds>0.056</ElapsedSeconds>
<CPUSeconds>0.000</CPUSeconds>
<DatabaseSeconds>0.022</DatabaseSeconds>
<Summary> API GET ‘Sample’ (Sample Spreadsheet)</Summary>
</Performance>

logoutSession

true | false

Terminates the session (logs out) after the request completes

Y

Y

http://.../ecosys/api/restxml/Sample/?__logoutSession=true

logLevel

SUMMARY | FAIL | DETAIL

Requests logging of results in the Batch Job Logging

The following are allowed values:

SUMMARY, FAIL, DETAIL

Y

Y

http://.../ecosys/api/restxml/Sample/?_logLevel=SUMMARY

logTitle

string

(optional) title of batch jog log to create and log to

Y

Y

http://.../ecosys/api/restxml/Sample/?_logLevel=FAIL&_logTitle=Approve+Project

logDebug

INPUT_DATA

set to "INPUT_DATA" to trace all input records in FAIL and DETAIL modes

See Logging Debug Options for details

Y

Y

http://.../ecosys/api/restxml/Sample/?_logLevel=DETAIL&_logDebug=INPUT_DATA