Skip to content

PipelinesApi.md

Latest commit

 

History

History
349 lines (229 loc) · 9.58 KB

PipelinesApi.md

File metadata and controls

349 lines (229 loc) · 9.58 KB

neurostore_sdk.PipelinesApi

All URIs are relative to https://neurostore.org/api

Method HTTP request Description
pipelines_get GET /pipelines/ GET a list of pipelines
pipelines_id_delete DELETE /pipelines/{id} DELETE a pipeline by ID
pipelines_id_get GET /pipelines/{id} GET a pipeline by ID
pipelines_id_put PUT /pipelines/{id} PUT/update a pipeline by ID
pipelines_post POST /pipelines/ POST/create a pipeline

pipelines_get

PipelineList pipelines_get(paginate=paginate)

GET a list of pipelines

Example

import neurostore_sdk
from neurostore_sdk.models.pipeline_list import PipelineList
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/api"
)


# Enter a context with an instance of the API client
with neurostore_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurostore_sdk.PipelinesApi(api_client)
    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)

    try:
        # GET a list of pipelines
        api_response = api_instance.pipelines_get(paginate=paginate)
        print("The response of PipelinesApi->pipelines_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PipelinesApi->pipelines_get: %s\n" % e)

Parameters

Name Type Description Notes
paginate bool whether to paginate results (true) or return all results at once (false) [optional] [default to True]

Return type

PipelineList

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pipelines_id_delete

pipelines_id_delete(id)

DELETE a pipeline by ID

Example

import neurostore_sdk
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/api"
)


# Enter a context with an instance of the API client
with neurostore_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurostore_sdk.PipelinesApi(api_client)
    id = 'id_example' # str | 

    try:
        # DELETE a pipeline by ID
        api_instance.pipelines_id_delete(id)
    except Exception as e:
        print("Exception when calling PipelinesApi->pipelines_id_delete: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pipelines_id_get

Pipeline pipelines_id_get(id)

GET a pipeline by ID

Example

import neurostore_sdk
from neurostore_sdk.models.pipeline import Pipeline
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/api"
)


# Enter a context with an instance of the API client
with neurostore_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurostore_sdk.PipelinesApi(api_client)
    id = 'id_example' # str | 

    try:
        # GET a pipeline by ID
        api_response = api_instance.pipelines_id_get(id)
        print("The response of PipelinesApi->pipelines_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PipelinesApi->pipelines_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

Pipeline

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pipelines_id_put

pipelines_id_put(id, pipeline=pipeline)

PUT/update a pipeline by ID

Example

import neurostore_sdk
from neurostore_sdk.models.pipeline import Pipeline
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/api"
)


# Enter a context with an instance of the API client
with neurostore_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurostore_sdk.PipelinesApi(api_client)
    id = 'id_example' # str | 
    pipeline = neurostore_sdk.Pipeline() # Pipeline |  (optional)

    try:
        # PUT/update a pipeline by ID
        api_instance.pipelines_id_put(id, pipeline=pipeline)
    except Exception as e:
        print("Exception when calling PipelinesApi->pipelines_id_put: %s\n" % e)

Parameters

Name Type Description Notes
id str
pipeline Pipeline [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pipelines_post

pipelines_post(pipeline=pipeline)

POST/create a pipeline

Example

  • Bearer Authentication (JSON-Web-Token):
import neurostore_sdk
from neurostore_sdk.models.pipeline import Pipeline
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurostore_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurostore_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurostore_sdk.PipelinesApi(api_client)
    pipeline = neurostore_sdk.Pipeline() # Pipeline |  (optional)

    try:
        # POST/create a pipeline
        api_instance.pipelines_post(pipeline=pipeline)
    except Exception as e:
        print("Exception when calling PipelinesApi->pipelines_post: %s\n" % e)

Parameters

Name Type Description Notes
pipeline Pipeline [optional]

Return type

void (empty response body)

Authorization

JSON-Web-Token

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Created -
401 Unauthorized - Authentication required -

[Back to top] [Back to API list] [Back to Model list] [Back to README]