Create a thread dump

URL Pattern	/manage/system/info/threaddump
Method	GET
Parameters
Content types
Returns	a thread dump from the current server

Request:

curl -u rest:heiler -X GET http://localhost:1501/rest/V1.0/manage/system/info/threaddump

Response:

a thread dump in a common format which can be read by automated systems like fastthread.io

Create thread dumps for all servers

URL Pattern	/manage/system/info/threaddump/allServers
Method	GET
Parameters
Content types
Returns	a zip containing a thread dump for every server

Request:

curl -u rest:heiler -X GET http://localhost:1501/rest/V1.0/manage/system/info/threaddump/allservers

Response:

a zip with thread dumps in a common format which can be read by automated systems like fastthread.io

Echo Text

Simple function to test server availability, authentication and correct charset/encoding use.

URL Pattern	/manage/system/echo/{echoText}
Method	GET
Parameters	`echoText:` the text string which get echoes back.
Content types	application/json
Returns	the given echoText with the server internal charset/encoding.

Example:

Request:

curl -u rest:heiler -H "Accept: application/json" -X GET http://localhost:1501/rest/V1.0/manage/system/echo/helloWorld

Response:

helloWorld

Create token for Token Basic Authentication

Creates a token, which can be used to authenticate, instead of supplying username/password (for further details see chapter REST Service Authentication). The token is generated for the authenticated user of this REST call and is valid for one hour.

URL Pattern	/manage/system/security/token
Method	POST
Parameters	`grant_type`: the type of token. "`authorization_code`" for an access token
Content types	application/json
Returns	A JSON Object, containing: `access-token`: the token `expires-in`: period of validity of th e token (in seconds)

Example:

Request:

POST /rest/V1.0/manage/system/security/token
grant_type: authorization_code

Response:

{
  "access-token": "4ABE78F118D7068322B9A1AEB5B76C385C32777D52FB971FF70593C28CE94C8DB43BD5E7EF4EAB84DA8AE435F231B5F274F3643A2B2527350861E38029A31D5CD826A28D68D70625E8D1F47...",
  "expires-in": 3600
}

Create token for Token Basic Authentication, based on a SAML Response

When using SAML for authentication (see chapter SAML Configuration), a token can by retrieved for the user contained in a SAML Response.

URL Pattern	/manage/system/security/tokenForSaml
Method	POST
Parameters	`grant_type`: the type of token. "`authorization_code`" for an access token `saml_response`: Base64-Encoded SAML 2.0 Response (containing a SAML Assertion)
Content types	application/json
Returns	A JSON Object, containing: `access-token`: the token `expires-in`: period of validity of th e token (in seconds)

The token validity time can be configured via the preference com.heiler.ppm.webservice.server/accessTokenExpirationTime.SAML (in the server's plugin_customization.ini), and is one day by default.

Example:

Request:

POST /rest/V1.0/manage/system/security/tokenForSaml
grant_type: authorization_code
 
saml_response: 28CE94C8DB43BD5E7EF4EAB84DA8AE435F231B5F274F3643A2B2527350861E38029A31D5CD826A28D68D70625E8D1F47FFC79712AEC227AD53818203C0496EB6D38E6BFE4B68E...

Response:

{
  "access-token": "4ABE78F118D7068322B9A1AEB5B76C385C32777D52FB971FF70593C28CE94C8DB43BD5E7EF4EAB84DA8AE435F231B5F274F3643A2B2527350861E38029A31D5CD826A28D68D70625E8D1F47...",
  "expires-in": 86400
}