REST.Client.TRESTRequestParameter.Kind
Delphi
property Kind: TRESTRequestParameterKind read FKind write SetKind stored KindIsStored;
C++
__property Rest::Types::TRESTRequestParameterKind Kind = {read=FKind, write=SetKind, stored=KindIsStored, nodefault};
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
property | published | REST.Client.pas REST.Client.hpp |
REST.Client | TRESTRequestParameter |
Description
Specifies the type of this parameter.
The parameter type can take any of the following values of the TRESTRequestParameterKind enumerator:
pkCOOKIE
: Parameter is put into a cookie.pkGETorPOST
: Parameter will be sent as a URL parameter (for GET requests) or as a body parameter (for POST/PUT requests).pkURLSEGMENT
: Parameter will be used as value for a URL segment. A URL segment can be defined in a request's resource path: customer/{ID}. If a URL Segment parameter with a name of "ID", then its value will be replaced for {ID} in the example above.pkHTTPHEADER
: Parameter is put in the request's HTTP header.pkREQUESTBODY
: The parameter value will be used as a request body. If more than one parameter of this kind exists, the request will use a multi-part body.