opensilexClientToolsPython.EventsApi

All URIs are relative to https://localhost

Method	HTTP request	Description
count_events	GET /core/events/count	Count events
create_events	POST /core/events	Create a list of event
create_moves	POST /core/events/moves	Create a list of move event
delete_event	DELETE /core/events/{uri}	Delete an event
delete_move_event	DELETE /core/events/moves/{uri}	Delete a move event
get_event	GET /core/events/{uri}	Get an event
get_event_details	GET /core/events/{uri}/details	Get an event with all it's properties
get_move_event	GET /core/events/moves/{uri}	Get a move with all it's properties
get_move_event_by_uris	GET /core/events/moves/by_uris	Get a list of moves with all positional information
import_event_csv	POST /core/events/import	Import a CSV file with one move and one target per line
import_move_csv	POST /core/events/moves/import	Import a CSV file with one move and one target per line
search_events	GET /core/events	Search events
update_event	PUT /core/events	Update an event
update_move_event	PUT /core/events/moves	Update a move event
validate_event_csv	POST /core/events/import_validation	Check a CSV file with one move and one target per line
validate_move_csv	POST /core/events/moves/import_validation	Check a CSV file with one move and one target per line

count_events

int count_events(targets, authorization, accept_language=accept_language)

Count events

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.EventsApi(pythonClient)
targets = ['targets_example'] # list[str] | Targets URIs


