Imports an API from the FlexDeploy Artifact Repository into Oracle API Platform.
This operation will look for a single file called {FDOAP_API_NAME}flexApi.json in the Artifact Repository to use. Once found, the plugin will search the target environment for If 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.and version already exist on the server then that API will be updated otherwise the API will be created. The API Id and API Iteration will be returned as outputs at the end of execution.
Environment/Instance Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Oracle API Platform UrlAccount | FDOAP_CLOUD_APIACCOUNT_URLCODE | 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
...
Inputs
...
Outputs
| The Oracle API Platform cloud account to use for this operation. |
Project Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Oracle API Name | FDOAP_API_NAME | Y | Name of the API being managed |
| Oracle API Version | FDOAP_API_VERSION | Y | Version of the API being managed |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| Smart Import | FDOAP_INP_SMART_IMPORT | N | Import will only take place if changes are detected in the implementation or publication of the API. This prevents unnecessary API iteration increases. |
| API Grants | FDOAP_INP_API_GRANTS | N | Multiselect list of grants to grant to the group(s) specified in the Grantee Groups input |
| Grantee Groups | FDOAP_INP_GROUPS | N | Required if API Grants are specified. Oracle Paas group to receive API Grants. If multiple then separate with a comma. Group1,Group2 |
Outputs
| Output Name | Description |
|---|---|
| FDOAP_OUT_API_ITERATION | The API iteration after importing |
| FDOAP_OUT_API_ID | The API id after importing. If the API already exists it will not change the id. |
Artifacts
This operation consumes artifacts that will be stored in the artifacts repository.
...
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
As mentioned in the description, this operation requires a file named 'flexApi.json' to be in the artifacts directory. It does not require that the flexApi.json file was created as a result of the ExportAPI operation. If you want source control your APIs and build directly from source control you can still use this operation.