exportAPI
- Copy Page Tree
- Ben Hoffman
Owned by Copy Page Tree
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 Name | Property Code | Required | Description |
|---|---|---|---|
| Oracle API Platform Url | FDOAP_API_URL | Y | Base Url for the API Platform |
| Oracle Identity Url | FDOAP_IDENTITY_URL | Y | Base Url for Oracle Identity |
| Oracle API Username | FDOAP_USERNAME | Y | Username for authentication |
| Oracle API Password | FDOAP_PASSWORD | Y | Password for authentication |
| Oracle API Audience | FDOAP_AUDIENCE | Y | Primary Audience for the API Platform |
| Oracle API Scope | FDOAP_SCOPE | Y | Scope for making API calls |
| Oracle API Client Id | FDOAP_CLIENT_ID | Y | Client Id for the API Platform Application |
| Oracle API Client Secret | FDOAP_CLIENT_SECRET | Y | Client Secret for the API Platform Application |
Project Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Oracle API Name | FDOAP_API_NAME | Y | Name of the API being managed |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| API Version | FDOAP_INP_API_VERSION | Y | API version to use |
Outputs
| Output Name | Description |
|---|---|
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.
The following macros are not currently supported in the footer:
- style