opensilexClientToolsPython.OrganizationsApi

All URIs are relative to https://localhost

Method	HTTP request	Description
create_facility	POST /core/facilities	Create a facility
create_organization	POST /core/organisations	Create an organisation
create_site	POST /core/sites	Create a site
delete_facility	DELETE /core/facilities/{uri}	Delete a facility
delete_organization	DELETE /core/organisations/{uri}	Delete an organisation
delete_site	DELETE /core/sites/{uri}	Delete a site
get_all_facilities	GET /core/facilities/all_facilities	Get all facilities
get_facilities_by_uri	GET /core/facilities/by_uris	Get facilities by their URIs
get_facility	GET /core/facilities/{uri}	Get a facility
get_organization	GET /core/organisations/{uri}	Get an organisation
get_site	GET /core/sites/{uri}	Get a site
get_sites_by_uri	GET /core/sites/by_uris	Get a list of sites
get_sites_with_location	GET /core/sites/with_location	Get only the list of sites with a location
minimal_search_facilities	GET /core/facilities/minimal_search	Search facilities returning minimal embedded information for better performance
search_facilities	GET /core/facilities	Search facilities
search_organizations	GET /core/organisations	Search organisations
search_sites	GET /core/sites	Search all sites
update_facility	PUT /core/facilities	Update a facility
update_organization	PUT /core/organisations	Update an organisation
update_site	PUT /core/sites	Update a site

create_facility

str create_facility(authorization, body=body, accept_language=accept_language)

Create a facility

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
body = opensilexClientToolsPython.FacilityCreationDTO() # FacilityCreationDTO | Facility description (optional)


