Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

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
API EntitlementsFDOAP_API_ENTITLEMENTSNCSV list of Plan names to entitle the API with during import. If the plan doesn't exist a warning will be logged during execution. This should only be used when multiple API Platform instances are being used.

Inputs

Input NameInput CodeRequiredDescription

Smart Import

FDOAP_INP_SMART_IMPORT

NImport 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 Groups or Users are required if API Grants are specified.  Oracle Paas group to receive API Grants.  If multiple then separate with a comma.  Group1,Group2
Grantee Users

FDOAP_INP_USERS

NGroups or Users are required if API Grants are specified. Oracle users to receive API Grants.
Update References

FDOAP_INP_UPDATE_REFERENCES

N

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.

...