def add(self, params=None):
if len(params) == 0:
raise ValueError("all parameters must be provided")
else:
self.client.backend._append_slash = True
response = self.client.backend.statements.POST(json=params)
return OrkgResponse(response)
def add(self, params=None):
if len(params) == 0:
raise ValueError("at least label should be provided")
else:
self.client.backend._append_slash = True
response = self.client.backend.classes.POST(json=params)
return OrkgResponse(response)
def update(self, id, params=None):
if len(params) == 0:
raise ValueError("at least label should be provided")
else:
if not self.exists(id):
raise ValueError("the provided id is not in the graph")
self.client.backend._append_slash = True
response = self.client.backend.classes(id).PUT(json=params)
return OrkgResponse(response)
def get_resource_by_class(self, class_name, params=None):
if len(params) > 0:
self.client.backend._append_slash = False
response = self.client.backend.classes(class_name).resources.GET(
dict_to_url_params(params))
else:
self.client.backend._append_slash = True
response = self.client.backend.classes(class_name).resources.GET()
return OrkgResponse(response)
def get(self, params=None):
if len(params) > 0:
self.client.backend._append_slash = False
response = self.client.backend.classes.GET(
dict_to_url_params(params))
else:
self.client.backend._append_slash = True
response = self.client.backend.classes.GET()
return OrkgResponse(response)
def get_by_object(self, object_id, params=None):
if len(params) > 0:
self.client.backend._append_slash = False
response = self.client.backend.statements.object(object_id).GET(
dict_to_url_params(params))
else:
self.client.backend._append_slash = True
response = self.client.backend.statements.object(object_id).GET()
return OrkgResponse(response)
def add(self, params=None):
"""
Create a new paper in the ORKG instance
:param params: paper Object
:return: an OrkgResponse object containing the newly created paper ressource
"""
self.client.backend._append_slash = True
response = self.client.backend.papers.POST(json=params)
return OrkgResponse(response)
def by_id(self, id):
"""
Lookup a resource by id
:param id: the id of the resource to lookup
:return: an OrkgResponse object containing the resource
"""
self.client.backend._append_slash = True
response = self.client.backend.resources(id).GET()
return OrkgResponse(response)
def add(self, params=None):
"""
Create a new resource in the ORKG instance
:param id: the specific id to add (optional)
:param label: the label of the new resource (optional)
:param classes: list of classes to assign the resource to (optional)
:return: an OrkgResponse object containing the newly created resource
"""
if len(params) == 0:
raise ValueError("at least label should be provided")
else:
self.client.backend._append_slash = True
response = self.client.backend.resources.POST(json=params)
return OrkgResponse(response)
def update(self, id, params=None):
"""
Update a resource with a specific id
:param id: the id of the resource to update
:param label: the new label (optional)
:param classes: the updated list of classes (optional)
:return: an OrkgResponse object contains the newly updated resource
"""
if len(params) == 0:
raise ValueError("at least label should be provided")
else:
if not self.exists(id):
raise ValueError("the provided id is not in the graph")
self.client.backend._append_slash = True
response = self.client.backend.resources(id).PUT(json=params)
return OrkgResponse(response)
def get(self, params=None):
"""
Fetch a list of resources, with the possibility to paginate the results and filter them out based on label
:param q: search term of the label of the resource (optional)
:param exact: whether to check for the exact search term or not (optional) -> bool
:param page: the page number (optional)
:param items: number of items per page (optional)
:param sortBy: key to sort on (optional)
:param desc: true/false to sort desc (optional)
:param exclude: classes to be excluded in search (optional)
:return: an OrkgResponse object contains the list of resources
"""
if len(params) > 0:
self.client.backend._append_slash = False
response = self.client.backend.resources.GET(
dict_to_url_params(params))
else:
self.client.backend._append_slash = True
response = self.client.backend.resources.GET()
return OrkgResponse(response)
def by_id(self, id):
self.client.backend._append_slash = True
response = self.client.backend.classes(id).GET()
return OrkgResponse(response)
def get(self):
self.client.backend._append_slash = True
response = self.client.backend.stats.GET()
return OrkgResponse(response)