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 Name	Property Code	Required	Description
Oracle API Platform Account	FDOAP_CLOUD_ACCOUNT_CODE	Y	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
Update References	FDOAP_INP_UPDATE_REFERENCES	N	@since 5.3.0.4 Will query target environment for reference ids and replace them before importing. Always - Always attempt to replace references found in the .references file. If no .references file exists in the artifact repository then an exception will be thrown WhenFound - References will only be imported when the .references file is found. This is the default behavior Never - Never replace references even if the file is found. See ExportAPI Special Considerations for more information on replacing references.

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.

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.

@since 5.3.0.4 The api json file mentioned above no longer needs to be named flexApi.json. The plugin will first check for a file named flexApi.json but fallback to any file with a .json extension. If no flexApi.json and multiple json files are found then an error will be thrown.

importAPI