exportAPI

Exports an API from Oracle API Platform and stores it as an artifact in FlexDeploy.

The operation will search for APIs with the name specified in the API Name Project Property, then it will find the API with a version matching the API Version Input.

Once the API has been located, it is saved as a .json file in the Artifact Repository. From there, the importAPI operation can be used to import the API into the next environment.


Environment/Instance Properties

Property NameProperty CodeRequiredDescription
Oracle API Platform UrlFDOAP_API_URLYBase Url for the API Platform
Oracle Identity UrlFDOAP_IDENTITY_URLYBase Url for Oracle Identity
Oracle API UsernameFDOAP_USERNAMEYUsername for authentication
Oracle API PasswordFDOAP_PASSWORDYPassword for authentication
Oracle API AudienceFDOAP_AUDIENCEYPrimary Audience for the API Platform
Oracle API ScopeFDOAP_SCOPEYScope for making API calls
Oracle API Client IdFDOAP_CLIENT_IDYClient Id for the API Platform Application
Oracle API Client SecretFDOAP_CLIENT_SECRETYClient Secret for the API Platform Application

Project Properties

Property NameProperty CodeRequiredDescription
Oracle API NameFDOAP_API_NAMEYName of the API being managed

Inputs

Input NameInput CodeRequiredDescription
API VersionFDOAP_INP_API_VERSIONYAPI version to use

Outputs

Output NameDescription


Artifacts

This operation produces artifacts that will be stored in the artifacts repository.


Endpoint Selection

This operation will select all available endpoints associated to the environment/instance.


Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.