Export a project along with its valid assets into a compressed file. The exported project
is downloaded as a compressed file to your local machine.
Before you begin
- You need an admin access to export a project from the tenant.
- If you do not have admin access but hold a custom role, ensure that you have the write access
specifically for the project you intend to export.
Procedure
- In a REST client platform, add the authentication details of the tenant where you want to
publish a project.
- Export project with specific assets only
With this approach you can export a project by selecting and including only specific assets as
per your requirements.
Headers: {
Authorization: BasicAuth
}
Body: {
workflows":
[
"<workflow1_uid>",
"<workflow2_uid>",
],
"flows":
[
"<flowservice1_name>",
"<flowservice2_name>",
],
"rest_api":
[
"<rest_api1_name>",
"<rest_api2_name>",
],
"soap_api":
[
"<soap_api1_name>",
"<soap_api2_name>",
],
"messaging":
[
"<subscriber1_name>",
"<subscriber2_name>"
]
}
Note: To retrieve a list of assets available within a project, use the
Enabling a workflow API call. Once you have
access to the list of assets, you can choose the specific assets that you want to export from the
project.
- Export project with all assets
With this approach, you can export the entire project with all the assets.
Headers:
{
Authorization: BasicAuth
}
Body: {
}
- Make a POST request at the URL of the project.
URL Syntax: <domain>/apis/v1/rest/projects/<project>/export
In this URL request, <project> is the name or UID of the project you
want to publish.
Method: POST
If the request is successful, you receive the response code for success.
{
output : {
download_link: <download_link>,
valid_till: <valid_till>
}
}
Note: The value in valid_till indicates the validity period for downloading the
link.