importAPI
- Copy Page Tree
Imports an API from the FlexDeploy Artifact Repository into Oracle API Platform.
This operation will look for a single file called {FDOAP_API_NAME}.json in the Artifact Repository to use. Once found, the plugin will search the target environment for an API with the same name. If any are found, it will search for a matching version, based on the version in the .json artifact.
If an API with the same name and version is found in the target environment, the plugin will update it, which will increment the Iteration of the API.
If there is no matching API name and version, it will create the API in that environment with the name and version found in the .json artifact.
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 |
|---|---|---|---|
Outputs
| Output Name | Description |
|---|---|
Artifacts
This operation consumes 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.
- style