Export a Project
post
/ic/api/integration/v1/projects/{id}/archive
Exports a project. This operation returns a byte stream that is output to the display by default. If you are using cURL, use the -o option to save the response to a file.
Request
Path Parameters
-
id(required): string
Project identifier
Query Parameters
-
integrationInstance(required): string
This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
Supported Media Types
- application/json
Nested Schema : type
Type:
Show Source
object
-
access: string
Project Access
-
builtBy: string
Project BuiltBy
-
code: string
Project Identifier
-
description: string
Project Description
-
keyword: string
Project Keyword
-
label: string
Project Deployment
-
name: string
Project Name
-
origin: object
Origin
-
smartTags: array
smartTags
Project Smart Tags
-
state: object
State
-
type: string
Project Type
Nested Schema : State
Type:
Show Source
object
-
assets: object
Assets
-
created: object
ResourceModificationAttribute
-
latest: object
ResourceModificationAttribute
-
lock-status: boolean
-
locked: object
ResourceModificationAttribute
-
project-revision-id: integer
(int32)
-
service-instance-id: integer
(int32)
-
status: string
-
updated: object
ResourceModificationAttribute
Nested Schema : ConnectionsRs
Type:
Show Source
object
-
has-more: boolean
Flag to Check if More Records Exists
-
items: array
items
List of Connections
-
limit: integer
(int32)
Limit of Records to be Displayed
-
links: array
links
Suite Link List
-
total-results: integer
(int32)
Total Results
Nested Schema : IntegrationsRs
Type:
Show Source
object
-
has-more: boolean
Flag to Check if More Records Exists
-
items: array
items
List of Integrations
-
limit: integer
(int32)
Limit of Records to be Displayed
-
total-results: integer
(int32)
Total Results
Nested Schema : LibraryRs
Type:
Show Source
object
-
has-more: boolean
Flag to Check if More Records Exists
-
items: array
items
List of Libraries
-
limit: integer
(int32)
Limit of Records to be Displayed
-
total-results: integer
(int32)
Total Results
Nested Schema : schema
Type:
Show Source
object
-
adapters: array
adapters
Adapter List
-
columns: array
columns
Column List
-
created: string
(date-time)
Created Date
-
created-by: string
Created By
-
description: string
Lookup Description
-
keywords: string
Keywords
-
last-updated: string
(date-time)
Last Updated
-
last-updated-by: string
Last Updated By
-
locked-by: string
Locked By
-
locked-date: string
(date-time)
Locked Date
-
locked-dvm-flag: boolean
Locked DVM Flag
-
locked-flag: boolean
Locked Flag
-
name: string
Lookup Name
-
resource-path: string
Resource Path
-
row-count: integer
(int32)
Lookup Row Count
-
rows: array
rows
Row List
-
rows-as-array: array
rows-as-array
-
status: string
Lookup Status
-
usage: integer
(int32)
Lookup Usage
-
usage-active: integer
(int32)
Lookup Active Usage
Nested Schema : CertificatesRs-allOf[1]
Type:
Show Source
object
-
hasMore: boolean
Flag to Check if More Records Exists
-
items: array
items
List of Certificates
-
limit: integer
(int32)
Limit of Records to be Displayed
-
totalResults: integer
(int32)
Total Results
Nested Schema : CertificateRs-allOf[2]
Type:
Show Source
object
-
asciiArmored: boolean
ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC
-
cipherAlgorithm: string
Cipher algorithm. Valid only for type - PGP and category - PUBLIC
-
content: array
content
-
created: string
(date-time)
Certificate created date
-
createdBy: string
Certificate created by
-
description: string
Certificate description
-
expires: string
(date-time)
Certificate expiry date
-
hash: string
-
installedType: string
Certificate installed by. Ex - USER
-
issued: string
(date-time)
Certificate issued date
-
keyPasswords: string
Key password(s). Valid only for type - X509 and category - IDENTITY
-
keystore: string
Keystore
-
keyStoreDescription: string
Keystore description
-
keystorePassword: string
Keystore password. Valid only for type - X509 and category - IDENTITY
-
lastUpdated: string
(date-time)
Certificate updated date
-
lastUpdatedBy: string
Certificate updated by
-
metaData: object
metaData
Additional Properties Allowed: additionalProperties
-
name: string
Certificate alias name
-
passPhrase: string
Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE
-
secretOCID: string
-
status: string
Certificate status. Ex. - CONFIGURED or INPROGRESS
-
type: string
Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509
-
typeDescription: string
Certificate type description
Nested Schema : schema
Type:
Show Source
object
-
adapter:
AdapterTypeRs
-
adapter-type:
AdapterTypeBaseRs
-
admin-email: string
Administrator's Email
-
agent-group-id: string
Agent Group Identifier
-
agent-required: boolean
Agent Required
-
agent-supported: boolean
Agent Supported
-
connection-properties: array
connection-properties
List of Connection Properties
-
created: string
(date-time)
Created
-
created-by: string
Created By
-
description: string
Description
-
keywords: string
Keywords
-
last-refreshed-date: string
(date-time)
Last Refresh Date
-
last-updated: string
(date-time)
Last Updated
-
last-updated-by: string
Last Updated By
-
locked-by: string
Locked By
-
locked-date: string
(date-time)
Locked Date
-
locked-flag: boolean
Locked Flag
-
metadata-download-state: string
Metadata Download State
-
metadata-download-supported-flag: boolean
Metadata Download Supported Flag
-
name: string
Connection Name
-
percentage-complete: number
Connection Completion Percentage
-
project-id: string
-
refreshed-status: string
Refreshed Status
-
role: string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
-
security-policy: string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
-
security-policy-info: array
security-policy-info
List of Security Policies
-
security-properties: array
security-properties
List of Security Properties
-
status: string
Connection Status
-
test-status: boolean
Test Status
-
usage: integer
(int32)
Usage
-
usage-active: integer
(int32)
Active Usage
-
wsdl-list-dir: array
wsdl-list-dir
List of WSDL
Nested Schema : AdapterTypeRs-allOf[3]
Type:
Show Source
object
-
customSecurityPolicyDescription: string
-
defaultSecurityPolicies: string
-
description: string
-
features: string
-
genericAuthSupport: array
genericAuthSupport
-
icons: object
AdapterIconsRs
-
infoMessage: string
-
integrationRole: string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
-
oAuth3LeggedSupport: array
oAuth3LeggedSupport
-
otherVersions: string
-
supportedSecurityPolicies: string
-
testKey: string
-
testMessage: string
-
validateAndTestKey: string
-
validateAndTestMessage: string
-
vendorInfo: object
AdapterVendorInfo
-
version: string
-
wsdlvalidation: boolean
Nested Schema : genericAuthSupport
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
Nested Schema : oAuth3LeggedSupport
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
Nested Schema : ConnectionPropertyRs
Type:
Show Source
object
-
acceptable-keys: array
acceptable-keys
-
attachment: object
ConnectionAttachmentRs
-
default-property-value: string
-
display-name: string
-
has-attachment: boolean
- hidden-flag: boolean
-
integration-role: string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
-
property-description: string
-
property-group: string
Allowed Values:
[ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]
-
property-name: string
-
property-short-desc: string
-
property-type: string
Allowed Values:
[ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE", "BOOLEAN", "ARTIFACT_URL", "LIST_OF_MAPS", "CONCRETE_WSDL" ]
-
property-value: string
-
required-flag: boolean
Nested Schema : AdapterKey
Type:
Show Source
object
-
display-name: string
-
key-name: string
-
scope: string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
Nested Schema : SecurityPolicyInfoRs
Type:
Show Source
object
-
scope: string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
-
security-policy: string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
-
security-properties: array
security-properties
Nested Schema : IntegrationListRs
Type:
Show Source
object
-
activation-status: string
-
barta-built-by: string
BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy
-
compatible: boolean
Compatible
-
created: string
(date-time)
Created Date
-
created-by: string
Created By
-
dependencies: object
IntegrationDependencyRs
-
description: string
Integration Description
-
doc-url: string
Documentation URL
-
end-point-uri: string
Integration Endpoint URI
-
end-points: array
end-points
Endpoints
-
filmstrip: array
filmstrip
Filmstrip
-
is-clone-allowed: boolean
Flag to Check if Clone Allowed
-
is-view-allowed: boolean
Flag to Check if View Allowed
-
keywords: string
Keywords
-
last-updated: string
(date-time)
Last Updated Date
-
last-updated-by: string
Last Updated By
-
locked-by: string
Locked By
-
locked-date: string
(date-time)
Locked Date
-
locked-flag: boolean
Locked Flag
-
mep-type: string
MEP Type
-
original-integration-code: string
Original Integration Code
-
package-name: string
Package Name
-
pattern: string
Pattern
-
pattern-description: string
Pattern Description
-
payload-tracing-enabled-flag: boolean
Payload Tracing Enabled Flag
-
percentage-complete: number
Percentage Complete
-
project-id: string
-
project-type: string
Project Type
-
properties: array
properties
Integration Properties List
-
proxy-wsdl: string
Proxy WSDL
-
reactivation-status: string
Reactivation Status
-
record-enabled-flag: boolean
Record Enabled Flag
-
schedule-applicable-flag: boolean
Schedule Applicable Flag
-
schedule-defined-flag: boolean
Schedule Defined Flag
-
scope: string
-
smart-tags: string
Smart Tags
-
style: string
Style
-
style-description: string
Style Description
-
temp-copy-exists: boolean
Temp Copy Exists Flag
-
total-end-points: integer
(int32)
-
tracing-enabled-flag: boolean
Tracing Enabled Flag
-
tracking-variables: array
tracking-variables
Tracking Variables List
Nested Schema : LabelRs
Type:
Show Source
object
-
code(required): string
Deployment Identifier
-
description: string
Deployment Description
-
lastUpdated: string
(date-time)
Last Updated Date
-
name(required): string
Deployment Name
-
rows: array
rows
Integration List
Nested Schema : LibraryTypeRs
Type:
Show Source
object
-
callout-type: string
Callout Type
-
code: string
Library Code
-
created-by: string
Library Created By
-
created-date: string
(date-time)
Library Created Date
-
description: string
Library Description
-
display-name: string
Library Name
-
id: string
Library Identifier
-
last-updated-by: string
Library Last Updated By
-
last-updated-date: string
(date-time)
Library Last Updated Date
-
library-type: string
Library Type
-
locked-by: string
Locked By
-
locked-date: string
(date-time)
Locked Date
-
locked-flag: boolean
Locked Flag
-
project-id: string
-
status: string
Library Status
-
usage: integer
(int32)
Library Usage
-
version: string
Library Version
Response
Supported Media Types
- application/octet-stream
200 Response
Successful operation
404 Response
Project not found
500 Response
Server error
Examples
The following example shows how to export a project to a specified file by submitting a POST on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.
Example: Export the project TEST_PROJECT
This command downloads the project to the specified file
test_project.car
in the same directory from where the command
was run.
curl -X POST -H 'Authorization: Bearer access_token' -o 'test_project.car' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/archive?integrationInstance=service-instance
The required option for this cURL request is:
-o '/path/test_project.car': <Location and name of the file to save the project>