Low-level API¶

class api.LowLevelAPI(http_client)¶

Low-level API mirroring 1:1 the Data Stewardship Wizard API. It contains one method for each combination of HTTP method and API endpoint.

If the endpoint accepts query parameters or body, the method accept these as well. Keys in both query params and body are converted to camelCase, so you can pass them in snake_case if you want.

Note that this class is generated by a script, not written by hand.

Parameters: http_client (HttpClient) – Some instance of the HttpClient interface.

post_action_keys(body, **kwargs)¶

body:: type: None email: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_auth(id, query_params=None, **kwargs)¶

query_params:: clientUrl [optional]: string

Parameters

id (str) –
query_params (Optional[Dict[str, Any]]) –

Return type

interface.HttpResponse

get_auth_callback(id, query_params=None, **kwargs)¶

query_params:: clientUrl [optional]: string error [optional]: string code [optional]: string

Parameters

id (str) –
query_params (Optional[Dict[str, Any]]) –

Return type

interface.HttpResponse

get_book_reference(br_short_uuid, **kwargs)¶

Parameters: br_short_uuid (str) –
Return type: interface.HttpResponse

get_branches(query_params=None, **kwargs)¶

query_params:: q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

post_branches(body, **kwargs)¶

body:: name: string kmId: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_branch(b_uuid, **kwargs)¶

Parameters: b_uuid (str) –
Return type: interface.HttpResponse

put_branch(b_uuid, body, **kwargs)¶

body:: name: string kmId: string events: array

Parameters

b_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_branch(b_uuid, **kwargs)¶

Parameters: b_uuid (str) –
Return type: interface.HttpResponse

delete_caches(**kwargs)¶

Return type: interface.HttpResponse

post_caches_knowledge_model(body, **kwargs)¶

body:: events: array tagUuids: array

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_configs_app(**kwargs)¶

Return type: interface.HttpResponse

put_configs_app(body, **kwargs)¶

body:: organization: None authentication: None privacyAndSupport: None dashboard: None lookAndFeel: None registry: None questionnaire: None template: None submission: None

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_configs_bootstrap(**kwargs)¶

Return type: interface.HttpResponse

get_documents(query_params=None, **kwargs)¶

query_params:: questionnaireUuid [optional]: string q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

post_documents(body, **kwargs)¶

body:: name: string questionnaireUuid: None templateId: string formatUuid: None

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_documents_housekeeping(**kwargs)¶

Return type: interface.HttpResponse

delete_document(doc_uuuid, **kwargs)¶

Parameters: doc_uuuid (str) –
Return type: interface.HttpResponse

get_document_download(doc_uuid, **kwargs)¶

Parameters: doc_uuid (str) –
Return type: interface.HttpResponse

get_document_available_submission_services(doc_uuuid, **kwargs)¶

Parameters: doc_uuuid (str) –
Return type: interface.HttpResponse

get_feedbacks(query_params=None, **kwargs)¶

