Request
Task for Frends Platform API related operations.
Task version: 1.2.0
Required Frends version: 5.5+
Required .NET version: 6.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.PlatformApi/tree/main/Frends.PlatformApi.Request
Task Parameters
Method : Methods
Gets or sets HTTP request method.
Possible values:
Get: Gets or sets HTTP request method.Post: Gets or sets HTTP request method.Put: Gets or sets HTTP request method.Patch: Gets or sets HTTP request method.Delete: Gets or sets HTTP request method.
Default: 0
Example: Methods.Get.
Url : String
Gets or sets URL.
Default: -
Example: https://tenant.frendsapp.com/api/v1/api-management/access/api-keys/1.
GeneratedToken : Boolean
Gets or sets a value indicating whether token is generated.
Default: False
Example: false.
ApplicationUri : String
gets or sets Application URI.
Default: -
Example: api://qwe123-rty456-uio789-1p2i-asd9078.
ApplicationId : String
Gets or sets application ID.
Default: -
Example: qwe123-rty456-uio789-1p2i-asd9078.
ClientSecret : String
Gets or sets client secret.
Default: -
Example: 1r2t3y4u5i6o7p8a9s.
🗝Token : String
Gets or sets bearer token.
Default: -
Example: abcd123.
Message : String
Gets or sets message to be sent with the request.
Default: -
Example: { "agentGroupId": 0, "processes": [ { "processGuid": "00000000-0000-0000-0000-000000000000" ...
IsMultipart : Boolean
Gets or sets a value indicating whether multipart is used.
If true, using Content-Type = multipart/form-data instead of application/json.
Default: False
Example: false.
DownloadPath : String
Gets or sets download path where resource will be exported.
Default: -
Example: C:\temp\foo.json.
FilePaths : SendFileParameters[]
Gets or sets array of files to be imported.
Default: -
Example: { {FileParameterKey = FileParameterKey.File, Fullpath = "C:\temp\file.json"} }.
ManualParameters : ManualParameters[]
Gets or sets manual parameters.
No need to add Content-Type, Accept and Authorization headers.
Default: -
Example: { {Key = foo, Value = bar, ParameterType = ParameterTypes.GetOrPost} }.
ThrowExceptionOnError : Boolean
Gets or sets a value indicating whether an error should stop the Task and throw an exception.
If set to true, an exception will be thrown when an error occurs.
If set to false, Task will try to continue and the error message will be added into Result.ErrorMessage and Result.Success will be set to false.
Default: True
Example: true.
Timeout : Int32
Gets or sets timeout in seconds.
Default: -
Example: 10.
Task Result
Success : Boolean
Gets a value indicating whether the Task was executed successfully and without errors.
Example: true.
Data : Object
Gets result data.
Example: {"data":{"id":1,"value":"1-2-3-4-5","modified":"2024-01-25T07:56:27.147","modifier":"user","environment":{"id":51,"displayName":"Development"},"name":"test","rulesetIds":[],"requestLimit":100,"requestLimitPeriod":"Day"}}.
ErrorMessage : Object
Gets error message. This value is generated when an exception occurs and Options.ThrowExceptionOnError is false.
Example: Error occured...
Task Changelog
Changelog for Task Frends.PlatformApi.Request.
[1.2.0] - 2026-01-14
Changed
Rename task to PlatformApi
[1.1.0] - 2025-02-17
Changed
Update package RestSharp from 110.2.0 to 112.1.0
[1.0.0] - 2024-03-18
Changed
Initial implementation
Last updated
Was this helpful?