Overview¶

Inside this example we contact Workflow endpoint to obtain a list of workflows that an account has access to.

Complete Authorization Form and Initialize Settings¶

This will also determine environment and set all environment variables. We determine if we are using Jupyter Notebooks or Google Colab to run this tutorial.

If you are running this notebook from Google Colab, Colab takes ~1 min to execute the following cell.

ACCOUNT_ID and AUTH_TOKEN - Authentication parameters needed for when making requests to Mat3ra.com's API Endpoints.

MATERIALS_PROJECT_API_KEY - Authentication parameter needed for when making requests to Material Project's API

ORGANIZATION_ID - Authentication parameter needed for when working with collaborative accounts https://docs.mat3ra.com/collaboration/organizations/overview/

NOTE: If you are running this notebook from Jupyter, the variables ACCOUNT_ID, AUTH_TOKEN, MATERIALS_PROJECT_API_KEY, and ORGANIZATION_ID should be set in the file settings.json if you need to use these variables. To obtain API token parameters, please see the following link to the documentation explaining how to get them: https://docs.mat3ra.com/accounts/ui/preferences/api/

In [1]:

# @title Authorization Form
ACCOUNT_ID = "ACCOUNT_ID"  # @param {type:"string"}
AUTH_TOKEN = "AUTH_TOKEN"  # @param {type:"string"}
MATERIALS_PROJECT_API_KEY = "MATERIALS_PROJECT_API_KEY"  # @param {type:"string"}
ORGANIZATION_ID = "ORGANIZATION_ID"  # @param {type:"string"}

import os

if "COLAB_JUPYTER_IP" in os.environ:
    os.environ.update(
        dict(
            ACCOUNT_ID=ACCOUNT_ID,
            AUTH_TOKEN=AUTH_TOKEN,
            MATERIALS_PROJECT_API_KEY=MATERIALS_PROJECT_API_KEY,
            ORGANIZATION_ID=ORGANIZATION_ID,
        )
    )

    !GIT_BRANCH="dev"; export GIT_BRANCH; curl -s "https://raw.githubusercontent.com/Exabyte-io/api-examples/${GIT_BRANCH}/scripts/env.sh" | bash

# @title Authorization Form ACCOUNT_ID = "ACCOUNT_ID" # @param {type:"string"} AUTH_TOKEN = "AUTH_TOKEN" # @param {type:"string"} MATERIALS_PROJECT_API_KEY = "MATERIALS_PROJECT_API_KEY" # @param {type:"string"} ORGANIZATION_ID = "ORGANIZATION_ID" # @param {type:"string"} import os if "COLAB_JUPYTER_IP" in os.environ: os.environ.update( dict( ACCOUNT_ID=ACCOUNT_ID, AUTH_TOKEN=AUTH_TOKEN, MATERIALS_PROJECT_API_KEY=MATERIALS_PROJECT_API_KEY, ORGANIZATION_ID=ORGANIZATION_ID, ) ) !GIT_BRANCH="dev"; export GIT_BRANCH; curl -s "https://raw.githubusercontent.com/Exabyte-io/api-examples/${GIT_BRANCH}/scripts/env.sh" | bash

Imports¶

In [2]:

from utils.settings import ENDPOINT_ARGS, ACCOUNT_ID
from utils.generic import display_JSON

from exabyte_api_client.endpoints.workflows import WorkflowEndpoints

from utils.settings import ENDPOINT_ARGS, ACCOUNT_ID from utils.generic import display_JSON from exabyte_api_client.endpoints.workflows import WorkflowEndpoints

Set Parameters¶

• QUERY: A query describing the documents to find. See Meteor collection for more information.

• limit: Maximum number of results to return. See Meteor collection for more information.

In [3]:

QUERY = {"name": "Total Energy", "owner._id": ACCOUNT_ID}

OPTIONS = {"limit": 2}

QUERY = {"name": "Total Energy", "owner._id": ACCOUNT_ID} OPTIONS = {"limit": 2}

Initialize the endpoint¶

Initialize a helper class to interact with WorkflowEndpoints. This only has to be done once.

In [4]:

endpoint = WorkflowEndpoints(*ENDPOINT_ARGS)

endpoint = WorkflowEndpoints(*ENDPOINT_ARGS)

List workflows¶

Contact the endpoint to list workflows according to the query above.

In [5]:

workflows = endpoint.list(QUERY, OPTIONS)

workflows = endpoint.list(QUERY, OPTIONS)

Print workflows¶

Print the list of workflows saved under the corresponding variable in pretty JSON below.

In [6]:

display_JSON(workflows)

display_JSON(workflows)