harmony_connect_client.EntriesApi

All URIs are relative to https://connect-shared-sandbox-2445582615332.production.gw.apicast.io/v1

Method	HTTP request	Description
get_entries_by_chain_id	GET /chains/{chain_id}/entries	Get Chain's Entries
get_entry_by_hash	GET /chains/{chain_id}/entries/{entry_hash}	Get Entry Info
get_first_entry	GET /chains/{chain_id}/entries/first	Get Chain's First Entry
get_last_entry	GET /chains/{chain_id}/entries/last	Get Chain's Last Entry
post_entries_search	POST /chains/{chain_id}/entries/search	Search Chain's Entries
post_entry_to_chain_id	POST /chains/{chain_id}/entries	Create an Entry

get_entries_by_chain_id

EntryList get_entries_by_chain_id(chain_id, limit=limit, offset=offset, stages=stages)

Get Chain's Entries

List all entries contained on the specified chain.

Example

Api Key Authentication (AppId):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppId
configuration.api_key['app_id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_id'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
limit = 15 # int | The number of items you would like back in each page. (optional)
offset = 2 # int | The offset parameter allows you to select which item you would like to start from when you get back a list from Connect. For example, if you've already seen the first 15 items and you'd like the next set, you would send an offset of 15. `offset=0` starts from the first item of the set and is the default position. (optional)
stages = 'stages_example' # str | The immutability stages you want to restrict results to. You can choose any from `replicated`, `factom`, and `anchored`. If you would like to search among multiple stages, send them in a comma separated string. For example: `'replicated,factom'`. (optional)

try:
    # Get Chain's Entries
    api_response = api_instance.get_entries_by_chain_id(chain_id, limit=limit, offset=offset, stages=stages)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_entries_by_chain_id: %s\n" % e)

Api Key Authentication (AppKey):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppKey
configuration.api_key['app_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_key'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
limit = 15 # int | The number of items you would like back in each page. (optional)
offset = 2 # int | The offset parameter allows you to select which item you would like to start from when you get back a list from Connect. For example, if you've already seen the first 15 items and you'd like the next set, you would send an offset of 15. `offset=0` starts from the first item of the set and is the default position. (optional)
stages = 'stages_example' # str | The immutability stages you want to restrict results to. You can choose any from `replicated`, `factom`, and `anchored`. If you would like to search among multiple stages, send them in a comma separated string. For example: `'replicated,factom'`. (optional)

try:
    # Get Chain's Entries
    api_response = api_instance.get_entries_by_chain_id(chain_id, limit=limit, offset=offset, stages=stages)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_entries_by_chain_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
chain_id	str	Chain identifier
limit	int	The number of items you would like back in each page.	[optional]
offset	int	The offset parameter allows you to select which item you would like to start from when you get back a list from Connect. For example, if you've already seen the first 15 items and you'd like the next set, you would send an offset of 15. `offset=0` starts from the first item of the set and is the default position.	[optional]
stages	str	The immutability stages you want to restrict results to. You can choose any from `replicated`, `factom`, and `anchored`. If you would like to search among multiple stages, send them in a comma separated string. For example: `'replicated,factom'`.	[optional]

Return type

EntryList

Authorization

AppId, AppKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_entry_by_hash

Entry get_entry_by_hash(chain_id, entry_hash)

Get Entry Info

Returns information about a specific entry on Connect. The requested entry must be specified using the Chain ID and Entry Hash.

Example

Api Key Authentication (AppId):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppId
configuration.api_key['app_id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_id'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
entry_hash = db # str | The SHA256 hash of the entry.

try:
    # Get Entry Info
    api_response = api_instance.get_entry_by_hash(chain_id, entry_hash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_entry_by_hash: %s\n" % e)

Api Key Authentication (AppKey):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppKey
configuration.api_key['app_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_key'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
entry_hash = db # str | The SHA256 hash of the entry.

try:
    # Get Entry Info
    api_response = api_instance.get_entry_by_hash(chain_id, entry_hash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_entry_by_hash: %s\n" % e)

Parameters

Name	Type	Description	Notes
chain_id	str	Chain identifier
entry_hash	str	The SHA256 hash of the entry.

Return type

Entry

Authorization

AppId, AppKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_first_entry

Entry get_first_entry(chain_id)

Get Chain's First Entry

Retrieve the first entry that has been saved to this chain.

Example

Api Key Authentication (AppId):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppId
configuration.api_key['app_id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_id'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier

try:
    # Get Chain's First Entry
    api_response = api_instance.get_first_entry(chain_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_first_entry: %s\n" % e)

Api Key Authentication (AppKey):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppKey
configuration.api_key['app_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_key'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier

try:
    # Get Chain's First Entry
    api_response = api_instance.get_first_entry(chain_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_first_entry: %s\n" % e)

Parameters

Name	Type	Description	Notes
chain_id	str	Chain identifier

Return type

Entry

Authorization

AppId, AppKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_last_entry

Entry get_last_entry(chain_id)

Get Chain's Last Entry

Retrieve the last entry that has been saved to this chain.

Example

Api Key Authentication (AppId):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppId
configuration.api_key['app_id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_id'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier

try:
    # Get Chain's Last Entry
    api_response = api_instance.get_last_entry(chain_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_last_entry: %s\n" % e)

Api Key Authentication (AppKey):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppKey
configuration.api_key['app_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_key'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier

try:
    # Get Chain's Last Entry
    api_response = api_instance.get_last_entry(chain_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_last_entry: %s\n" % e)

Parameters

Name	Type	Description	Notes
chain_id	str	Chain identifier

Return type

Entry

Authorization

AppId, AppKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

post_entries_search

EntrySearchResponse post_entries_search(chain_id, search_body, limit=limit, offset=offset)

Search Chain's Entries

Find all of the entries within the specified chain that have the requested external_ids.

Example

Api Key Authentication (AppId):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppId
configuration.api_key['app_id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_id'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
search_body = harmony_connect_client.SearchBody() # SearchBody | 
limit = 15 # int | The number of items you would like back in each page. (optional)
offset = 2 # int | The offset parameter allows you to select which item you would like to start from when you get back a list from Connect. For example, if you've already seen the first 15 items and you'd like the next set, you would send an offset of 15. `offset=0` starts from the first item of the set and is the default position. (optional)

try:
    # Search Chain's Entries
    api_response = api_instance.post_entries_search(chain_id, search_body, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->post_entries_search: %s\n" % e)

Api Key Authentication (AppKey):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppKey
configuration.api_key['app_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_key'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
search_body = harmony_connect_client.SearchBody() # SearchBody | 
limit = 15 # int | The number of items you would like back in each page. (optional)
offset = 2 # int | The offset parameter allows you to select which item you would like to start from when you get back a list from Connect. For example, if you've already seen the first 15 items and you'd like the next set, you would send an offset of 15. `offset=0` starts from the first item of the set and is the default position. (optional)

try:
    # Search Chain's Entries
    api_response = api_instance.post_entries_search(chain_id, search_body, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->post_entries_search: %s\n" % e)

Parameters

Name	Type	Description	Notes
chain_id	str	Chain identifier
search_body	SearchBody
limit	int	The number of items you would like back in each page.	[optional]
offset	int	The offset parameter allows you to select which item you would like to start from when you get back a list from Connect. For example, if you've already seen the first 15 items and you'd like the next set, you would send an offset of 15. `offset=0` starts from the first item of the set and is the default position.	[optional]

Return type

EntrySearchResponse

Authorization

AppId, AppKey

HTTP request headers

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

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

post_entry_to_chain_id

EntryShort post_entry_to_chain_id(chain_id, entry_create)

Create an Entry

Create a new entry for the selected chain. Content and external id must be uploaded in Base64 format.

Example

Api Key Authentication (AppId):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppId
configuration.api_key['app_id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_id'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
entry_create = harmony_connect_client.EntryCreate() # EntryCreate | 

try:
    # Create an Entry
    api_response = api_instance.post_entry_to_chain_id(chain_id, entry_create)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->post_entry_to_chain_id: %s\n" % e)

Api Key Authentication (AppKey):

from __future__ import print_function
import time
import harmony_connect_client
from harmony_connect_client.rest import ApiException
from pprint import pprint
configuration = harmony_connect_client.Configuration()
# Configure API key authorization: AppKey
configuration.api_key['app_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['app_key'] = 'Bearer'

# create an instance of the API class
api_instance = harmony_connect_client.EntriesApi(harmony_connect_client.ApiClient(configuration))
chain_id = 285904 # str | Chain identifier
entry_create = harmony_connect_client.EntryCreate() # EntryCreate | 

try:
    # Create an Entry
    api_response = api_instance.post_entry_to_chain_id(chain_id, entry_create)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->post_entry_to_chain_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
chain_id	str	Chain identifier
entry_create	EntryCreate

Return type

EntryShort

Authorization

AppId, AppKey

HTTP request headers

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

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

Files

EntriesApi.md

Latest commit

History

EntriesApi.md

File metadata and controls

harmony_connect_client.EntriesApi

get_entries_by_chain_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_entry_by_hash

Example

Parameters

Return type

Authorization

HTTP request headers

get_first_entry

Example

Parameters

Return type

Authorization

HTTP request headers

get_last_entry

Example

Parameters

Return type

Authorization

HTTP request headers

post_entries_search

Example

Parameters

Return type

Authorization

HTTP request headers

post_entry_to_chain_id

Example

Parameters

Return type

Authorization

HTTP request headers