...
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| API Iteration | FDOAP_INP_API_ITERATION | N | Optional API iteration to export. Current/latest iteration will be used if left blank. |
| API Name | FDOAP_INP_API_NAME | N | @since 5.3.0.4 An optional API name can be given as an input. Primary use case of this input is for utility workflows where this input is delegated to a workflow input. |
| API Version | FDOAP_INP_API_VERSION | N | @since 5.3.0.4 An optional API version can be given as an input. Primary use case of this input is for utility workflows where this input is delegated to a workflow input. |
| Export References | FDOAP_INP_EXPORT_REFERENCES | N | @since 5.3.0.4 Should any api references also be exported such as Service Accounts, Plans etc. See Special Considerations below for more details. |
Outputs
| Output Name | Description |
|---|---|
| FDOAP_OUT_API_ITERATION | The API iteration that was exported. This will be returned regardless of whether or not the API Iteration input was specified. |
...
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
Exporting API References
@since 5.3.0.4 If you have multiple API Platform instances you often need to migrate APIs from your non prod instance to your prod instance (or however you have segregated the instances). The API json used for the export/import will contain references to other artifacts such as service accounts, gateways etc. The ids of these references may be different between your two instances. As such, something needs to replace the ids before importing to the second instance.
The Export References input will get the references your API is using and save them to an api.references file in the artifact repository. An example of the file is below:
| Code Block | ||
|---|---|---|
| ||
{
"offset": 0,
"count": 3,
"limit": 128,
"hasMore": false,
"links": [
{
"templated": "true",
"method": "GET",
"rel": "self",
"href": "https://flexapi-flexagonoraclecloud.apiplatform.ocp.oraclecloud.com:443/apiplatform/management/v1/apis/100/references?offset=0&limit=128"
}
],
"items": [
{
"name": "Sample Service",
"id": "100",
"type": "Service"
},
{
"name": "OIC Service Account",
"id": "100",
"type": "ServiceAccount"
},
{
"name": "Development",
"id": "100",
"type": "Gateway"
}
]
} |
During import you have the option to use this references file to replace any references within your API with the correct ids based on the instance in which you are deploying via the Update References input. When references are updated it will check for an existing object of the same name and type in the target instance and use the corresponding id.