Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ce_rise_hex_core_sdk.AdminApi

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

MethodHTTP requestDescription
healthGET /admin/healthLiveness probe
metricsGET /admin/metricsPrometheus metrics
models_countGET /admin/models/countCurrent model count
readyGET /admin/readyReadiness probe
statusGET /admin/statusRuntime status
versionGET /admin/versionService and OpenAPI version

health

HealthResponse health()

Liveness probe

Returns service process liveness.

Example

import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.health_response import HealthResponse
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.AdminApi(api_client)

    try:
        # Liveness probe
        api_response = api_instance.health()
        print("The response of AdminApi->health:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminApi->health: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Service is alive.-

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

metrics

str metrics()

Prometheus metrics

Returns Prometheus exposition format when metrics are enabled.

Example

import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.AdminApi(api_client)

    try:
        # Prometheus metrics
        api_response = api_instance.metrics()
        print("The response of AdminApi->metrics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminApi->metrics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Metrics text returned.-
404Metrics endpoint disabled.-

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

models_count

ModelCountResponse models_count()

Current model count

Returns the number of model/version entries currently loaded in the active registry index.

Example

import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.model_count_response import ModelCountResponse
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.AdminApi(api_client)

    try:
        # Current model count
        api_response = api_instance.models_count()
        print("The response of AdminApi->models_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminApi->models_count: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ModelCountResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Model count returned.-

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

ready

ReadyResponse ready()

Readiness probe

Returns readiness based on runtime adapter and registry state.

Example

import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.ready_response import ReadyResponse
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.AdminApi(api_client)

    try:
        # Readiness probe
        api_response = api_instance.ready()
        print("The response of AdminApi->ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminApi->ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ReadyResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Service is ready to accept traffic.-
503Service is not ready.-

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

status

Dict[str, object] status()

Runtime status

Returns runtime status payload useful for operations dashboards.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = ce_rise_hex_core_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.AdminApi(api_client)

    try:
        # Runtime status
        api_response = api_instance.status()
        print("The response of AdminApi->status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminApi->status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Dict[str, object]

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Status payload returned.-

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

version

VersionResponse version()

Service and OpenAPI version

Returns running service version and bundled OpenAPI specification version.

Example

import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.version_response import VersionResponse
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.AdminApi(api_client)

    try:
        # Service and OpenAPI version
        api_response = api_instance.version()
        print("The response of AdminApi->version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminApi->version: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

VersionResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Version payload returned.-

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

CreateRequest

Properties

NameTypeDescriptionNotes
payloadDict[str, object]Payload to validate and persist as a new record.

Example

from ce_rise_hex_core_sdk.models.create_request import CreateRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CreateRequest from a JSON string
create_request_instance = CreateRequest.from_json(json)
# print the JSON string representation of the object
print(CreateRequest.to_json())

# convert the object into a dict
create_request_dict = create_request_instance.to_dict()
# create an instance of CreateRequest from a dict
create_request_from_dict = CreateRequest.from_dict(create_request_dict)

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

ce_rise_hex_core_sdk.DiscoveryApi

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

MethodHTTP requestDescription
list_modelsGET /modelsList available model versions

list_models

ModelsResponse list_models()

List available model versions

Returns model/version pairs currently loaded in the active registry index.

Example

import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.models_response import ModelsResponse
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.DiscoveryApi(api_client)

    try:
        # List available model versions
        api_response = api_instance.list_models()
        print("The response of DiscoveryApi->list_models:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DiscoveryApi->list_models: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ModelsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Registry models loaded successfully.-

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

ErrorResponse

Properties

NameTypeDescriptionNotes
codestrStable machine-readable error code.
messagestrHuman-readable error message.
detailsobjectOptional error details payload.[optional]

Example

from ce_rise_hex_core_sdk.models.error_response import ErrorResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ErrorResponse from a JSON string
error_response_instance = ErrorResponse.from_json(json)
# print the JSON string representation of the object
print(ErrorResponse.to_json())

# convert the object into a dict
error_response_dict = error_response_instance.to_dict()
# create an instance of ErrorResponse from a dict
error_response_from_dict = ErrorResponse.from_dict(error_response_dict)

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

HealthResponse

Properties

NameTypeDescriptionNotes
statusstrHealth status string.

Example

from ce_rise_hex_core_sdk.models.health_response import HealthResponse

# TODO update the JSON string below
json = "{}"
# create an instance of HealthResponse from a JSON string
health_response_instance = HealthResponse.from_json(json)
# print the JSON string representation of the object
print(HealthResponse.to_json())

# convert the object into a dict
health_response_dict = health_response_instance.to_dict()
# create an instance of HealthResponse from a dict
health_response_from_dict = HealthResponse.from_dict(health_response_dict)

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

ModelCountResponse

Properties

NameTypeDescriptionNotes
models_countintNumber of models currently indexed by the registry.

Example

from ce_rise_hex_core_sdk.models.model_count_response import ModelCountResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ModelCountResponse from a JSON string
model_count_response_instance = ModelCountResponse.from_json(json)
# print the JSON string representation of the object
print(ModelCountResponse.to_json())

# convert the object into a dict
model_count_response_dict = model_count_response_instance.to_dict()
# create an instance of ModelCountResponse from a dict
model_count_response_from_dict = ModelCountResponse.from_dict(model_count_response_dict)

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

ModelVersion

Properties

NameTypeDescriptionNotes
idstrModel identifier.
versionstrModel version string.

Example

from ce_rise_hex_core_sdk.models.model_version import ModelVersion

# TODO update the JSON string below
json = "{}"
# create an instance of ModelVersion from a JSON string
model_version_instance = ModelVersion.from_json(json)
# print the JSON string representation of the object
print(ModelVersion.to_json())

# convert the object into a dict
model_version_dict = model_version_instance.to_dict()
# create an instance of ModelVersion from a dict
model_version_from_dict = ModelVersion.from_dict(model_version_dict)

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

ce_rise_hex_core_sdk.ModelsApi

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

MethodHTTP requestDescription
create_recordPOST /models/{model}/versions/{version}:createValidate and create a record
query_recordsPOST /models/{model}/versions/{version}:queryQuery records for a model version
validate_model_payloadPOST /models/{model}/versions/{version}:validateValidate payload against model rules

create_record

Record create_record(model, version, idempotency_key, create_request)

Validate and create a record

Validates input payload and writes a new record through the configured record store adapter.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.create_request import CreateRequest
from ce_rise_hex_core_sdk.models.record import Record
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = ce_rise_hex_core_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.ModelsApi(api_client)
    model = 'model_example' # str | Model identifier.
    version = 'version_example' # str | Model version.
    idempotency_key = 'idempotency_key_example' # str | Client-generated key used to deduplicate retries for side-effecting requests.
    create_request = ce_rise_hex_core_sdk.CreateRequest() # CreateRequest | 

    try:
        # Validate and create a record
        api_response = api_instance.create_record(model, version, idempotency_key, create_request)
        print("The response of ModelsApi->create_record:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModelsApi->create_record: %s\n" % e)

Parameters

NameTypeDescriptionNotes
modelstrModel identifier.
versionstrModel version.
idempotency_keystrClient-generated key used to deduplicate retries for side-effecting requests.
create_requestCreateRequest

Return type

Record

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Record created (or idempotent replay returned existing result).-
401Authentication required or invalid token.-
409Idempotency conflict.-
422Validation failed.-

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

query_records

QueryResponse query_records(model, version, query_request)

Query records for a model version

Applies a filter object and returns matching records provided by the record store adapter.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.query_request import QueryRequest
from ce_rise_hex_core_sdk.models.query_response import QueryResponse
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = ce_rise_hex_core_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.ModelsApi(api_client)
    model = 'model_example' # str | Model identifier.
    version = 'version_example' # str | Model version.
    query_request = ce_rise_hex_core_sdk.QueryRequest() # QueryRequest | 

    try:
        # Query records for a model version
        api_response = api_instance.query_records(model, version, query_request)
        print("The response of ModelsApi->query_records:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModelsApi->query_records: %s\n" % e)

Parameters

NameTypeDescriptionNotes
modelstrModel identifier.
versionstrModel version.
query_requestQueryRequest

Return type

QueryResponse

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Matching records returned.-
401Authentication required or invalid token.-
404Requested model/version is not present in registry.-

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

validate_model_payload

ValidationReport validate_model_payload(model, version, validate_request)

Validate payload against model rules

Runs configured validators for the selected model/version and returns a merged validation report.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import ce_rise_hex_core_sdk
from ce_rise_hex_core_sdk.models.validate_request import ValidateRequest
from ce_rise_hex_core_sdk.models.validation_report import ValidationReport
from ce_rise_hex_core_sdk.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = ce_rise_hex_core_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ce_rise_hex_core_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ce_rise_hex_core_sdk.ModelsApi(api_client)
    model = 'model_example' # str | Model identifier, for example `re-indicators-specification`.
    version = 'version_example' # str | Model version string, for example `0.0.3`.
    validate_request = ce_rise_hex_core_sdk.ValidateRequest() # ValidateRequest | 

    try:
        # Validate payload against model rules
        api_response = api_instance.validate_model_payload(model, version, validate_request)
        print("The response of ModelsApi->validate_model_payload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModelsApi->validate_model_payload: %s\n" % e)

Parameters

NameTypeDescriptionNotes
modelstrModel identifier, for example `re-indicators-specification`.
versionstrModel version string, for example `0.0.3`.
validate_requestValidateRequest

Return type

ValidationReport

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200Validation report returned.-
401Authentication required or invalid token.-
404Requested model/version is not present in registry.-
422Payload is syntactically valid JSON but violates model constraints.-

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

ModelsResponse

Properties

NameTypeDescriptionNotes
modelsList[ModelVersion]

Example

from ce_rise_hex_core_sdk.models.models_response import ModelsResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ModelsResponse from a JSON string
models_response_instance = ModelsResponse.from_json(json)
# print the JSON string representation of the object
print(ModelsResponse.to_json())

# convert the object into a dict
models_response_dict = models_response_instance.to_dict()
# create an instance of ModelsResponse from a dict
models_response_from_dict = ModelsResponse.from_dict(models_response_dict)

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

QueryRequest

Properties

NameTypeDescriptionNotes
filterRecordQueryFilter

Example

from ce_rise_hex_core_sdk.models.query_request import QueryRequest

# TODO update the JSON string below
json = "{}"
# create an instance of QueryRequest from a JSON string
query_request_instance = QueryRequest.from_json(json)
# print the JSON string representation of the object
print(QueryRequest.to_json())

# convert the object into a dict
query_request_dict = query_request_instance.to_dict()
# create an instance of QueryRequest from a dict
query_request_from_dict = QueryRequest.from_dict(query_request_dict)

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

QueryResponse

Properties

NameTypeDescriptionNotes
recordsList[Record]

Example

from ce_rise_hex_core_sdk.models.query_response import QueryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of QueryResponse from a JSON string
query_response_instance = QueryResponse.from_json(json)
# print the JSON string representation of the object
print(QueryResponse.to_json())

# convert the object into a dict
query_response_dict = query_response_instance.to_dict()
# create an instance of QueryResponse from a dict
query_response_from_dict = QueryResponse.from_dict(query_response_dict)

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

ReadyResponse

Properties

NameTypeDescriptionNotes
statusstrReadiness status string.

Example

from ce_rise_hex_core_sdk.models.ready_response import ReadyResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ReadyResponse from a JSON string
ready_response_instance = ReadyResponse.from_json(json)
# print the JSON string representation of the object
print(ReadyResponse.to_json())

# convert the object into a dict
ready_response_dict = ready_response_instance.to_dict()
# create an instance of ReadyResponse from a dict
ready_response_from_dict = ReadyResponse.from_dict(ready_response_dict)

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

Record

Properties

NameTypeDescriptionNotes
idstrRecord identifier returned by the store adapter.
modelstrModel identifier used for this record.
versionstrModel version used for this record.
payloadDict[str, object]Opaque business payload routed to the IO adapter.

Example

from ce_rise_hex_core_sdk.models.record import Record

# TODO update the JSON string below
json = "{}"
# create an instance of Record from a JSON string
record_instance = Record.from_json(json)
# print the JSON string representation of the object
print(Record.to_json())

# convert the object into a dict
record_dict = record_instance.to_dict()
# create an instance of Record from a dict
record_from_dict = Record.from_dict(record_dict)

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

RecordQueryCondition

Properties

NameTypeDescriptionNotes
var_fieldstrField path such as `id` or `payload.record_scope`.
opstrComparison operator.
valueobjectOperand value. For `in` this must be an array. For `exists` this should be boolean.

Example

from ce_rise_hex_core_sdk.models.record_query_condition import RecordQueryCondition

# TODO update the JSON string below
json = "{}"
# create an instance of RecordQueryCondition from a JSON string
record_query_condition_instance = RecordQueryCondition.from_json(json)
# print the JSON string representation of the object
print(RecordQueryCondition.to_json())

# convert the object into a dict
record_query_condition_dict = record_query_condition_instance.to_dict()
# create an instance of RecordQueryCondition from a dict
record_query_condition_from_dict = RecordQueryCondition.from_dict(record_query_condition_dict)

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

RecordQueryFilter

Canonical backend query dialect shared across record store adapters.

Properties

NameTypeDescriptionNotes
whereList[RecordQueryCondition]AND-only list of query predicates.
sortList[RecordQuerySort]Optional list of sort directives applied in order.[optional]
limitintMaximum number of records to return.[optional]
offsetintZero-based row offset for pagination.[optional]

Example

from ce_rise_hex_core_sdk.models.record_query_filter import RecordQueryFilter

# TODO update the JSON string below
json = "{}"
# create an instance of RecordQueryFilter from a JSON string
record_query_filter_instance = RecordQueryFilter.from_json(json)
# print the JSON string representation of the object
print(RecordQueryFilter.to_json())

# convert the object into a dict
record_query_filter_dict = record_query_filter_instance.to_dict()
# create an instance of RecordQueryFilter from a dict
record_query_filter_from_dict = RecordQueryFilter.from_dict(record_query_filter_dict)

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

RecordQuerySort

Properties

NameTypeDescriptionNotes
var_fieldstrSortable field path such as `created_at` or `payload.record_scope`.
directionstrSort direction.

Example

from ce_rise_hex_core_sdk.models.record_query_sort import RecordQuerySort

# TODO update the JSON string below
json = "{}"
# create an instance of RecordQuerySort from a JSON string
record_query_sort_instance = RecordQuerySort.from_json(json)
# print the JSON string representation of the object
print(RecordQuerySort.to_json())

# convert the object into a dict
record_query_sort_dict = record_query_sort_instance.to_dict()
# create an instance of RecordQuerySort from a dict
record_query_sort_from_dict = RecordQuerySort.from_dict(record_query_sort_dict)

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

Summary

ValidateRequest

Properties

NameTypeDescriptionNotes
payloadDict[str, object]Candidate record payload to validate.

Example

from ce_rise_hex_core_sdk.models.validate_request import ValidateRequest

# TODO update the JSON string below
json = "{}"
# create an instance of ValidateRequest from a JSON string
validate_request_instance = ValidateRequest.from_json(json)
# print the JSON string representation of the object
print(ValidateRequest.to_json())

# convert the object into a dict
validate_request_dict = validate_request_instance.to_dict()
# create an instance of ValidateRequest from a dict
validate_request_from_dict = ValidateRequest.from_dict(validate_request_dict)

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

ValidationReport

Properties

NameTypeDescriptionNotes
passedboolTrue when no blocking validation issues were found.
resultsList[ValidationResult]

Example

from ce_rise_hex_core_sdk.models.validation_report import ValidationReport

# TODO update the JSON string below
json = "{}"
# create an instance of ValidationReport from a JSON string
validation_report_instance = ValidationReport.from_json(json)
# print the JSON string representation of the object
print(ValidationReport.to_json())

# convert the object into a dict
validation_report_dict = validation_report_instance.to_dict()
# create an instance of ValidationReport from a dict
validation_report_from_dict = ValidationReport.from_dict(validation_report_dict)

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

ValidationResult

Properties

NameTypeDescriptionNotes
pathstrJSON path or pointer of the failing field when available.[optional]
messagestrHuman-readable validation message.[optional]
severitystrValidation severity label when provided by validator.[optional]

Example

from ce_rise_hex_core_sdk.models.validation_result import ValidationResult

# TODO update the JSON string below
json = "{}"
# create an instance of ValidationResult from a JSON string
validation_result_instance = ValidationResult.from_json(json)
# print the JSON string representation of the object
print(ValidationResult.to_json())

# convert the object into a dict
validation_result_dict = validation_result_instance.to_dict()
# create an instance of ValidationResult from a dict
validation_result_from_dict = ValidationResult.from_dict(validation_result_dict)

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

VersionResponse

Properties

NameTypeDescriptionNotes
servicestrStable service identifier.
service_versionstrRunning service build version from crate metadata.
openapi_versionstrBundled OpenAPI document version from info.version.

Example

from ce_rise_hex_core_sdk.models.version_response import VersionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of VersionResponse from a JSON string
version_response_instance = VersionResponse.from_json(json)
# print the JSON string representation of the object
print(VersionResponse.to_json())

# convert the object into a dict
version_response_dict = version_response_instance.to_dict()
# create an instance of VersionResponse from a dict
version_response_from_dict = VersionResponse.from_dict(version_response_dict)

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