try:
    # Count events
    api_response = api_instance.count_events(targets, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->count_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
targets	list[str]	Targets URIs

Return type

int

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_events

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

Create a list of event

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.EventsApi(pythonClient)
body = [opensilexClientToolsPython.EventCreationDTO()] # list[EventCreationDTO] |  (optional)


try:
    # Create a list of event
    api_response = api_instance.create_events(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->create_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	list[EventCreationDTO]		[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_moves

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

Create a list of move event

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.EventsApi(pythonClient)
body = [opensilexClientToolsPython.MoveCreationDTO()] # list[MoveCreationDTO] |  (optional)


try:
    # Create a list of move event
    api_response = api_instance.create_moves(body=body, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->create_moves: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	list[MoveCreationDTO]		[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_event

str delete_event(uri, authorization, accept_language=accept_language)

Delete an event

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.EventsApi(pythonClient)
uri = 'http://opensilex.dev/events/deplacement/1865162374' # str | Event URI


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

Parameters

Name	Type	Description	Notes
uri	str	Event 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_move_event

str delete_move_event(uri, authorization, accept_language=accept_language)

Delete a move event

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.EventsApi(pythonClient)
uri = 'http://opensilex.dev/events/deplacement/1865162374' # str | Event URI


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

Parameters

Name	Type	Description	Notes
uri	str	Event 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_event

EventGetDTO get_event(uri, authorization, accept_language=accept_language)

Get an event

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.EventsApi(pythonClient)
uri = 'http://opensilex.dev/events/1865162374' # str | Event URI


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

Parameters

Name	Type	Description	Notes
uri	str	Event URI

Return type

EventGetDTO

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_event_details

EventDetailsDTO get_event_details(uri, authorization, accept_language=accept_language)

Get an event with all it's properties

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.EventsApi(pythonClient)
uri = 'http://opensilex.dev/events/1865162374' # str | Event URI


try:
    # Get an event with all it's properties
    api_response = api_instance.get_event_details(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->get_event_details: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Event URI

Return type

EventDetailsDTO

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_move_event

MoveDetailsDTO get_move_event(uri, authorization, accept_language=accept_language)

Get a move with all it's properties

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.EventsApi(pythonClient)
uri = 'http://opensilex.dev/events/1865162374' # str | Move URI


try:
    # Get a move with all it's properties
    api_response = api_instance.get_move_event(uri, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->get_move_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
uri	str	Move URI

Return type

MoveDetailsDTO

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_move_event_by_uris

list[MoveDetailsDTO] get_move_event_by_uris(uris, authorization, accept_language=accept_language)

Get a list of moves with all positional information

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.EventsApi(pythonClient)
uris = ['uris_example'] # list[str] | Move URIs


try:
    # Get a list of moves with all positional information
    api_response = api_instance.get_move_event_by_uris(uris, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->get_move_event_by_uris: %s\n" % e)

Parameters

Name	Type	Description	Notes
uris	list[str]	Move URIs

Return type

list[MoveDetailsDTO]

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]

import_event_csv

CSVValidationDTO import_event_csv(description, file, authorization, accept_language=accept_language)

Import a CSV file with one move and one target per line

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.EventsApi(pythonClient)
description = opensilexClientToolsPython.Object() # Object | CSV import settings
file = '/path/to/file.txt' # file | Event file


try:
    # Import a CSV file with one move and one target per line
    api_response = api_instance.import_event_csv(description, file, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->import_event_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
description	Object	CSV import settings
file	file	Event file

Return type

CSVValidationDTO

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

import_move_csv

CSVValidationDTO import_move_csv(file, authorization, accept_language=accept_language)

Import a CSV file with one move and one target per line

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.EventsApi(pythonClient)
file = '/path/to/file.txt' # file | Move file


try:
    # Import a CSV file with one move and one target per line
    api_response = api_instance.import_move_csv(file, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->import_move_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
file	file	Move file

Return type

CSVValidationDTO

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

search_events

list[EventGetDTO] search_events(authorization, rdf_type=rdf_type, start=start, end=end, target=target, description=description, order_by=order_by, page=page, page_size=page_size, accept_language=accept_language)

Search events

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.EventsApi(pythonClient)
rdf_type = 'http://www.opensilex.org/vocabulary/oeev#MoveFrom' # str | Event type (optional)
start = '2019-09-08T12:00:00+01:00' # str | Start date : match event after the given start date (optional)
end = '2021-09-08T12:00:00+01:00' # str | End date : match event before the given end date (optional)
target = 'http://www.opensilex.org/demo/2018/o18000076(exact match) or o18000076(partial match)' # str | Target partial/exact URI (optional)
description = 'The pest attack' # str | Description regex pattern (optional)
order_by = ['end=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 events
    api_response = api_instance.search_events(rdf_type=rdf_type, start=start, end=end, target=target, description=description, order_by=order_by, page=page, page_size=page_size, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->search_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
rdf_type	str	Event type	[optional]
start	str	Start date : match event after the given start date	[optional]
end	str	End date : match event before the given end date	[optional]
target	str	Target partial/exact URI	[optional]
description	str	Description regex pattern	[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[EventGetDTO]

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_event

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

Update an event

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.EventsApi(pythonClient)
body = opensilexClientToolsPython.EventUpdateDTO() # EventUpdateDTO | Event description (optional)


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

Parameters

Name	Type	Description	Notes
body	EventUpdateDTO	Event 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_move_event

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

Update a move event

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.EventsApi(pythonClient)
body = opensilexClientToolsPython.MoveUpdateDTO() # MoveUpdateDTO | Event description (optional)


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

Parameters

Name	Type	Description	Notes
body	MoveUpdateDTO	Event 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]

validate_event_csv

CSVValidationDTO validate_event_csv(description, file, authorization, accept_language=accept_language)

Check a CSV file with one move and one target per line

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.EventsApi(pythonClient)
description = opensilexClientToolsPython.Object() # Object | CSV import settings
file = '/path/to/file.txt' # file | Event file


try:
    # Check a CSV file with one move and one target per line
    api_response = api_instance.validate_event_csv(description, file, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->validate_event_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
description	Object	CSV import settings
file	file	Event file

Return type

CSVValidationDTO

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

validate_move_csv

CSVValidationDTO validate_move_csv(file, authorization, accept_language=accept_language)

Check a CSV file with one move and one target per line

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.EventsApi(pythonClient)
file = '/path/to/file.txt' # file | Move file


try:
    # Check a CSV file with one move and one target per line
    api_response = api_instance.validate_move_csv(file, )
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling EventsApi->validate_move_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
file	file	Move file

Return type

CSVValidationDTO

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

FilesExpand file tree

EventsApi.md

Latest commit

History

EventsApi.md

File metadata and controls

opensilexClientToolsPython.EventsApi

count_events

Example

Parameters

Return type

Authorization

HTTP request headers

create_events

Example

Parameters

Return type

Authorization

HTTP request headers

create_moves

Example

Parameters

Return type

Authorization

HTTP request headers

delete_event

Example

Parameters

Return type

Authorization

HTTP request headers

delete_move_event

Example

Parameters

Return type

Authorization

HTTP request headers

get_event

Example

Parameters

Return type

Authorization

HTTP request headers

get_event_details

Example

Parameters

Return type

Authorization

HTTP request headers

get_move_event

Example

Parameters

Return type

Authorization

HTTP request headers

get_move_event_by_uris

Example

Parameters

Return type

Authorization

HTTP request headers

import_event_csv

Example

Parameters

Return type

Authorization

HTTP request headers

import_move_csv

Example

Parameters

Return type

Authorization

HTTP request headers

search_events

Example

Parameters

Return type

Authorization

HTTP request headers

update_event