Skip to content

AttributesApi.md

Latest commit

 

History

History
258 lines (178 loc) · 8.03 KB

AttributesApi.md

File metadata and controls

258 lines (178 loc) · 8.03 KB

dart_sdk.api.AttributesApi

Load the API package

import 'package:dart_sdk/api.dart';

All URIs are relative to https://api.techcell.cloud

Method HTTP request Description
attributesControllerCreateAttribute POST /api/attributes
attributesControllerDeleteAttribute DELETE /api/attributes/{id}
attributesControllerGetAttribute GET /api/attributes/{id}
attributesControllerGetAttributes GET /api/attributes
attributesControllerUpdateAttribute PATCH /api/attributes/{id}

attributesControllerCreateAttribute

attributesControllerCreateAttribute(createAttributeDto)

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AttributesApi();
final createAttributeDto = CreateAttributeDto(); // CreateAttributeDto | 

try {
    api_instance.attributesControllerCreateAttribute(createAttributeDto);
} catch (e) {
    print('Exception when calling AttributesApi->attributesControllerCreateAttribute: $e\n');
}

Parameters

Name Type Description Notes
createAttributeDto CreateAttributeDto

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

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

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

attributesControllerDeleteAttribute

attributesControllerDeleteAttribute(id)

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AttributesApi();
final id = 66164ef6c4165e4833949722; // String | 

try {
    api_instance.attributesControllerDeleteAttribute(id);
} catch (e) {
    print('Exception when calling AttributesApi->attributesControllerDeleteAttribute: $e\n');
}

Parameters

Name Type Description Notes
id String

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

attributesControllerGetAttribute

Attribute attributesControllerGetAttribute(id)

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AttributesApi();
final id = 66164ef6c4165e4833949722; // String | 

try {
    final result = api_instance.attributesControllerGetAttribute(id);
    print(result);
} catch (e) {
    print('Exception when calling AttributesApi->attributesControllerGetAttribute: $e\n');
}

Parameters

Name Type Description Notes
id String

Return type

Attribute

Authorization

bearer

HTTP request headers

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

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

attributesControllerGetAttributes

AttributeInfinityPaginationResult attributesControllerGetAttributes(page, limit, filters, sort)

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AttributesApi();
final page = 8.14; // num | 
final limit = 8.14; // num | 
final filters = filters_example; // String | JSON string of FilterAttributeDto
final sort = sort_example; // String | JSON string of SortAttributeDto

try {
    final result = api_instance.attributesControllerGetAttributes(page, limit, filters, sort);
    print(result);
} catch (e) {
    print('Exception when calling AttributesApi->attributesControllerGetAttributes: $e\n');
}

Parameters

Name Type Description Notes
page num [optional]
limit num [optional]
filters String JSON string of FilterAttributeDto [optional]
sort String JSON string of SortAttributeDto [optional]

Return type

AttributeInfinityPaginationResult

Authorization

bearer

HTTP request headers

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

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

attributesControllerUpdateAttribute

attributesControllerUpdateAttribute(id, updateAttributeDto)

Example

import 'package:dart_sdk/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AttributesApi();
final id = 66164ef6c4165e4833949722; // String | 
final updateAttributeDto = UpdateAttributeDto(); // UpdateAttributeDto | 

try {
    api_instance.attributesControllerUpdateAttribute(id, updateAttributeDto);
} catch (e) {
    print('Exception when calling AttributesApi->attributesControllerUpdateAttribute: $e\n');
}

Parameters

Name Type Description Notes
id String
updateAttributeDto UpdateAttributeDto

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

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

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