Consultingwerk.Framework.Http.RestClient

Namespace:

Consultingwerk.Framework.Http

Class

RestClient

Parent classes:

Progress.Lang.Object

Consultingwerk.Framework.Http.RestClient

Inherits:

Progress.Lang.Object

	Purpose: Gets and set the API BaseUrl
	Notes: Typically a value from the "servers" of an OpenAPI specification

Top Method Summary

Options	Name	Purpose
#	AddQueryParameters (ListHttpParameter, character, Object[])	Adds the query parameters
#	AddRequestBody (RequestBuilder, JsonSerializable, character)	Adds the request body
#	OpenEdge.Net.HTTP.IHttpClient BuildClient ()	Builds the client
#	OpenEdge.Net.URI BuildUri (character, ListHttpParameter, ListHttpParameter)	Builds the request URI
#	Progress.Lang.Object ExecuteRequest (IHttpClient, IHttpRequest, Class)	Executes the request
#	Progress.Lang.Object ExecuteRequestExtent (IHttpClient, IHttpRequest, Class)	Executes the request
+	Progress.Lang.Object PerformRequest (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, character)	Performs an API request with bearer authentication
+	Progress.Lang.Object PerformRequest (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, Credentials)	Performs an API request with basic authentication
+	Progress.Lang.Object PerformRequestExtent (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, character)	Performs an API request with bearer authentication
+	Progress.Lang.Object PerformRequestExtent (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, Credentials)	Performs an API request with basic authentication

Top Constructor Summary

	Options	Name	Purpose
	+	RestClient (character)	Constructor for the RestClient class

Top Property Summary

	Options	Name	Purpose
	+	CHARACTER BaseUrl

Method Detail

Top

PROTECTED AddQueryParameters (ListHttpParameter, character, Object[])

Purpose:	Adds the query parameters
Notes:

Parameters:
poQueryParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The query parameters
pcName	CHARACTER
	The name of the parameter
poValues	Progress.Lang.Object
	The values of the parameter

Top

PROTECTED AddRequestBody (RequestBuilder, JsonSerializable, character)

Purpose:	Adds the request body
Notes:

Parameters:
poBuilder	OpenEdge.Net.HTTP.RequestBuilder
	The request builder
poBody	Consultingwerk.JsonSerializable
	The body
pcContentType	CHARACTER
	The content type

Top

PROTECTED OpenEdge.Net.HTTP.IHttpClient BuildClient ()

Purpose:	Builds the client
Notes:

Returns	OpenEdge.Net.HTTP.IHttpClient
	The client instance

Top

PROTECTED OpenEdge.Net.URI BuildUri (character, ListHttpParameter, ListHttpParameter)

Purpose:	Builds the request URI
Notes:

Parameters:
pcPath	CHARACTER
	The path of the request (relative to the BaseUrl)
poPathParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of path parameters
poQueryParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of query parameters
Returns	OpenEdge.Net.URI
	The URI

Top

PROTECTED Progress.Lang.Object ExecuteRequest (IHttpClient, IHttpRequest, Class)

Purpose:	Executes the request
Notes:

Parameters:
poClient	OpenEdge.Net.HTTP.IHttpClient
	The client
poRequest	OpenEdge.Net.HTTP.IHttpRequest
	The request
poResponseType	Progress.Lang.Class
	The type of the response
Returns	Progress.Lang.Object
	The response

Top

PROTECTED Progress.Lang.Object ExecuteRequestExtent (IHttpClient, IHttpRequest, Class)

Purpose:	Executes the request
Notes:

Parameters:
poClient	OpenEdge.Net.HTTP.IHttpClient
	The client
poRequest	OpenEdge.Net.HTTP.IHttpRequest
	The request
poResponseType	Progress.Lang.Class
	The type of the response
Returns	Progress.Lang.Object
	The response

Top

PUBLIC Progress.Lang.Object PerformRequest (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, character)

Purpose:	Performs an API request with bearer authentication
Notes:

Parameters:
poMethod	Consultingwerk.Framework.Http.HttpMethodEnum
	The HttpMethodEnum value
pcPath	CHARACTER
	The path of the request (relative to the BaseUrl)
