Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
app_jsons
images
Setup_API_environment.ipynb
apps_copyFromMyProject.ipynb
apps_copyFromPublicApps.ipynb
apps_detailOne.ipynb
apps_installFromJSON.ipynb
apps_listAll.ipynb
files_copyFromMyProject.ipynb
files_copyFromPublicReference.ipynb
files_detailOne.ipynb
files_listAll.ipynb
files_listByMetadata.ipynb
files_upload_and_setMetadata.ipynb
projects_addMembers.ipynb
projects_detailOne.ipynb
projects_listAll.ipynb
projects_makeNew.ipynb
projects_membersOne.ipynb
readme.md
tasks_create.ipynb
tasks_monitorAndGetResults.ipynb
volumes_readFromCloudStorage.ipynb
volumes_writeToCloudStorage.ipynb

readme.md

API Recipes for the Seven Bridges Platform (SBPLAT)

Our goals are:

  • Educate users about how the API works by using a friendly Python wrapper
  • Provide re-usable blocks of API code to solve common problems

How does the Seven Bridges Platform work?

An important first concept is how the Seven Bridges Platform (and CGC) works. A user has access to multiple projects, she may either be the owner of those projects or a member of someone else's project. Within each project, there is a collection of files and apps. The owner can combine a set of files, configuration inputs, and an app to generate a task. Once this task is complete, any output files will be put into the project where the task was started.

CGC Overview

Recipes in this cookbook

Each Seven Bridges Platform component is accessible by the API. These recipes are purposefully repetitive to highlight the logic of the API and hopefully help users understand some of the tools available to solve problems. The current cookbook includes1 the following recipes:

  • Projects

    • list [projects_listsAll.ipynb]
    • get details [projects_detailOne.ipynb]
    • get members [projects_membersOne.ipynb]
    • make new [projects_makeNew.ipynb]
    • add members [projects_addMembers.ipynb]
  • Files

  • list (within a project) [files_listAll.ipynb]

  • list based on metadata [files_screenbyMetadata.ipynb]

  • get details [files_detailOne.ipynb]

  • copy Public Reference file [files_copyFromMyProject.ipynb]

  • copy from another project [files_copyFromPublicReference.ipynb]

  • upload and set metadata [files_upload_and_setMetadata.ipynb]

  • Apps

  • list [apps_listAll.ipynb]

  • get details [apps_detailOne.ipynb]

  • copy from Public Apps [apps_copyFromPublicApps.ipynb]

  • copy from another project [apps_copyFromMyProject.ipynb]

  • install (upload) from a Common Workflow Language JSON [apps_installFromJSON.ipynb]

  • Tasks

  • create and start [tasks_create.ipynb]

  • monitor & get outputs [tasks_monitorAndGetResults.ipynb]

  • Volumes2

  • mount and write to volume [volumes_writeToCloudStorage.ipynb]

  • mount and read from volume [volumes_readFromCloudStorage.ipynb]

Notes

1 We are happy to add more recipes, please request what helps you most effectively get stuff done. Already in the queue is:

  • [billing_*] we definity have neglected billing, sorry.

2 These recipes will be updated to use the sevenbridges-python library which now (version >= 0.4.0) supports Volumes API.

You can’t perform that action at this time.