importAPI

Imports an API from the FlexDeploy Artifact Repository into Oracle API Platform.

This operation will look for a single file called flexApi.json in the Artifact Repository to use.  If an API with the same name 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 NameProperty CodeRequiredDescription
Oracle API Platform AccountFDOAP_CLOUD_ACCOUNT_CODEYThe Oracle API Platform cloud account to use for this operation. 

Project Properties

Property NameProperty CodeRequiredDescription
Oracle API NameFDOAP_API_NAMEYName of the API being managed
Oracle API VersionFDOAP_API_VERSIONYVersion of the API being managed

Inputs

Input NameInput CodeRequiredDescription
Smart ImportFDOAP_INP_SMART_IMPORTNImport will only take place if changes are detected in the implementation or publication of the API.  This prevents unnecessary API iteration increases.
API GrantsFDOAP_INP_API_GRANTSNMultiselect list of grants to grant to the group(s) specified in the Grantee Groups input
Grantee GroupsFDOAP_INP_GROUPSNRequired if API Grants are specified.  Oracle Paas group to receive API Grants.  If multiple then separate with a comma.  Group1,Group2

Outputs

Output NameDescription
FDOAP_OUT_API_ITERATIONThe API iteration after importing
FDOAP_OUT_API_IDThe 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.


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.


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.