poBody	Consultingwerk.JsonSerializable
	The body of the request (Serializable object)
pcBodyContentType	CHARACTER
	The content type of the body
poResponseType	Progress.Lang.Class
	The type of the response (ABL Class)
poPathParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of path parameters
poQueryParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of query parameters
poHeaders	Consultingwerk.Framework.Http.ListHttpParameter
	The list of HTTP headers
poCookies	Consultingwerk.Framework.Http.ListHttpParameter
	The list of cookies
pcBearerToken	CHARACTER
	The bearer token
Returns	Progress.Lang.Object
	The response of the Rest API Request

Top

PUBLIC Progress.Lang.Object PerformRequest (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, Credentials)

Purpose:	Performs an API request with basic authentication
Notes:

Parameters:
poMethod	Consultingwerk.Framework.Http.HttpMethodEnum
	The HttpMethodEnum value
pcPath	CHARACTER
	The path of the request (relative to the BaseUrl)
poBody	Consultingwerk.JsonSerializable
	The body of the request (Serializable object)
pcBodyContentType	CHARACTER
	The content type of the body
poResponseType	Progress.Lang.Class
	The type of the response (ABL Class)
poPathParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of path parameters
poQueryParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of query parameters
poHeaders	Consultingwerk.Framework.Http.ListHttpParameter
	The list of HTTP headers
poCookies	Consultingwerk.Framework.Http.ListHttpParameter
	The list of cookies
poCredentials	OpenEdge.Net.HTTP.Credentials
	The credentials
Returns	Progress.Lang.Object
	The response of the Rest API Request

Top

PUBLIC Progress.Lang.Object PerformRequestExtent (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, character)

Purpose:	Performs an API request with bearer authentication
Notes:

Parameters:
poMethod	Consultingwerk.Framework.Http.HttpMethodEnum
	The HttpMethodEnum value
pcPath	CHARACTER
	The path of the request (relative to the BaseUrl)
poBody	Consultingwerk.JsonSerializable
	The body of the request (Serializable object)
pcBodyContentType	CHARACTER
	The content type of the body
poResponseType	Progress.Lang.Class
	The type of the response (ABL Class)
poPathParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of path parameters
poQueryParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of query parameters
poHeaders	Consultingwerk.Framework.Http.ListHttpParameter
	The list of HTTP headers
poCookies	Consultingwerk.Framework.Http.ListHttpParameter
	The list of cookies
pcBearerToken	CHARACTER
	The bearer token
Returns	Progress.Lang.Object
	The response of the Rest API Request

Top

PUBLIC Progress.Lang.Object PerformRequestExtent (HttpMethodEnum, character, JsonSerializable, character, Class, ListHttpParameter, ListHttpParameter, ListHttpParameter, ListHttpParameter, Credentials)

Purpose:	Performs an API request with basic authentication
Notes:

Parameters:
poMethod	Consultingwerk.Framework.Http.HttpMethodEnum
	The HttpMethodEnum value
pcPath	CHARACTER
	The path of the request (relative to the BaseUrl)
poBody	Consultingwerk.JsonSerializable
	The body of the request (Serializable object)
pcBodyContentType	CHARACTER
	The content type of the body
poResponseType	Progress.Lang.Class
	The type of the response (ABL Class)
poPathParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of path parameters
poQueryParameters	Consultingwerk.Framework.Http.ListHttpParameter
	The list of query parameters
poHeaders	Consultingwerk.Framework.Http.ListHttpParameter
	The list of HTTP headers
poCookies	Consultingwerk.Framework.Http.ListHttpParameter
	The list of cookies
poCredentials	OpenEdge.Net.HTTP.Credentials
	The credentials
Returns	Progress.Lang.Object
	The response of the Rest API Request

Constructor Detail

Top

PUBLIC RestClient (character)

Purpose:	Constructor for the RestClient class
Notes:

Parameters:
pcBaseUrl	CHARACTER
	The BaseUrl of the API

Property Detail

Top

PUBLIC CHARACTER BaseUrl

Returns	CHARACTER

info@consultingwerk.de http://www.consultingwerk.de 09.11.2024 18:37:12