try:
    # Create a facility
    api_response = api_instance.create_facility(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->create_facility: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	FacilityCreationDTO	Facility description	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

create_organization

str create_organization(authorization, body=body, accept_language=accept_language)

Create an organisation

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
body = opensilexClientToolsPython.OrganizationCreationDTO() # OrganizationCreationDTO | Organisation description (optional)


try:
    # Create an organisation
    api_response = api_instance.create_organization(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->create_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	OrganizationCreationDTO	Organisation description	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

create_site

str create_site(authorization, body=body, accept_language=accept_language)

Create a site

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
body = opensilexClientToolsPython.SiteCreationDTO() # SiteCreationDTO | Site creation object (optional)


try:
    # Create a site
    api_response = api_instance.create_site(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->create_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SiteCreationDTO	Site creation object	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

delete_facility

str delete_facility(uri, authorization, accept_language=accept_language)

Delete a facility

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uri = 'http://example.com/' # str | Facility URI


try:
    # Delete a facility
    api_response = api_instance.delete_facility(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->delete_facility: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Facility URI

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

delete_organization

str delete_organization(uri, authorization, accept_language=accept_language)

Delete an organisation

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uri = 'http://example.com/' # str | Organisation URI


try:
    # Delete an organisation
    api_response = api_instance.delete_organization(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->delete_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Organisation URI

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

delete_site

str delete_site(uri, authorization, accept_language=accept_language)

Delete a site

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uri = 'uri_example' # str | Site URI


try:
    # Delete a site
    api_response = api_instance.delete_site(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->delete_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Site URI

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

get_all_facilities

list[NamedResourceDTO] get_all_facilities(authorization, accept_language=accept_language)

Get all facilities

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)


try:
    # Get all facilities
    api_response = api_instance.get_all_facilities()
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->get_all_facilities: %s\n" % e)

Parameters

Name	Type	Description	Notes

Return type

list[NamedResourceDTO]

Authorization

No authorization required

HTTP request headers

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

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

get_facilities_by_uri

list[FacilityNamedDTO] get_facilities_by_uri(uris, authorization, accept_language=accept_language)

Get facilities by their URIs

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uris = ['uris_example'] # list[str] | Facilities URIs


try:
    # Get facilities by their URIs
    api_response = api_instance.get_facilities_by_uri(uris, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->get_facilities_by_uri: %s\n" % e)

Parameters

Name	Type	Description	Notes
uris	list[str]	Facilities URIs

Return type

list[FacilityNamedDTO]

Authorization

No authorization required

HTTP request headers

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

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

get_facility

FacilityGetDTO get_facility(uri, authorization, accept_language=accept_language)

Get a facility

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uri = 'http://opensilex.dev/organisations/facility/phenoarch' # str | facility URI


try:
    # Get a facility
    api_response = api_instance.get_facility(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->get_facility: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	facility URI

Return type

FacilityGetDTO

Authorization

No authorization required

HTTP request headers

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

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

get_organization

OrganizationGetDTO get_organization(uri, authorization, accept_language=accept_language)

Get an organisation

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uri = 'http://opensilex.dev/organisation/phenoarch' # str | Organisation URI


try:
    # Get an organisation 
    api_response = api_instance.get_organization(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->get_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Organisation URI

Return type

OrganizationGetDTO

Authorization

No authorization required

HTTP request headers

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

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

get_site

SiteGetDTO get_site(uri, authorization, accept_language=accept_language)

Get a site

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uri = 'uri_example' # str | Site URI


try:
    # Get a site
    api_response = api_instance.get_site(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->get_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Site URI

Return type

SiteGetDTO

Authorization

No authorization required

HTTP request headers

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

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

get_sites_by_uri

list[NamedResourceDTO] get_sites_by_uri(uris, authorization, accept_language=accept_language)

Get a list of sites

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
uris = ['uris_example'] # list[str] | Site URIs


try:
    # Get a list of sites
    api_response = api_instance.get_sites_by_uri(uris, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->get_sites_by_uri: %s\n" % e)

Parameters

Name	Type	Description	Notes
uris	list[str]	Site URIs

Return type

list[NamedResourceDTO]

Authorization

No authorization required

HTTP request headers

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

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

get_sites_with_location

list[SiteGetWithGeometryDTO] get_sites_with_location(authorization, accept_language=accept_language)

Get only the list of sites with a location

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)


try:
    # Get only the list of sites with a location
    api_response = api_instance.get_sites_with_location()
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->get_sites_with_location: %s\n" % e)

Parameters

Name	Type	Description	Notes

Return type

list[SiteGetWithGeometryDTO]

Authorization

No authorization required

HTTP request headers

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

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

minimal_search_facilities

list[NamedResourceDTO] minimal_search_facilities(authorization, pattern=pattern, organizations=organizations, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search facilities returning minimal embedded information for better performance

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
pattern = '.*' # str | Regex pattern for filtering facilities by names (optional) (default to .*)
organizations = ['organizations_example'] # list[str] | List of organizations hosted by the facilities to filter (optional)
order_by = ['uri=asc'] # list[str] | List of fields to sort as an array of fieldName=asc|desc (optional)
page = 56 # int | Page number (optional)
page_size = 56 # int | Page size (optional)


try:
    # Search facilities returning minimal embedded information for better performance
    api_response = api_instance.minimal_search_facilities(pattern=pattern, organizations=organizations, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->minimal_search_facilities: %s\n" % e)

Parameters

Name	Type	Description	Notes
pattern	str	Regex pattern for filtering facilities by names	[optional] [default to .*]
organizations	list[str]	List of organizations hosted by the facilities to filter	[optional]
order_by	list[str]	List of fields to sort as an array of fieldName=asc	desc
page	int	Page number	[optional]
page_size	int	Page size	[optional]

Return type

list[NamedResourceDTO]

Authorization

No authorization required

HTTP request headers

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

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

search_facilities

list[FacilityGetDTO] search_facilities(authorization, pattern=pattern, organizations=organizations, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search facilities

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
pattern = '.*' # str | Regex pattern for filtering facilities by names (optional) (default to .*)
organizations = ['organizations_example'] # list[str] | List of organizations hosted by the facilities to filter (optional)
order_by = ['uri=asc'] # list[str] | List of fields to sort as an array of fieldName=asc|desc (optional)
page = 56 # int | Page number (optional)
page_size = 56 # int | Page size (optional)


try:
    # Search facilities
    api_response = api_instance.search_facilities(pattern=pattern, organizations=organizations, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->search_facilities: %s\n" % e)

Parameters

Name	Type	Description	Notes
pattern	str	Regex pattern for filtering facilities by names	[optional] [default to .*]
organizations	list[str]	List of organizations hosted by the facilities to filter	[optional]
order_by	list[str]	List of fields to sort as an array of fieldName=asc	desc
page	int	Page number	[optional]
page_size	int	Page size	[optional]

Return type

list[FacilityGetDTO]

Authorization

No authorization required

HTTP request headers

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

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

search_organizations

list[OrganizationDagDTO] search_organizations(authorization, pattern=pattern, organisation_uris=organisation_uris, type=type, parent_organization_uri=parent_organization_uri, facility_uri=facility_uri, accept_language=accept_language)

Search organisations

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
pattern = '.*' # str | Regex pattern for filtering list by names (optional) (default to .*)
organisation_uris = ['organisation_uris_example'] # list[str] |  organisation URIs (optional)
type = '.*' # str | Regex pattern for filtering list by types (optional)
parent_organization_uri = 'parent_organization_uri_example' # str | Organization every result will be direct child of (optional)
facility_uri = 'facility_uri_example' # str | Facility for filtering (optional)


try:
    # Search organisations
    api_response = api_instance.search_organizations(pattern=pattern, organisation_uris=organisation_uris, type=type, parent_organization_uri=parent_organization_uri, facility_uri=facility_uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->search_organizations: %s\n" % e)

Parameters

Name	Type	Description	Notes
pattern	str	Regex pattern for filtering list by names	[optional] [default to .*]
organisation_uris	list[str]	organisation URIs	[optional]
type	str	Regex pattern for filtering list by types	[optional]
parent_organization_uri	str	Organization every result will be direct child of	[optional]
facility_uri	str	Facility for filtering	[optional]

Return type

list[OrganizationDagDTO]

Authorization

No authorization required

HTTP request headers

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

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

search_sites

list[SiteGetListDTO] search_sites(authorization, pattern=pattern, organizations=organizations, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search all sites

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
pattern = '.*' # str | Regex pattern for filtering sites by names (optional) (default to .*)
organizations = ['organizations_example'] # list[str] | List of organizations of the sites to filter (optional)
order_by = ['uri=asc'] # list[str] | List of fields to sort as an array of fieldName=asc|desc (optional)
page = 56 # int | Page number (optional)
page_size = 56 # int | Page size (optional)


try:
    # Search all sites
    api_response = api_instance.search_sites(pattern=pattern, organizations=organizations, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->search_sites: %s\n" % e)

Parameters

Name	Type	Description	Notes
pattern	str	Regex pattern for filtering sites by names	[optional] [default to .*]
organizations	list[str]	List of organizations of the sites to filter	[optional]
order_by	list[str]	List of fields to sort as an array of fieldName=asc	desc
page	int	Page number	[optional]
page_size	int	Page size	[optional]

Return type

list[SiteGetListDTO]

Authorization

No authorization required

HTTP request headers

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

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

update_facility

str update_facility(authorization, body=body, accept_language=accept_language)

Update a facility

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
body = opensilexClientToolsPython.FacilityUpdateDTO() # FacilityUpdateDTO | Facility description (optional)


try:
    # Update a facility
    api_response = api_instance.update_facility(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->update_facility: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	FacilityUpdateDTO	Facility description	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

update_organization

str update_organization(authorization, body=body, accept_language=accept_language)

Update an organisation

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
body = opensilexClientToolsPython.OrganizationUpdateDTO() # OrganizationUpdateDTO | Organisation description (optional)


try:
    # Update an organisation
    api_response = api_instance.update_organization(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->update_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	OrganizationUpdateDTO	Organisation description	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

update_site

str update_site(authorization, body=body, accept_language=accept_language)

Update a site

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.OrganizationsApi(pythonClient)
body = opensilexClientToolsPython.SiteUpdateDTO() # SiteUpdateDTO | Site update object (optional)


try:
    # Update a site
    api_response = api_instance.update_site(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling OrganizationsApi->update_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SiteUpdateDTO	Site update object	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

FilesExpand file tree

OrganizationsApi.md

Latest commit

History

OrganizationsApi.md

File metadata and controls

opensilexClientToolsPython.OrganizationsApi

create_facility

Example

Parameters

Return type

Authorization

HTTP request headers

create_organization

Example

Parameters

Return type

Authorization

HTTP request headers

create_site

Example

Parameters

Return type

Authorization

HTTP request headers

delete_facility

Example

Parameters

Return type

Authorization

HTTP request headers

delete_organization

Example

Parameters

Return type

Authorization

HTTP request headers

delete_site

Example

Parameters

Return type

Authorization

HTTP request headers

get_all_facilities

Example

Parameters

Return type

Authorization

HTTP request headers

get_facilities_by_uri

Example

Parameters

Return type

Authorization

HTTP request headers

get_facility

Example

Parameters

Return type

Authorization

HTTP request headers

get_organization

Example

Parameters

Return type

Authorization

HTTP request headers

get_site

Example

Parameters

Return type

Authorization

HTTP request headers

get_sites_by_uri

Example

Parameters

Return type

Authorization

HTTP request headers

get_sites_with_location