Frends.PlatformApi.Request / 1.2.0
Summary
Calls the Frends Platform API, the tenant-level interface above individual environments.
Typical use — Processes that administer the tenant itself; the Management API Task is the environment-level counterpart
Input parameters.
| Name | Type | Default | Example | Description |
|---|---|---|---|---|
| Method | Methods |
Get |
Methods.Get. |
Gets or sets HTTP request method. Possible values:
|
| Url | String |
– | https://tenant.frendsapp.com/api/v1/api-management/access/api-keys/1. |
Gets or sets URL. |
| GeneratedToken | Boolean |
False |
false. |
Gets or sets a value indicating whether token is generated. |
| ApplicationUri | String |
– | api://qwe123-rty456-uio789-1p2i-asd9078. |
gets or sets Application URI. |
| ApplicationId | String |
– | qwe123-rty456-uio789-1p2i-asd9078. |
Gets or sets application ID. |
| ClientSecret | String |
– | 1r2t3y4u5i6o7p8a9s. |
Gets or sets client secret. |
| TokenSecret | String |
– | abcd123. |
Gets or sets bearer token. |
| Message | String |
– |
{
"agentGroupId": 0,
"processes": [ {
"processGuid": "00000000-0000-0000-0000-000000000000"
...
|
Gets or sets message to be sent with the request. |
| IsMultipart | Boolean |
False |
false. |
Gets or sets a value indicating whether multipart is used. If true, using Content-Type = multipart/form-data instead of application/json. |
| DownloadPath | String |
– | C:\temp\foo.json. |
Gets or sets download path where resource will be exported. |
| FilePaths | SendFileParameters[] |
– | { {FileParameterKey = FileParameterKey.File, Fullpath = "C:\temp\file.json"} }. |
Gets or sets array of files to be imported. |
| ManualParameters | ManualParameters[] |
– | { {Key = foo, Value = bar, ParameterType = ParameterTypes.GetOrPost} }. |
Gets or sets manual parameters. No need to add Content-Type, Accept and Authorization headers. |