Copy an app

This call copies the specified app to the specified project. The app should be one in a project that you can access; this could be an app that has been uploaded to the Seven Bridges Platform by a project member, or a publicly available app that has been copied to the project.

📘

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/apps/{app_id}/actions/copy

👍

app_ids

The full {project_owner}/{project}/{app_short_name}/{revision_number} path for this API call is known as App ID. You can also get the App ID for an app by making the call to list all apps available to you.

The revision_number field is not a mandatory parameter of this API call. If omitted, the latest revision of the app is copied.

Methods for copying an app

The copy strategy parameter defines:

  • Which revisions are copied over into the new app. Either all revisions are copied (methods clone and clone_direct) or only the latest revision is copied (methods direct and transient)
  • The behavior when checking for updates. This is only relevant for apps that are already copies of another app.

For example:

An app called “Vardict Somatic Calling” is available in the Public apps gallery on the Platform. Let’s call this app the original app. At some point another user creates a copy of the Vardict Somatic Calling (original app). Let’s call this copy a source app and let’s say the user renamed it to "Vardict Somatic Calling - copy". Then, you make your copy of "Vardict Somatic Calling - copy" (source app).

You can set your app to receive updates in one of the following two ways::

  • From Vardict Somatic Calling (original app) using methods clone and transient
  • From Vardict Somatic Calling - copy (source app) using methods direct and clone_direct
copy latest revisioncopy all revisions
get updates from original apptransientclone
get updates from source appdirectclone_direct
705705

Example request body

{
  "project": "rfranklin/my-project", 
  "name": "new app name",
  "strategy": "direct"
}

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Example response body

This call returns the full Common Workflow Language (CWL) description of the copied app. This is typically a lengthy JSON object; for conciseness, we have not included it here, but made it available on this page.

Language