neurosynth_compose_sdk.DefaultApi

All URIs are relative to https://compose.neurosynth.org/api

Method	HTTP request	Description
meta_analyses_id_delete	DELETE /meta-analyses/{id}
neurostore_studies_get	GET /neurostore-studies	Your GET endpoint
neurostore_studies_id_get	GET /neurostore-studies/{id}	Your GET endpoint
neurostore_studies_id_put	PUT /neurostore-studies/{id}
neurostore_studies_post	POST /neurostore-studies
studyset_references_get	GET /studyset-references	Your GET endpoint
studyset_references_id_get	GET /studyset-references/{id}	Your GET endpoint

meta_analyses_id_delete

meta_analyses_id_delete(id)

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.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 = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # 
        api_instance.meta_analyses_id_delete(id)
    except Exception as e:
        print("Exception when calling DefaultApi->meta_analyses_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: Not defined
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]

neurostore_studies_get

NeurostoreStudyList neurostore_studies_get()

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.DefaultApi(api_client)

    try:
        # Your GET endpoint
        api_response = api_instance.neurostore_studies_get()
        print("The response of DefaultApi->neurostore_studies_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->neurostore_studies_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

NeurostoreStudyList

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]

neurostore_studies_id_get

NeurostoreStudyReturn neurostore_studies_id_get(id)

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

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


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

    try:
        # Your GET endpoint
        api_response = api_instance.neurostore_studies_id_get(id)
        print("The response of DefaultApi->neurostore_studies_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->neurostore_studies_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

NeurostoreStudyReturn

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]

neurostore_studies_id_put

NeurostoreStudyReturn neurostore_studies_id_put(id)

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.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 = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # 
        api_response = api_instance.neurostore_studies_id_put(id)
        print("The response of DefaultApi->neurostore_studies_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->neurostore_studies_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

NeurostoreStudyReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: multipart/form-data
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]

neurostore_studies_post

NeurostoreStudyReturn neurostore_studies_post()

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.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 = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.DefaultApi(api_client)

    try:
        # 
        api_response = api_instance.neurostore_studies_post()
        print("The response of DefaultApi->neurostore_studies_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->neurostore_studies_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

NeurostoreStudyReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: multipart/form-data
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]

studyset_references_get

StudysetReferenceList studyset_references_get(nested=nested)

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.DefaultApi(api_client)
    nested = True # bool | show nested component instead of id (optional)

    try:
        # Your GET endpoint
        api_response = api_instance.studyset_references_get(nested=nested)
        print("The response of DefaultApi->studyset_references_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->studyset_references_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
nested	bool	show nested component instead of id	[optional]

Return type

StudysetReferenceList

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]

studyset_references_id_get

StudysetReferenceReturn studyset_references_id_get(id, nested=nested)

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.DefaultApi(api_client)
    id = 'id_example' # str | 
    nested = True # bool | show nested component instead of id (optional)

    try:
        # Your GET endpoint
        api_response = api_instance.studyset_references_id_get(id, nested=nested)
        print("The response of DefaultApi->studyset_references_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->studyset_references_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
nested	bool	show nested component instead of id	[optional]

Return type

StudysetReferenceReturn

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]

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

neurosynth_compose_sdk.DefaultApi

meta_analyses_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurostore_studies_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurostore_studies_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurostore_studies_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurostore_studies_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

studyset_references_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

studyset_references_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details