Date: Tue, 19 Mar 2024 12:55:40 +0100 (CET) Message-ID: <716365172.35.1710849340389@wiki.daasi.de.gate> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_34_1991632483.1710849340388" ------=_Part_34_1991632483.1710849340388 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
When an URL is described it never includes the protocol ("https"), the h= ost name ("example.org") a portnumber ("443") or the document root. So if = the following example URL is described in this documentation:
https:/= /example.com/pdp/sessions/75f10c44-6e33-4637-8006-3e432b65b751
it is reduced to this:
/pdp/se= ssions/75f10c44-6e33-4637-8006-3e432b65b751
and has to be extended when actually using this to call the REST API.
When there are variables within the URL these are enclosed by "{" and "}= ". The placeholder inside these curly braces is used as name in the documen= tation and printed italic. So to describe that the ID of the s= ession has to be specified in the URL this would be stated like this:<= /p>
/pdp/se= ssions/{session}
where you would have to replace the "{session}" with an appropriate valu= e for the session's ID session.
When calling the REST API there are some parameters defined as a MUST an= d some parameters defined as a MAY. All MUST= -parameters. If a parameter is defined by the URL that is c= alled and enclosed by curly braces it is always a MUST-parameter. If you ig= nore this you are calling a different URL that might exist but do something= different.