Before You Begin
Before you use the export and import features with APIs, keep in mind the following points:
If the API or any referenced object in the archive already exists in the target instance of
CentraSite, the existing object will be overwritten according to the appropriate conditions.
To export an API, you must have the instance-level “View” permission on the API.
To import an API successfully, you must belong to a role that includes the “Manage Assets” permission for the organization in which the selected API resides.
The export process does not export the selected API's instance-level permissions.
The export operation creates an archive file on the file system. The archive file contains a copy of the APIs that you have exported. The archive file can be imported afterwards into the same
CentraSite registry or into a new registry.
When you import the API on the target instance,
CentraSite assigns instance-level permissions to the imported API just as though you created the API manually. (In other words, the imported API receives the same permission settings as the APIs you create from scratch.)
When an imported API
replaces (updates) an existing API in the target registry, all of the API's properties, except for its permission settings, are updated according to the API object in the archive. This includes the API's organizational scope and its lifecycle state. If the referenced organization and/or lifecycle model does not already exist on the target registry, the import process will fail.
If the archive file contains a reference to an object that is not already present in the target registry or is not included in the archive file itself, the API will not be imported.
If design/change-time policies exist for the events that the import process initiates (e.g., the creation of an API), those policies will be triggered.
The archive you wish to import must reside in the file system of the computer where your browser is running.
This is of specific relevance to REST APIs. Beginning with version 9.7,
CentraSite supports the enhanced interface for REST services (in contrast, earlier versions of
CentraSite supported a standardized interface for REST services). Documentation of the prior REST and XML service interface is available to
Software AG customers who have a current maintenance contract in
Empower,
Software AG's global extranet (
http://empower.softwareag.com/).
Starting with this version 9.7, you cannot import a REST service implemented by current version of
CentraSite to previous versions of
CentraSite. This is because,
CentraSite prior to version 9.7 does not support the enhanced REST interface.
The following sections provide specific information about exporting and importing APIs. Before you use the export and import features with APIs, review the general information provided in the
CentraSite Administrator’s Guide .