Skip to content

Latest commit

 

History

History
312 lines (227 loc) · 9.19 KB

ImagesApi.md

File metadata and controls

312 lines (227 loc) · 9.19 KB
Raw

neurostore_api.ImagesApi

All URIs are relative to http://localhost:80/api

Method HTTP request Description
images_get GET /images/ GET a list of images
images_id_get GET /images/{id} GET an image
images_id_put PUT /images/{id} PUT/update an image
images_post POST /images/ POST/create an image

images_get

[object] images_get()

GET a list of images

Retrieve and list images.

Example

import time
import neurostore_api
from neurostore_api.api import images_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:80/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_api.Configuration(
    host = "http://localhost:80/api"
)


# Enter a context with an instance of the API client
with neurostore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = images_api.ImagesApi(api_client)
    search = "imagin" # str | search for entries that contain the substring (optional)
    sort = "created_at" # str | Parameter to sort results on (optional) if omitted the server will use the default value of "created_at"
    page = 0 # int | page of results (optional)
    desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
    page_size = 1 # int | number of results to show on a page (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # GET a list of images
        api_response = api_instance.images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size)
        pprint(api_response)
    except neurostore_api.ApiException as e:
        print("Exception when calling ImagesApi->images_get: %s\n" % e)

Parameters

Name Type Description Notes
search str search for entries that contain the substring [optional]
sort str Parameter to sort results on [optional] if omitted the server will use the default value of "created_at"
page int page of results [optional]
desc bool sort results by descending order (as opposed to ascending order) [optional]
page_size int number of results to show on a page [optional]

Return type

[object]

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]

images_id_get

object images_id_get(id)

GET an image

Retrieve information about a particular image from an analysis.

Example

import time
import neurostore_api
from neurostore_api.api import images_api
from neurostore_api.model.inline_response404 import InlineResponse404
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:80/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_api.Configuration(
    host = "http://localhost:80/api"
)


# Enter a context with an instance of the API client
with neurostore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = images_api.ImagesApi(api_client)
    id = "id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # GET an image
        api_response = api_instance.images_id_get(id)
        pprint(api_response)
    except neurostore_api.ApiException as e:
        print("Exception when calling ImagesApi->images_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

object

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
404 Example response -

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

images_id_put

images_id_put(id)

PUT/update an image

Update a specific image.

Example

import time
import neurostore_api
from neurostore_api.api import images_api
from neurostore_api.model.inline_response422 import InlineResponse422
from neurostore_api.model.image import Image
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:80/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_api.Configuration(
    host = "http://localhost:80/api"
)


# Enter a context with an instance of the API client
with neurostore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = images_api.ImagesApi(api_client)
    id = "id_example" # str | 
    image = Image(
        metadata={},
        url="https://neurovault.org/media/images/4778/Positive_RPEs_zstat.nii.gz",
        filename="Positive_RPEs_zstat.nii.gz",
        space="TAL",
        value_type="Z",
        analysis_name="Positive RPEs",
        analysis="7UvrsaALJU9g",
        add_date=dateutil_parser('1970-01-01T00:00:00.00Z'),
    ) # Image |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # PUT/update an image
        api_instance.images_id_put(id)
    except neurostore_api.ApiException as e:
        print("Exception when calling ImagesApi->images_id_put: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # PUT/update an image
        api_instance.images_id_put(id, image=image)
    except neurostore_api.ApiException as e:
        print("Exception when calling ImagesApi->images_id_put: %s\n" % e)

Parameters

Name Type Description Notes
id str
image Image [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
422 Example response -

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

images_post

images_post()

POST/create an image

Create an image

Example

import time
import neurostore_api
from neurostore_api.api import images_api
from neurostore_api.model.image import Image
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:80/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_api.Configuration(
    host = "http://localhost:80/api"
)


# Enter a context with an instance of the API client
with neurostore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = images_api.ImagesApi(api_client)
    image = [
        Image(
            metadata={},
            url="https://neurovault.org/media/images/4778/Positive_RPEs_zstat.nii.gz",
            filename="Positive_RPEs_zstat.nii.gz",
            space="TAL",
            value_type="Z",
            analysis_name="Positive RPEs",
            analysis="7UvrsaALJU9g",
            add_date=dateutil_parser('1970-01-01T00:00:00.00Z'),
        ),
    ] # [Image] |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # POST/create an image
        api_instance.images_post(image=image)
    except neurostore_api.ApiException as e:
        print("Exception when calling ImagesApi->images_post: %s\n" % e)

Parameters

Name Type Description Notes
image [Image] [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]