![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
baseHttpUrlForConnection connectionID | |
Returns an base HTTP URL for a certain connection. More... | |
connectTo channelID urlSuffix args | |
HTTP client call to a URL defined by a communication channel. More... | |
convertHtmlEntitiesToUniCode string | |
convert HTML code to tcl unicode character More... | |
createBinaryHeader date lastmod contype conlen cdis_fname cencoding | |
This function creates a http header for binary data. More... | |
createFileLinkHeader date lastmod contype conlen cdis_fname cencoding | |
This function creates a http header for binary data. More... | |
createGenericHeader date lastmod contype conlen cdis_fname cencoding statusCode statusMessage args | |
This function creates a generic http header. More... | |
createHeader date lastmod contype conlen cdis_fname cencoding | |
This function creates a http header. More... | |
createWSockRes type data | |
This function creates a websocket protocol response. More... | |
httpdDate seconds | |
create a http date string More... | |
httpdDecodeCGI string | |
decode a string to the URL-encoding More... | |
httpdEncodeCGI string | |
encode a string from the URL-encoding More... | |
httpdSplitQueryString query | |
split a http query string to a tcl-list More... | |
httpdStatusMessage statusCode | |
retrieves the HTTP status message given a HTTP status code More... | |
setAttaLink link dname | |
This function create a attachment link for a logfile. More... | |
tcl2html data | |
convert tcl-script code to HTML More... | |
XMLAppendB64Arg tag value args | |
This function create a B64 text tag. More... | |
XMLAppendCLNArg tag value args | |
This function create a clear text tag. More... | |
XMLResFooter args | |
This function create a default XML footer. More... | |
XMLResHeader args | |
This function create a default XML header. More... | |
TPHAP::baseHttpUrlForConnection | connectionID | ||
Returns an base HTTP URL for a certain connection.
connectionID | id of the connection to get a base URL for |
Returns an URL in the format of <protocol>://<host>:<port> for the given connection ID. Throws an exception if the transport of the connection is not set to HTTP or HTTPS.
Referenced by TPHAP::connectTo().
TPHAP::connectTo | channelID urlSuffix args | ||
HTTP client call to a URL defined by a communication channel.
channelID | id of the communication channel to get the base URL and further connection information (e.g. certificates) from |
urlSuffix | remaining URL information that will be attached to the determined base URL |
-user | (optional) username for authentication |
-password | (optional) password for authentication |
-agent | (optional) change the client agent name |
-extendHeaderBy | (optional) extend header by further data passed as name value list |
-connectionTimeoutInSec | (optional) client connection timeout in seconds |
-timeoutInSec | (optional) request timeout in seconds |
-httpMethod | (optional) HTTP method do be used: POST, PUT, DELETE or GET (default). POST and PUT require the -payload parameter additionally. |
-payload | (required for POST and PUT HTTP method) Payload to be passed via POST or PUT HTTP method. |
-hexEncoded | (optional) true to return the result hex encoded. |
-includeHeader | (optional) true to include the HTTP response header in the result as [list <payload> <http-header>] |
This function can be used to call a URL from PL4x (also see tpco_httpClient) where the configuration has already been provided in the communication channels settings. After determining the needed configuration (e.g. certificates) and the base URL, the urlSuffix is added and the resulting URL called. The function returns the result of the webservice or an exception.
References TPHAP::baseHttpUrlForConnection(), and tpco_httpClient().
TPHAP::convertHtmlEntitiesToUniCode | string | ||
convert HTML code to tcl unicode character
string | : the html code string |
TPHAP::createBinaryHeader | date lastmod contype conlen cdis_fname cencoding | ||
This function creates a http header for binary data.
date | : Date attribute (default= "" <- internal fill) |
lastmod | : Last-Modified attribute (default= "" <- internal fill) |
contype | : Content-Type attribute (default= "" <- text/html; charset=utf-8) |
conlen | : Connection attribute, content size in byte (default= "" <- close) |
cdis_fname | : filename for download (default= "" <- internal fill) |
cencoding | : Content-Transfer-Encoding attribute (default= "" <- not set) |
References TPHAP::createHeader(), and tpco_scanHEX16().
TPHAP::createFileLinkHeader | date lastmod contype conlen cdis_fname cencoding | ||
This function creates a http header for binary data.
date | : Date attribute (default= "" <- internal fill) |
lastmod | : Last-Modified attribute (default= "" <- internal fill) |
contype | : Content-Type attribute (default= "" <- text/html; charset=utf-8) |
conlen | : Connection attribute, content size in byte (default= "" <- close) |
cdis_fname | : filename for download (default= "" <- internal fill) |
cencoding | : Content-Transfer-Encoding attribute (default= "" <- not set) |
References TPHAP::createHeader(), and tpco_scanHEX16().
TPHAP::createGenericHeader | date lastmod contype conlen cdis_fname cencoding statusCode statusMessage args | ||
This function creates a generic http header.
date | : Date attribute (default= "" <- internal fill) |
lastmod | : Last-Modified attribute (default= "" <- internal fill) |
contype | : Content-Type attribute (default= "" <- text/html; charset=utf-8) |
conlen | : Connection attribute, content size in byte (default= "" <- close) |
cdis_fname | : filename for download (default= "" <- internal fill) |
cencoding | : Content-Transfer-Encoding attribute (default= "" <- not set) |
statusCode | : the http status code |
statusMessage | : the http status message |
args | : additional http headers |
Common use in a PXML call.
References TPHAP::httpdDate(), and TPHAP::httpdStatusMessage().
TPHAP::createHeader | date lastmod contype conlen cdis_fname cencoding | ||
This function creates a http header.
date | : Date attribute (default= "" <- internal fill) |
lastmod | : Last-Modified attribute (default= "" <- internal fill) |
contype | : Content-Type attribute (default= "" <- text/html; charset=utf-8) |
conlen | : Connection attribute, content size in byte (default= "" <- close) |
cdis_fname | : filename for download (default= "" <- internal fill) |
cencoding | : Content-Transfer-Encoding attribute (default= "" <- not set) |
Common use in a PXML call.
References TPHAP::httpdDate().
Referenced by TPHAP::createBinaryHeader(), TPHAP::createFileLinkHeader(), BatchSWA::WASDisableJobServerBackend(), BatchSWA::WASDisableJobServerFrontend(), BatchSWA::WASEnableJobServerBackend(), BatchSWA::WASEnableJobServerFrontend(), BatchSWA::WASGetJobServerBackendStatus(), and BatchSWA::WASGetJobServerFrontendStatus().
TPHAP::createWSockRes | type data | ||
This function creates a websocket protocol response.
type | : BIN or TXT |
data | : the message data |
References tpco_scanHEX16().
TPHAP::httpdDate | seconds | ||
create a http date string
seconds | :: c-time |
Referenced by TPHAP::createGenericHeader(), and TPHAP::createHeader().
TPHAP::httpdDecodeCGI | string | ||
decode a string to the URL-encoding
string |
TPHAP::httpdEncodeCGI | string | ||
encode a string from the URL-encoding
string |
Referenced by TPHAP::httpdSplitQueryString().
TPHAP::httpdSplitQueryString | query | ||
split a http query string to a tcl-list
query | :: the http query string |
References TPHAP::httpdEncodeCGI().
TPHAP::httpdStatusMessage | statusCode | ||
retrieves the HTTP status message given a HTTP status code
statusCode | : the http status code |
Referenced by TPHAP::createGenericHeader().
TPHAP::setAttaLink | link dname | ||
This function create a attachment link for a logfile.
link | the link-ID of the attachment (see tpco_udpWriteRemoteAttachment2) |
dname | link name (description) |
create a smal XML document with a text tag.
Referenced by T4X::CORE::writeLogLineWithAttachment2BGS().
TPHAP::tcl2html | data | ||
convert tcl-script code to HTML
data | : the tcl code string |
TPHAP::XMLAppendB64Arg | tag value args | ||
This function create a B64 text tag.
create a smal XML document with a B64 tag.
TPHAP::XMLAppendCLNArg | tag value args | ||
This function create a clear text tag.
create a smal XML document with a text tag.
TPHAP::XMLResFooter | args | ||
This function create a default XML footer.
TPHAP::XMLResHeader | args | ||
This function create a default XML header.
create a smal XML document