Skip to content

Latest commit

 

History

History
365 lines (249 loc) · 15.6 KB

PexQueryApi.md

File metadata and controls

365 lines (249 loc) · 15.6 KB

affinidi_tdk_iota_client.api.PexQueryApi

Load the API package

import 'package:affinidi_tdk_iota_client/api.dart';

All URIs are relative to https://apse1.api.affinidi.io/ais

Method HTTP request Description
createPexQuery POST /v1/configurations/{configurationId}/pex-queries
deletePexQueries POST /v1/configurations/{configurationId}/delete-queries
deletePexQueryById DELETE /v1/configurations/{configurationId}/pex-queries/{queryId}
getPexQueryById GET /v1/configurations/{configurationId}/pex-queries/{queryId}
listPexQueries GET /v1/configurations/{configurationId}/pex-queries
savePexQueries POST /v1/configurations/{configurationId}/save-queries
updatePexQueryById PATCH /v1/configurations/{configurationId}/pex-queries/{queryId}

createPexQuery

PexQueryDto createPexQuery(configurationId, createPexQueryInput)

Creates a new Presentation Definition in the configuration to query data.

Example

import 'package:affinidi_tdk_iota_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api = AffinidiTdkIotaClient().getPexQueryApi();
final String configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration.
final CreatePexQueryInput createPexQueryInput = ; // CreatePexQueryInput | CreatePexQuery

try {
    final response = api.createPexQuery(configurationId, createPexQueryInput);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PexQueryApi->createPexQuery: $e\n');
}

Parameters

Name Type Description Notes
configurationId String ID of the Affinidi Iota Framework configuration.
createPexQueryInput CreatePexQueryInput CreatePexQuery

Return type

PexQueryDto

Authorization

ProjectTokenAuth

HTTP request headers

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

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

deletePexQueries

JsonObject deletePexQueries(configurationId, deletePexQueriesInput)

Deletes all Presentation Definition queries of a configuration.

Example

import 'package:affinidi_tdk_iota_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api = AffinidiTdkIotaClient().getPexQueryApi();
final String configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration.
final DeletePexQueriesInput deletePexQueriesInput = ; // DeletePexQueriesInput | DeletePexQueriesInput

try {
    final response = api.deletePexQueries(configurationId, deletePexQueriesInput);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PexQueryApi->deletePexQueries: $e\n');
}

Parameters

Name Type Description Notes
configurationId String ID of the Affinidi Iota Framework configuration.
deletePexQueriesInput DeletePexQueriesInput DeletePexQueriesInput

Return type

JsonObject

Authorization

ProjectTokenAuth

HTTP request headers

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

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

deletePexQueryById

deletePexQueryById(configurationId, queryId)

Deletes a Presentation Definition in the configuration by ID.

Example

import 'package:affinidi_tdk_iota_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api = AffinidiTdkIotaClient().getPexQueryApi();
final String configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration.
final String queryId = queryId_example; // String | The ID of the query.

try {
    api.deletePexQueryById(configurationId, queryId);
} catch on DioException (e) {
    print('Exception when calling PexQueryApi->deletePexQueryById: $e\n');
}

Parameters

Name Type Description Notes
configurationId String ID of the Affinidi Iota Framework configuration.
queryId String The ID of the query.

Return type

void (empty response body)

Authorization

ProjectTokenAuth

HTTP request headers

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

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

getPexQueryById

PexQueryDto getPexQueryById(configurationId, queryId)

Retrieves a Presentation Definition in the configuration by ID.

Example

import 'package:affinidi_tdk_iota_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api = AffinidiTdkIotaClient().getPexQueryApi();
final String configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration.
final String queryId = queryId_example; // String | The ID of the query.

try {
    final response = api.getPexQueryById(configurationId, queryId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PexQueryApi->getPexQueryById: $e\n');
}

Parameters

Name Type Description Notes
configurationId String ID of the Affinidi Iota Framework configuration.
queryId String The ID of the query.

Return type

PexQueryDto

Authorization

ProjectTokenAuth

HTTP request headers

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

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

listPexQueries

ListPexQueriesOK listPexQueries(configurationId, limit, exclusiveStartKey)

Lists all Presentation Definitions in the configuration.

Example

import 'package:affinidi_tdk_iota_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api = AffinidiTdkIotaClient().getPexQueryApi();
final String configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration.
final int limit = 56; // int | Maximum number of records to fetch in a list
final String exclusiveStartKey = exclusiveStartKey_example; // String | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.

try {
    final response = api.listPexQueries(configurationId, limit, exclusiveStartKey);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PexQueryApi->listPexQueries: $e\n');
}

Parameters

Name Type Description Notes
configurationId String ID of the Affinidi Iota Framework configuration.
limit int Maximum number of records to fetch in a list [optional]
exclusiveStartKey String The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. [optional]

Return type

ListPexQueriesOK

Authorization

ProjectTokenAuth

HTTP request headers

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

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

savePexQueries

JsonObject savePexQueries(configurationId, savePexQueriesUpdateInput)

Saves all Presentation Definition queries of a configuration.

Example

import 'package:affinidi_tdk_iota_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api = AffinidiTdkIotaClient().getPexQueryApi();
final String configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration.
final SavePexQueriesUpdateInput savePexQueriesUpdateInput = ; // SavePexQueriesUpdateInput | SavePexQueriesInput

try {
    final response = api.savePexQueries(configurationId, savePexQueriesUpdateInput);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PexQueryApi->savePexQueries: $e\n');
}

Parameters

Name Type Description Notes
configurationId String ID of the Affinidi Iota Framework configuration.
savePexQueriesUpdateInput SavePexQueriesUpdateInput SavePexQueriesInput

Return type

JsonObject

Authorization

ProjectTokenAuth

HTTP request headers

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

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

updatePexQueryById

PexQueryDto updatePexQueryById(configurationId, queryId, updatePexQueryInput)

Updates the Presentation Definition in the configuration by ID.

Example

import 'package:affinidi_tdk_iota_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api = AffinidiTdkIotaClient().getPexQueryApi();
final String configurationId = configurationId_example; // String | ID of the Affinidi Iota Framework configuration.
final String queryId = queryId_example; // String | The ID of the query.
final UpdatePexQueryInput updatePexQueryInput = ; // UpdatePexQueryInput | UpdatePexQueryById

try {
    final response = api.updatePexQueryById(configurationId, queryId, updatePexQueryInput);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PexQueryApi->updatePexQueryById: $e\n');
}

Parameters

Name Type Description Notes
configurationId String ID of the Affinidi Iota Framework configuration.
queryId String The ID of the query.
updatePexQueryInput UpdatePexQueryInput UpdatePexQueryById

Return type

PexQueryDto

Authorization

ProjectTokenAuth

HTTP request headers

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

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