query_params:: packageId [optional]: string questionUuid [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

post_feedbacks(body, **kwargs)¶

body:: questionUuid: None packageId: string title: string content: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_feedbacks_synchronization(**kwargs)¶

Return type: interface.HttpResponse

get_feedback(f_uuid, **kwargs)¶

Parameters: f_uuid (str) –
Return type: interface.HttpResponse

get_(**kwargs)¶

Return type: interface.HttpResponse

post_knowledge_models_preview(body, **kwargs)¶

body:: events: array tagUuids: array

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_levels(**kwargs)¶

Return type: interface.HttpResponse

get_metrics(**kwargs)¶

Return type: interface.HttpResponse

get_branch_migrations_current(b_uuid, **kwargs)¶

Parameters: b_uuid (str) –
Return type: interface.HttpResponse

post_branch_migrations_current(b_uuid, body, **kwargs)¶

body:: targetPackageId: string targetTagUuids: array

Parameters

b_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_branch_migrations_current(b_uuid, **kwargs)¶

Parameters: b_uuid (str) –
Return type: interface.HttpResponse

post_branch_migrations_current_conflict(b_uuid, body, **kwargs)¶

body:: originalEventUuid: None action: None

Parameters

b_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

post_questionnaire_migrations(qtn_uuid, body, **kwargs)¶

body:: targetPackageId: string targetTagUuids: array

Parameters

qtn_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

get_questionnaire_migrations_current(qtn_uuid, **kwargs)¶

Parameters: qtn_uuid (str) –
Return type: interface.HttpResponse

put_questionnaire_migrations_current(qtn_uuid, body, **kwargs)¶

body:: resolvedQuestionUuids: array

Parameters

qtn_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_questionnaire_migrations_current(qtn_uuid, **kwargs)¶

Parameters: qtn_uuid (str) –
Return type: interface.HttpResponse

post_questionnaire_migrations_current_completion(qtn_uuid, **kwargs)¶

Parameters: qtn_uuid (str) –
Return type: interface.HttpResponse

get_packages(query_params=None, **kwargs)¶

query_params:: organizationId [optional]: string kmId [optional]: string q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

post_packages(body, **kwargs)¶

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

delete_packages(query_params=None, **kwargs)¶

query_params:: organizationId [optional]: string kmId [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

get_packages_suggestions(query_params=None, **kwargs)¶

query_params:: q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

get_package(pkg_id, **kwargs)¶

Parameters: pkg_id (str) –
Return type: interface.HttpResponse

delete_package(pkg_id, **kwargs)¶

Parameters: pkg_id (str) –
Return type: interface.HttpResponse

post_packages_bundle(**kwargs)¶

Return type: interface.HttpResponse

get_package_bundle(pkg_id, **kwargs)¶

Parameters: pkg_id (str) –
Return type: interface.HttpResponse

post_package_pull(pkg_id, **kwargs)¶

Parameters: pkg_id (str) –
Return type: interface.HttpResponse

get_questionnaires(query_params=None, **kwargs)¶

query_params:: q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

post_questionnaires(query_params=None, **kwargs)¶

query_params:: cloneUuid [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

get_questionnaire(qtn_uuid, **kwargs)¶

Parameters: qtn_uuid (str) –
Return type: interface.HttpResponse

put_questionnaire(qtn_uuid, body, **kwargs)¶

body:: name: string visibility: None sharing: None permissions: array

Parameters

qtn_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_questionnaire(qtn_uuid, **kwargs)¶

Parameters: qtn_uuid (str) –
Return type: interface.HttpResponse

put_questionnaire_content(qtn_uuid, body, **kwargs)¶

body:: events: array

Parameters

qtn_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

get_questionnaire_report(qtn_uuid, **kwargs)¶

Parameters: qtn_uuid (str) –
Return type: interface.HttpResponse

get_questionnaire_documents(qtn_uuid, query_params=None, **kwargs)¶

query_params:: q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters

qtn_uuid (str) –
query_params (Optional[Dict[str, Any]]) –

Return type

interface.HttpResponse

get_questionnaire_documents_preview(qtn_uuid, query_params=None, **kwargs)¶

query_params:: Authorization [optional]: string

Parameters

qtn_uuid (str) –
query_params (Optional[Dict[str, Any]]) –

Return type

interface.HttpResponse

get_questionnaire_versions(qtn_uuid, **kwargs)¶

Parameters: qtn_uuid (str) –
Return type: interface.HttpResponse

post_questionnaire_versions(qtn_uuid, body, **kwargs)¶

body:: name: string eventUuid: None

Parameters

qtn_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

put_questionnaire_version(qtn_uuid, v_uuid, body, **kwargs)¶

body:: name: string eventUuid: None

Parameters

qtn_uuid (str) –
v_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_questionnaire_version(qtn_uuid, v_uuid, **kwargs)¶

Parameters

qtn_uuid (str) –
v_uuid (str) –

Return type

interface.HttpResponse

post_questionnaire_revert(qtn_uuid, body, **kwargs)¶

body:: eventUuid: None

Parameters

qtn_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

post_questionnaire_revert_preview(qtn_uuid, body, **kwargs)¶

body:: eventUuid: None

Parameters

qtn_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

post_registry_signup(body, **kwargs)¶

body:: email: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

post_registry_confirmation(body, **kwargs)¶

body:: organizationId: string hash: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

post_submissions(body, **kwargs)¶

body:: serviceId: string docUuid: None

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_template_assets(template_id, **kwargs)¶

Parameters: template_id (str) –
Return type: interface.HttpResponse

post_template_assets(template_id, **kwargs)¶

Parameters: template_id (str) –
Return type: interface.HttpResponse

get_template_asset(template_id, asset_uuid, **kwargs)¶

Parameters

template_id (str) –
asset_uuid (str) –

Return type

interface.HttpResponse

delete_template_asset(template_id, asset_uuid, **kwargs)¶

Parameters

template_id (str) –
asset_uuid (str) –

Return type

interface.HttpResponse

get_template_asset_content(template_id, asset_uuid, **kwargs)¶

Parameters

template_id (str) –
asset_uuid (str) –

Return type

interface.HttpResponse

get_template_files(template_id, **kwargs)¶

Parameters: template_id (str) –
Return type: interface.HttpResponse

post_template_files(template_id, body, **kwargs)¶

body:: fileName: string content: string

Parameters

template_id (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

get_template_file(template_id, file_uuid, **kwargs)¶

Parameters

template_id (str) –
file_uuid (str) –

Return type

interface.HttpResponse

put_template_file(template_id, file_uuid, body, **kwargs)¶

body:: fileName: string content: string

Parameters

template_id (str) –
file_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_template_file(template_id, file_uuid, **kwargs)¶

Parameters

template_id (str) –
file_uuid (str) –

Return type

interface.HttpResponse

get_templates(query_params=None, **kwargs)¶

query_params:: organizationId [optional]: string templateId [optional]: string q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

post_templates(body, **kwargs)¶

body:: name: string organizationId: string templateId: string version: string metamodelVersion: integer description: string readme: string license: string allowedPackages: array formats: array

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

delete_templates(query_params=None, **kwargs)¶

query_params:: organizationId [optional]: string templateId [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

get_templates_all(query_params=None, **kwargs)¶

query_params:: organizationId [optional]: string templateId [optional]: string pkgId [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

get_templates_suggestions(query_params=None, **kwargs)¶

query_params:: pkgId [optional]: string q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

get_template(template_id, **kwargs)¶

Parameters: template_id (str) –
Return type: interface.HttpResponse

put_template(template_id, body, **kwargs)¶

body:: name: string organizationId: string templateId: string version: string metamodelVersion: integer description: string readme: string license: string allowedPackages: array formats: array

Parameters

template_id (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_template(template_id, **kwargs)¶

Parameters: template_id (str) –
Return type: interface.HttpResponse

post_templates_bundle(**kwargs)¶

Return type: interface.HttpResponse

get_template_bundle(template_id, **kwargs)¶

Parameters: template_id (str) –
Return type: interface.HttpResponse

post_template_pull(template_id, **kwargs)¶

Parameters: template_id (str) –
Return type: interface.HttpResponse

post_tokens(body, **kwargs)¶

body:: email: string password: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

post_typehints(body, **kwargs)¶

body:: events: array questionUuid: None q: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_users(query_params=None, **kwargs)¶

query_params:: q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

post_users(body, **kwargs)¶

body:: firstName: string lastName: string email: string password: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_users_suggestions(query_params=None, **kwargs)¶

query_params:: q [optional]: string page [optional]: integer size [optional]: integer sort [optional]: string

Parameters: query_params (Optional[Dict[str, Any]]) –
Return type: interface.HttpResponse

get_users_current(**kwargs)¶

Return type: interface.HttpResponse

put_users_current(body, **kwargs)¶

body:: firstName: string lastName: string email: string submissionProps: array

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

put_users_current_password(body, **kwargs)¶

body:: password: string

Parameters: body (Dict[str, Any]) –
Return type: interface.HttpResponse

get_user(u_uuid, **kwargs)¶

Parameters: u_uuid (str) –
Return type: interface.HttpResponse

put_user(u_uuid, body, **kwargs)¶

body:: firstName: string lastName: string email: string role: string active: boolean

Parameters

u_uuid (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

delete_user(u_uuid, **kwargs)¶

Parameters: u_uuid (str) –
Return type: interface.HttpResponse

put_user_password(u_uuid, body, query_params=None, **kwargs)¶

body:: password: string
query_params:: hash [optional]: string

Parameters

u_uuid (str) –
body (Dict[str, Any]) –
query_params (Optional[Dict[str, Any]]) –

Return type

interface.HttpResponse

put_user_state(u_uuid, body, query_params=None, **kwargs)¶

body:: active: boolean
query_params:: hash [optional]: string

Parameters

u_uuid (str) –
body (Dict[str, Any]) –
query_params (Optional[Dict[str, Any]]) –

Return type

interface.HttpResponse

put_branch_version(b_uuid, version, body, **kwargs)¶

body:: description: string readme: string license: string

Parameters

b_uuid (str) –
version (str) –
body (Dict[str, Any]) –

Return type

interface.HttpResponse

Low-level API¶

Data Stewardship Wizard SDK

Navigation

Related Topics