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
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Match All
Show Source
Nested Schema : ProjectTypeBaseResource
Match All
Show Source
Nested Schema : GenericRestResource
Type: object
Show Source
Nested Schema : ProjectTypeBaseResource-allOf[1]
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : Origin
Type: object
Show Source
Nested Schema : smartTags
Type: array
Project Smart Tags
Show Source
Nested Schema : State
Type: object
Show Source
Nested Schema : Assets
Type: object
Show Source
Nested Schema : ResourceModificationAttribute
Type: object
Show Source
Nested Schema : CertificatesRs
Match All
Show Source
Nested Schema : ConnectionsRs
Type: object
Show Source
Nested Schema : IntegrationsRs
Type: object
Show Source
Nested Schema : LabelsRs
Type: object
Show Source
Nested Schema : LibraryRs
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : GenericRestRs
Type: object
Show Source
Nested Schema : CertificatesRs-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
List of Certificates
Show Source
Nested Schema : CertificateRs
Match All
Show Source
Nested Schema : IdResource
Match All
Show Source
Nested Schema : IdResource-allOf[1]
Type: object
Show Source
Nested Schema : CertificateRs-allOf[2]
Type: object
Show Source
Nested Schema : content
Type: array
Show Source
Nested Schema : metaData
Type: object
Additional Properties Allowed
Show Source
Nested Schema : items
Type: array
List of Connections
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : AdapterTypeRs
Match All
Show Source
Nested Schema : AdapterTypeBaseRs
Match All
Show Source
Nested Schema : connection-properties
Type: array
List of Connection Properties
Show Source
Nested Schema : security-policy-info
Type: array
List of Security Policies
Show Source
Nested Schema : security-properties
Type: array
List of Security Properties
Show Source
Nested Schema : wsdl-list-dir
Type: array
List of WSDL
Show Source
Nested Schema : IdRs
Match All
Show Source
Nested Schema : IdRs-allOf[1]
Type: object
Show Source
Nested Schema : AdapterTypeBaseRs-allOf[2]
Type: object
Show Source
Nested Schema : AdapterTypeRs-allOf[3]
Type: object
Show Source
Nested Schema : genericAuthSupport
Type: array
Show Source
  • 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 : AdapterIconsRs
Type: object
Show Source
Nested Schema : oAuth3LeggedSupport
Type: array
Show Source
  • 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 : AdapterVendorInfo
Type: object
Show Source
Nested Schema : ConnectionPropertyRs
Type: object
Show Source
Nested Schema : acceptable-keys
Type: array
Show Source
Nested Schema : ConnectionAttachmentRs
Type: object
Show Source
Nested Schema : AdapterKey
Type: object
Show Source
Nested Schema : BaseAttachmentRs
Type: object
Show Source
Nested Schema : SecurityPolicyInfoRs
Type: object
Show Source
  • Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
  • 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
Nested Schema : security-properties
Type: array
Show Source
Nested Schema : items
Type: array
List of Integrations
Show Source
Nested Schema : IntegrationListRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs
Type: object
Show Source
Nested Schema : end-points
Type: array
Endpoints
Show Source
Nested Schema : filmstrip
Type: array
Filmstrip
Show Source
Nested Schema : properties
Type: array
Integration Properties List
Show Source
Nested Schema : tracking-variables
Type: array
Tracking Variables List
Show Source
Nested Schema : certificates
Type: array
Show Source
Nested Schema : connections
Type: array
Show Source
Nested Schema : libraries
Type: array
Show Source
Nested Schema : lookups
Type: array
Show Source
Nested Schema : IntegrationDependencyRs.CertificateDependencyRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs.ConnectionDependencyRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs.LibraryDependencyRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs.LookupDependencyRs
Type: object
Show Source
Nested Schema : EndPointRs
Type: object
Show Source
Nested Schema : ConnectionBaseRs
Type: object
Match All
Show Source
Nested Schema : FilmstripRs
Type: object
Show Source
Nested Schema : IntegrationPropRs
Type: object
Show Source
Nested Schema : TrackingVariableTypeRs
Type: object
Show Source
Nested Schema : TrackingVariableTypeRs.ReferenceTypeRs
Type: object
Show Source
Nested Schema : TrackingVariableTypeRs.OutputWirepointTypeRs
Type: object
Show Source
Nested Schema : property
Type: array
Show Source
Nested Schema : property
Type: array
Show Source
Nested Schema : TrackingVariableTypeRs.PropertyTypeRs
Type: object
Show Source
Nested Schema : items
Type: array
List of Deployments
Show Source
Nested Schema : LabelRs
Type: object
Show Source
Nested Schema : rows
Type: array
Integration List
Show Source
Nested Schema : Integration
Type: object
Show Source
Nested Schema : items
Type: array
List of Libraries
Show Source
Nested Schema : LibraryTypeRs
Type: object
Show Source
Nested Schema : adapters
Type: array
Adapter List
Show Source
Nested Schema : columns
Type: array
Column List
Show Source
Nested Schema : rows
Type: array
Row List
Show Source
Nested Schema : rows-as-array
Type: array
Show Source
Nested Schema : SuiteLookupRowData
Type: object
Show Source
Nested Schema : row-data
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Type: array
Show Source

404 Response

Project not found

500 Response

Server error
Back to Top

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>
Back to Top