Skip to main content

Anchor API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
anchor_associate_workstream_summaryPOST /anchor/{anchor}/workstream_summaries/associate/{workstream_summary}/anchor/{anchor}/workstream_summaries/associate/{workstream_summary} [POST]
anchor_disassociate_workstream_summaryPOST /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary}/anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} [POST]
anchor_renamePOST /anchor/{anchor}/rename/anchor/{anchor}/rename [POST]
anchor_scores_incrementPOST /anchor/{anchor}/scores/increment'/anchor/{anchor}/scores/increment' [POST]
anchor_specific_anchor_snapshotGET /anchor/{anchor}/anchor/{anchor} [GET]
anchor_updatePOST /anchor/update/anchor/update [POST]

anchor_associate_workstream_summary

anchor_associate_workstream_summary(anchor, workstream_summary)

/anchor/{anchor}/workstream_summaries/associate/{workstream_summary} [POST]

This will associate a anchor with a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AnchorApi(api_client)
anchor = 'anchor_example' # str | This is the specific uuid of an anchor.
workstream_summary = 'workstream_summary_example' # str | This is a identifier that is used to identify a specific workstream_summary.

try:
# /anchor/\{anchor\}/workstream_summaries/associate/\{workstream_summary\} [POST]
api_instance.anchor_associate_workstream_summary(anchor, workstream_summary)
except Exception as e:
print("Exception when calling AnchorApi->anchor_associate_workstream_summary: %s\n" % e)

Parameters

NameTypeDescriptionNotes
anchorstrThis is the specific uuid of an anchor.
workstream_summarystrThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

anchor_disassociate_workstream_summary

anchor_disassociate_workstream_summary(anchor, workstream_summary)

/anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} [POST]

This will enable us to disassociate a anchor from a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AnchorApi(api_client)
anchor = 'anchor_example' # str | This is the specific uuid of an anchor.
workstream_summary = 'workstream_summary_example' # str | This is a identifier that is used to identify a specific workstream_summary.

try:
# /anchor/\{anchor\}/workstream_summaries/disassociate/\{workstream_summary\} [POST]
api_instance.anchor_disassociate_workstream_summary(anchor, workstream_summary)
except Exception as e:
print("Exception when calling AnchorApi->anchor_disassociate_workstream_summary: %s\n" % e)

Parameters

NameTypeDescriptionNotes
anchorstrThis is the specific uuid of an anchor.
workstream_summarystrThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

anchor_rename

Anchor anchor_rename(anchor, transferables=transferables)

/anchor/{anchor}/rename [POST]

This will rename a specific anchor.

Example

import pieces_os_client
from pieces_os_client.models.anchor import Anchor
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AnchorApi(api_client)
anchor = 'anchor_example' # str | This is the specific uuid of an anchor.
transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)

try:
# /anchor/\{anchor\}/rename [POST]
api_response = api_instance.anchor_rename(anchor, transferables=transferables)
print("The response of AnchorApi->anchor_rename:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnchorApi->anchor_rename: %s\n" % e)

Parameters

NameTypeDescriptionNotes
anchorstrThis is the specific uuid of an anchor.
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]

Return type

Anchor

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

anchor_scores_increment

anchor_scores_increment(anchor, seeded_score_increment=seeded_score_increment)

'/anchor/{anchor}/scores/increment' [POST]

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

import pieces_os_client
from pieces_os_client.models.seeded_score_increment import SeededScoreIncrement
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AnchorApi(api_client)
anchor = 'anchor_example' # str | This is the specific uuid of an anchor.
seeded_score_increment = pieces_os_client.SeededScoreIncrement() # SeededScoreIncrement | (optional)

try:
# '/anchor/\{anchor\}/scores/increment' [POST]
api_instance.anchor_scores_increment(anchor, seeded_score_increment=seeded_score_increment)
except Exception as e:
print("Exception when calling AnchorApi->anchor_scores_increment: %s\n" % e)

Parameters

NameTypeDescriptionNotes
anchorstrThis is the specific uuid of an anchor.
seeded_score_incrementSeededScoreIncrement[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

anchor_specific_anchor_snapshot

Anchor anchor_specific_anchor_snapshot(anchor, transferables=transferables)

/anchor/{anchor} [GET]

This will get a snapshot of a single anchor.

Example

import pieces_os_client
from pieces_os_client.models.anchor import Anchor
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AnchorApi(api_client)
anchor = 'anchor_example' # str | This is the specific uuid of an anchor.
transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)

try:
# /anchor/\{anchor\} [GET]
api_response = api_instance.anchor_specific_anchor_snapshot(anchor, transferables=transferables)
print("The response of AnchorApi->anchor_specific_anchor_snapshot:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnchorApi->anchor_specific_anchor_snapshot: %s\n" % e)

Parameters

NameTypeDescriptionNotes
anchorstrThis is the specific uuid of an anchor.
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]

Return type

Anchor

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
410Anchor not found.-

anchor_update

Anchor anchor_update(transferables=transferables, anchor=anchor)

/anchor/update [POST]

This will update a specific anchor.

Example

import pieces_os_client
from pieces_os_client.models.anchor import Anchor
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.AnchorApi(api_client)
transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)
anchor = pieces_os_client.Anchor() # Anchor | (optional)

try:
# /anchor/update [POST]
api_response = api_instance.anchor_update(transferables=transferables, anchor=anchor)
print("The response of AnchorApi->anchor_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnchorApi->anchor_update: %s\n" % e)

Parameters

NameTypeDescriptionNotes
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]
anchorAnchor[optional]

Return type

Anchor

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-