Need Help?

Search our documentation and community forum

Terra is a cloud-native platform for biomedical researchers to access data, run analysis tools, and collaborate.
Terra powers important scientific projects like FireCloud, AnVIL, and BioData Catalyst. Learn more.

Comments

7 comments

  • Avatar
    Jason

    Hi Sehyun Oh,

    Great question. The API call will only be able to retrieve method configurations that exist in the Broad Methods Repository, since it's the repository we own and can set up API calls for. It might be worth seeing if Dockstore has publicly available APIs.

    Is this for the package you are developing? If you need to use our API call for this to work, you can consider making copies of any workflows you need and setting up method configurations for them in the Broad Methods Repository.

    Our Dockstore workflows have their source in GitHub, so you can consider seeing if GitHub has any usable APIs to get the files needed.

    If you have any other questions, please let us know.

    Kind regards,

    Jason

    0
    Comment actions Permalink
  • Avatar
    Sehyun Oh

    Hi Jason,

    Thanks for the clarification! And yes, this is for the R package I'm developing. :) For now, I think I'll add a new method configuration to the workflow and see whether I can use you API. Meanwhile, I have a couple of related questions:

    1) Is there any way to check the list of workflows under a given workspace through Terra API? Even if I end up using Dockstore or GitHub API, I need to find out 'what to look for' from Terra workspace - hopefully through API. 

    2) What is the difference between Terra API vs. Rawls API? They seem pretty similar but I found a case that works with only one. Should I use one over the other?

    Thanks,

    Sehyun

    0
    Comment actions Permalink
  • Avatar
    Jason

    Hi Sehyun,

    1) This looks like the right API for you!

    https://api.firecloud.org/#/Workspaces/listWorkspaceMethodConfigs

    2) Let me check with an engineer on this. Can you provide more details for the case that only works with one?

    Kind regards,

    Jason

    0
    Comment actions Permalink
  • Avatar
    Sehyun Oh

    Hi Jason,

    1) That API does what I want. Thanks! :)

    2) I thought these two are equivalent, but https://api.firecloud.org/#/Method%20Configurations/overwriteWorkspaceMethodConfig didn't work while https://rawls.dsde-prod.broadinstitute.org/#/methodconfigs/overwrite_method_configuration works.

    - Sehyun

    0
    Comment actions Permalink
  • Avatar
    Jason

    Hi Sehyun,

    I've heard from an engineer that these should be equally functional, so it's likely a bug that the FireCloud API isn't working. I'll file this bug for our engineers to investigate. Thank you for flagging it up!

    Kind regards,
    Jason

    0
    Comment actions Permalink
  • Avatar
    Sehyun Oh

    Hi Jason,

    Thanks for the help. Btw, what is the difference between firecloud api and rawls? Should I use one over the other?

    - Sehyun

    0
    Comment actions Permalink
  • Avatar
    Jason

    Hi Sehyun,

    The API calls found at https://api.firecloud.org/ are officially supported.

    Any calls from domains like *.dsde-prod.broadinstitute.org may work, but there's a chance they may not. These are not officially supported, so issues involving their use are not a priority to resolve.

    In most cases, I would recommend using api.firecloud.org, and if anything is not working as expected please let us know! Like I mentioned earlier, I will file a bug report for the issue you raised. Thanks again!

    Kind regards,

    Jason

    0
    Comment actions Permalink

Please sign in to leave a comment.

Powered by Zendesk