Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Copyright (c) 2025 Oracle and/or its affiliates.

The Universal Permissive License (UPL), Version 1.0

Subject to the condition set forth below, permission is hereby granted to any
person obtaining a copy of this software, associated documentation and/or data
(collectively the "Software"), free of charge and under any and all copyright
rights in the Software, and any and all patent rights owned or freely
licensable by each licensor hereunder covering either (i) the unmodified
Software as contributed to or provided by such licensor, or (ii) the Larger
Works (as defined below), to deal in both

(a) the Software, and
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
one is included with the Software (each a "Larger Work" to which the Software
is contributed by such licensors),

without restriction, including without limitation the rights to copy, create
derivative works of, display, perform, and distribute the Software and make,
use, sell, offer for sale, import, export, have made, and have sold the
Software and the Larger Work(s), and to sublicense the foregoing rights on
either these or other terms.

This license is subject to the following condition:
The above copyright notice and either this complete permission notice or at
a minimum a reference to the UPL must be included in all copies or
substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# OIC Project & Deployment Export Import Guide

This asset contains an OIC Gen3 implementation guide for exporting and importing OIC projects and deployments through Oracle Integration Developer APIs. It includes OAuth authentication requirements, uppercase payload examples, cURL commands, multipart archive upload guidance, and deployment conflict handling. A Postman Collection is also provided with sample requests for Get Project Deployments, Export Project, Export Deployment, and Import Project or Deployment.

# When to use this asset?

Use this asset as a reference or template when automating OIC project and deployment migration between environments. It is useful for backup, promotion, deployment recovery, and repeatable delivery processes.

# How to use this asset?

Review the [OIC Project and Deployment Export and Import Guide]( oci-and-db\cloud-native\app-integration-and-automation\oracle-integration-cloud\13-oic-project-and-deployment-export-import-guide\files\import-export-guide\README.md) , configure OAuth authentication, and replace the environment placeholders with your Oracle Integration values.

For Postman collection, you can import the provided [Postman Collection](oci-and-db\cloud-native\app-integration-and-automation\oracle-integration-cloud\13-oic-project-and-deployment-export-import-guide\files\postman-collection\README.md) to run the included API samples for retrieving deployments, exporting projects or deployments, and importing archive files, ensure to replace the placeholders with your environment details.

# License

Copyright (c) 2026 Oracle and/or its affiliates.

Licensed under the Universal Permissive License (UPL), Version 1.0.

See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE.txt) for more details.
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# OIC Project and Deployment Export and Import Guide

Use the Oracle Integration 3 Developer API to export an entire project or one deployment, then import its archive into another environment. Export returns a downloadable `.CAR` archive. Import adds a project or deployment that is not already present in the target environment.

## Prerequisite OAuth Authentication

OAuth is required for Oracle Integration Developer APIs. Basic Authentication is not accepted by these APIs. Configure an OAuth client, obtain a valid access token, and send it with every request:

```http
Authorization: Bearer <ACCESS_TOKEN>
```

1. Configure an OAuth client and choose the appropriate grant type.
2. Request an access token.
3. Call the Developer API using the design-time URL and Bearer token.
4. Refresh the token when it expires.

Further details:

- [Oracle documentation - Security Authentication and Authorization](https://docs.oracle.com/en/cloud/paas/application-integration/rest-api/Authentication.html)
- [Step by step OAuth setup tutorial video](https://youtu.be/UrptzZbycm4?si=xz27moIXhua531m_)

## Prepare the request

Replace the following values for your environment:

| Placeholder | Meaning |
|---|---|
| `<DESIGN_HOST>` | Oracle Integration design host |
| `<ACCESS_TOKEN>` | Valid OAuth access token |
| `<INTEGRATION_INSTANCE>` | Oracle Integration service instance name |
| `<PROJECT_ID>` | Project identifier, for example `TEST_PROJECT` |
| `<ARCHIVE_FILE>` | Local `.CAR` archive, for example `TEST_PROJECT.CAR` |

Use uppercase project values consistently. The examples use `TEST PROJECT`, `TEST_PROJECT`, and `DEVELOPED`. The `LABEL` value identifies a deployment.

## Export an entire project

**Endpoint**

```text
POST https://<DESIGN_HOST>/ic/api/integration/v1/projects/<PROJECT_ID>/archive?integrationInstance=<INTEGRATION_INSTANCE>
```

**Project export payload**

```json
{"name":"TEST PROJECT","code":"TEST_PROJECT","type":"DEVELOPED","builtBy":"","label":""}
```

Keep `label` empty for a full project export.

```bash
curl -X POST \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{"name":"TEST PROJECT","code":"TEST_PROJECT","type":"DEVELOPED","builtBy":"","label":""}' \
-o "TEST_PROJECT.CAR" \
"https://<DESIGN_HOST>/ic/api/integration/v1/projects/TEST_PROJECT/archive?integrationInstance=<INTEGRATION_INSTANCE>"
```

The successful response is an `application/octet-stream` archive.

## Export a single deployment

Use the same endpoint and supply the deployment identifier in `label`.

```json
{"name":"TEST PROJECT","code":"TEST_PROJECT","type":"DEVELOPED","builtBy":"","label":"01.00.0000"}
```

```bash
curl -X POST \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{"name":"TEST PROJECT","code":"TEST_PROJECT","type":"DEVELOPED","builtBy":"","label":"01.00.0000"}' \
-o "TEST_PROJECT_01.00.0000.CAR" \
"https://<DESIGN_HOST>/ic/api/integration/v1/projects/TEST_PROJECT/archive?integrationInstance=<INTEGRATION_INSTANCE>"
```

## Import an exported archive

**Endpoint**

```text
POST https://<DESIGN_HOST>/ic/api/integration/v1/projects/archive?integrationInstance=<INTEGRATION_INSTANCE>
```

Upload the previously exported `.CAR` archive as `multipart/form-data` using the binary field named `file`.

```bash
curl -X POST \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-F "file=@TEST_PROJECT.CAR" \
-F "type=application/octet-stream" \
"https://<DESIGN_HOST>/ic/api/integration/v1/projects/archive?integrationInstance=<INTEGRATION_INSTANCE>"
```

The project or deployment being imported must not already exist in the target environment. A conflict returns HTTP `409` when the project already exists.

| Status | Meaning |
|---|---|
| `200` | Successful import |
| `400` | No file uploaded |
| `409` | Project already exists |
| `500` | Server error |

## Source documentation

- [Export a Project](https://docs.oracle.com/en/cloud/paas/application-integration/rest-api/op-ic-api-integration-v1-projects-id-archive-post.html)
- [Import Add a Project](https://docs.oracle.com/en/cloud/paas/application-integration/rest-api/op-ic-api-integration-v1-projects-archive-post.html)


# License

Copyright (c) 2026 Oracle and/or its affiliates.

Licensed under the Universal Permissive License (UPL), Version 1.0.

See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE.txt) for more details.
Loading