GET v1/Requests?name={name}
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Scripter
LimitedUser
GlobalDomainManager
DemoUser
Permissions required to make this request:
Requests.Read
Get request configuration by name
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
name | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Response Message
RequestModelName | Description | Type | Additional information |
---|---|---|---|
Id |
The id of the request |
integer |
None. |
Name |
Name of the request used in the *REQUEST command |
string |
Required Max length: 16 |
Description |
Optional description of the request |
string |
Max length: 4096 |
Uri |
Endpoint (URI) of the request |
string |
Required Max length: 1024 |
PayloadTemplate |
The template of the payload |
string |
None. |
RequestHttpMethod |
The method of the request |
RequestHttpMethod |
None. |
HelpUri |
Optional help URI towards extensive documentation for the request |
string |
Max length: 1024 |
Headers |
Collection of headers used when posting the request |
Collection of RequestHeaderModel |
None. |
Response Formats
application/json, text/json
{ "Id": 1, "Name": "sample string 2", "Description": "sample string 3", "Uri": "sample string 4", "PayloadTemplate": "sample string 5", "RequestHttpMethod": 1, "HelpUri": "sample string 6", "Headers": [ { "Id": 1, "RequestId": 2, "IsObfuscated": true, "Name": "sample string 4", "Value": "sample string 5" }, { "Id": 1, "RequestId": 2, "IsObfuscated": true, "Name": "sample string 4", "Value": "sample string 5" } ] }
application/xml, text/xml
<RequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <Description>sample string 3</Description> <Headers> <RequestHeaderModel> <Id>1</Id> <IsObfuscated>true</IsObfuscated> <Name>sample string 4</Name> <RequestId>2</RequestId> <Value>sample string 5</Value> </RequestHeaderModel> <RequestHeaderModel> <Id>1</Id> <IsObfuscated>true</IsObfuscated> <Name>sample string 4</Name> <RequestId>2</RequestId> <Value>sample string 5</Value> </RequestHeaderModel> </Headers> <HelpUri>sample string 6</HelpUri> <Id>1</Id> <Name>sample string 2</Name> <PayloadTemplate>sample string 5</PayloadTemplate> <RequestHttpMethod>GET</RequestHttpMethod> <Uri>sample string 4</Uri> </RequestModel>