URL
The URL format is shown below.
https://<Server where the L-Platform APIs are running>:<Port number>/cfmgapi/endpoint
The L-Platform APIs all use GET methods or POST methods. For the port number, specify the value that was specified when installing. The default value is "8014". To specify parameters, add a question mark ("?") to the end of the URL path, and then enter the parameters using the following format:
<Parameter name>=<Value>&<Parameter name>=<Value>&...
Example
https://<Server where the L-Platform APIs are running>:<Port number of L-Platform APIs is running> /cfmgapi/endpoint?Version=2.0&Action=ListLPlatform&Locale=en&userId=user1&orgId=div01
With the POST method, a body can be set in the request for execution.
With CLI that call the POST method, specify the path of the file where the XML set in the <BODY> in the -xml parameter is saved.
However, operation may not be correct if there is a BOM in the file.
HTTP header
Specify information for basic authentication in the HTTP header.
Authorization: Basic <String encoding "userId:password" in Base64>
Specify the user ID and password of the user who executes the L-Platform API.
Although the tenant name and the user ID are specified using L-Platform API arguments, ensure you use the user ID specified during basic authentication.
The following example shows the basic authentication information where userId and password have been set to "cfmgapiuser/cfmgapiuser":
Example
Authorization:Basic Y2ZtZ2FwaXVzZXI6Y2ZtZ2FwaXVzZXI=
Ensure you specify content-type headers.
Use "application/xml" unless otherwise specified in the description of each API.
Command interface
A command interface is also provided for each API.
The storage destination of the commands is as follows:
[Windows Manager]
Installation_folder\ROR\RCXCFMG\bin(Stores batch commands and shell scripts) \config(Stores setup files for commands)
[Linux Manager]
/opt/FJSVcfmg/bin(Stores batch commands and shell scripts) /etc/opt/FJSVcfmg/config(Stores setup files for commands)
Refer to "Chapter 14 L-Platform API Related Operations" in the "Reference Guide (Command/XML) CE" for information on the each command.
