horse-python-client

joj.horse_client.RecordApi

All URIs are relative to /api/v1

Method	HTTP request	Description
v1_get_record	GET /domains/{domain}/records/{record}	Get Record
v1_list_records_in_domain	GET /domains/{domain}/records	List Records In Domain

v1_get_record

RecordDetailResp v1_get_record(record, domain)

Get Record

Example

from __future__ import print_function
import time
import joj.horse_client
from joj.horse_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = joj.horse_client.RecordApi(joj.horse_client.ApiClient(configuration))
record = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
domain = 'domain_example' # str | url or id of the domain

try:
    # Get Record
    api_response = api_instance.v1_get_record(record, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordApi->v1_get_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
record	str
domain	str	url or id of the domain

Return type

RecordDetailResp

Authorization

HTTPBearer

HTTP request headers

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

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

v1_list_records_in_domain

RecordListDetailListResp v1_list_records_in_domain(domain, problem_set=problem_set, problem=problem, submitter_id=submitter_id, ordering=ordering, offset=offset, limit=limit)

List Records In Domain

Example

from __future__ import print_function
import time
import joj.horse_client
from joj.horse_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = joj.horse_client.RecordApi(joj.horse_client.ApiClient(configuration))
domain = 'domain_example' # str | url or id of the domain
problem_set = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | problem set id (optional)
problem = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | problem id (optional)
submitter_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | submitter uid (optional)
ordering = '' # str | Comma separated list of ordering the results. You may specify reverse orderings by prefixing the field name with '-'.  Available fields: created_at,updated_at (optional)
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)

try:
    # List Records In Domain
    api_response = api_instance.v1_list_records_in_domain(domain, problem_set=problem_set, problem=problem, submitter_id=submitter_id, ordering=ordering, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordApi->v1_list_records_in_domain: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	str	url or id of the domain
problem_set	str	problem set id	[optional]
problem	str	problem id	[optional]
submitter_id	str	submitter uid	[optional]
ordering	str	Comma separated list of ordering the results. You may specify reverse orderings by prefixing the field name with '-'. Available fields: created_at,updated_at	[optional]
offset	int		[optional] [default to 0]
limit	int		[optional] [default to 100]

Return type

RecordListDetailListResp

Authorization

HTTPBearer

HTTP request headers

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

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