Skip to content

AreaApi.md

Latest commit

 

History

History
335 lines (223 loc) · 10.2 KB

AreaApi.md

File metadata and controls

335 lines (223 loc) · 10.2 KB

opensilexClientToolsPython.AreaApi

All URIs are relative to https://localhost

Method HTTP request Description
create_area POST /core/area Add an area
delete_area DELETE /core/area/{uri} Delete an area
export_geospatial POST /core/area/export_geospatial Export a given list of areas URIs to shapefile
get_by_uri GET /core/area/{uri} Get an area
search_intersects POST /core/area/intersects Get area whose geometry corresponds to the Intersections
update_area PUT /core/area Update an area

create_area

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

Add an area

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.AreaApi(pythonClient)
body = opensilexClientToolsPython.AreaCreationDTO() # AreaCreationDTO | Area description (optional)


try:
    # Add an area
    api_response = api_instance.create_area(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling AreaApi->create_area: %s\n" % e)

Parameters

Name Type Description Notes
body AreaCreationDTO Area 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]

delete_area

str delete_area(uri, authorization, accept_language=accept_language)

Delete an area

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.AreaApi(pythonClient)
uri = 'uri_example' # str | Area URI


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

Parameters

Name Type Description Notes
uri str Area 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]

export_geospatial

export_geospatial(authorization, body=body, selected_props=selected_props, format=format, page_size=page_size, accept_language=accept_language)

Export a given list of areas URIs to shapefile

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.AreaApi(pythonClient)
body = [opensilexClientToolsPython.GeometryDTO()] # list[GeometryDTO] | Areas (optional)
selected_props = ['test'] # list[str] | properties selected (optional)
format = 'shp' # str | export format (shp/geojson) (optional)
page_size = 10000 # int | Page size limited to 10,000 objects (optional)


try:
    # Export a given list of areas URIs to shapefile
    api_instance.export_geospatial(body=body, selected_props=selected_props, format=format, page_size=page_size, )
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling AreaApi->export_geospatial: %s\n" % e)

Parameters

Name Type Description Notes
body list[GeometryDTO] Areas [optional]
selected_props list[str] properties selected [optional]
format str export format (shp/geojson) [optional]
page_size int Page size limited to 10,000 objects [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

get_by_uri

AreaGetDTO get_by_uri(uri, authorization, accept_language=accept_language)

Get an area

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.AreaApi(pythonClient)
uri = 'uri_example' # str | area URI


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

Parameters

Name Type Description Notes
uri str area URI

Return type

AreaGetDTO

Authorization

No authorization required

HTTP request headers

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

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

search_intersects

list[AreaGetDTO] search_intersects(body, authorization, start=start, end=end, accept_language=accept_language)

Get area whose geometry corresponds to the Intersections

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.AreaApi(pythonClient)
body = opensilexClientToolsPython.GeoJsonObject() # GeoJsonObject | geometry GeoJSON
start = '2019-09-08T12:00:00+01:00' # str | Start date : match temporal area after the given start date (optional)
end = '2021-09-08T12:00:00+01:00' # str | End date : match temporal area before the given end date (optional)


try:
    # Get area whose geometry corresponds to the Intersections
    api_response = api_instance.search_intersects(body, start=start, end=end, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling AreaApi->search_intersects: %s\n" % e)

Parameters

Name Type Description Notes
body GeoJsonObject geometry GeoJSON
start str Start date : match temporal area after the given start date [optional]
end str End date : match temporal area before the given end date [optional]

Return type

list[AreaGetDTO]

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_area

str update_area(body, authorization, accept_language=accept_language)

Update an area

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.AreaApi(pythonClient)
body = opensilexClientToolsPython.AreaUpdateDTO() # AreaUpdateDTO | Area description


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

Parameters

Name Type Description Notes
body AreaUpdateDTO Area description

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]