Base path: [ENVIRONMENT_URL]/rest/pals
Send "Accept" HTTP header to specify content format. Possible values are "application/xml" for XML format, "application/json" for JSON format, and "text/plain" for text format (where permitted for simple string, boolean, and numeric responses).
Default response format is "application/xml".
Use BASIC authorization.
| Description: | Retrieves a list of pals | |||
| Method: | GET | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/pals | |||
| Parameters: | Name | Type | Source | Description |
| search | PalSearch | Request headers: category description exactCategory exactDescription exactName exactPublisher includeInstalled includeTest matchAny name publisher startRecord |
Optional PalSearch object (created from headers map). | |
| Returns: | List of PalInfo | |||
| Sample: |
GET https://secure.cloudpiston.com/cpservice/rest/pals HTTP/1.1
name: my pal
category: development
startRecord: 100
| |||
| Description: | Retrieves PalInfo object details | |||
| Method: | GET | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/pals/* | |||
| Parameters: | Name | Type | Source | Description |
| id | String | Path element #1 | Pal ID | |
| Returns: | PalInfo | |||
| Sample: |
GET https://secure.cloudpiston.com/cpservice/rest/pals/PAL-LL-118611DE003-4D837E4E HTTP/1.1
| |||
| Description: | Returns a URL containing a single use token to the specified Pal. This URL can be used to authenticate the user and create a new Transaction. | |||
| Method: | POST | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/pals/*/token | |||
| Parameters: | Name | Type | Source | Description |
| palId | String | Path element #1 | Pal ID | |
| userSSO | String | Form parameter userSSO | SSO for user | |
| Returns: | String | |||
| Sample: |
POST https://secure.cloudpiston.com/cpservice/rest/pals/PAL-LL-118611DE003-4D837E4E/token HTTP/1.1
userSSO=SSO-11A4FD35049-30E75B79
or
POST https://secure.cloudpiston.com/cpservice/rest/pals/PAL-LL-118611DE003-4D837E4E/token HTTP/1.1
userSSO=auto
| |||