...
| Note | ||
|---|---|---|
| ||
For the old Open API Profile used for the REST Server and Client agents in |
...
| Warning | ||
|---|---|---|
| ||
If you have been using the Open API Profile before |
Configuration Tab
Open API Profile Configuration
| Setting | Description | |||||
|---|---|---|---|---|---|---|
| Open API file | Import the OpenAPI specification file from where the desktop client is running. Upon successful import, the contents of the file will be displayed in the box below.
| |||||
| Ignore Read Only Tag | Select this option to ignore the readOnly tag in the specification file.
|
| Note | ||
|---|---|---|
| ||
To refresh the content of the imported API file or the contents of other included files, the imported file will have to be imported once again. |
| Note | ||
|---|---|---|
| ||
|
View Included Files Tab
| Setting | Description |
|---|---|
| Included Files | A list of files that are referenced in the imported OpenAPI specification file will be shown here. Selecting from this list will have its contents be displayed in the box below. |
Limitations
This section lists the limitations that users may encounter when using the OpenAPI profile. OpenAPI specification schema which contains the oneOf tag will be decoded as a map instead of a UDR.
In the following example, the SubscriptionData schema contains the subscrCond property with oneOf tag:
...
The subscrCond is a schema of NfSetCond but it is decoded as a map with key-value pair as shown below:
...
To retrieve the value of the map, enter the following commandcode in APL:
| Code Block |
|---|
string ID = mapGet((map<string, any>)subscriptionData.subscrCond, "nfSetId"); debug(ID); |
The debug output is as follows:
| Code Block |
|---|
MU01 |
| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||