Skip to content

Latest commit

 

History

History
237 lines (146 loc) · 9.6 KB

CustomAttributeTemplatesApi.md

File metadata and controls

237 lines (146 loc) · 9.6 KB

CustomAttributeTemplatesApi

All URIs are relative to http://localhost

Method HTTP request Description
apiV2CustomAttributesTemplatesIdCustomAttributesExcludePost POST /api/v2/customAttributes/templates/{id}/customAttributes/exclude Exclude CustomAttributes from CustomAttributeTemplate
apiV2CustomAttributesTemplatesIdCustomAttributesIncludePost POST /api/v2/customAttributes/templates/{id}/customAttributes/include Include CustomAttributes to CustomAttributeTemplate
apiV2CustomAttributesTemplatesIdDelete DELETE /api/v2/customAttributes/templates/{id} Delete CustomAttributeTemplate
apiV2CustomAttributesTemplatesIdGet GET /api/v2/customAttributes/templates/{id} Get CustomAttributeTemplate by ID
apiV2CustomAttributesTemplatesNameGet GET /api/v2/customAttributes/templates/{name} Get CustomAttributeTemplate by name
apiV2CustomAttributesTemplatesPost POST /api/v2/customAttributes/templates Create CustomAttributeTemplate
apiV2CustomAttributesTemplatesPut PUT /api/v2/customAttributes/templates Update custom attributes template
apiV2CustomAttributesTemplatesSearchPost POST /api/v2/customAttributes/templates/search Search CustomAttributeTemplates

apiV2CustomAttributesTemplatesIdCustomAttributesExcludePost

apiV2CustomAttributesTemplatesIdCustomAttributesExcludePost(id, request_body)

Exclude CustomAttributes from CustomAttributeTemplate

<br>Use case  <br>User sets attribute template internal identifier  <br>User sets attribute internal identifiers   <br>User runs method execution  <br>System delete attributes from attributes tempalte

Parameters

Name Type Description Notes
id UUID Attribute template internal (UUID) identifier [default to null]
request_body Set [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

apiV2CustomAttributesTemplatesIdCustomAttributesIncludePost

apiV2CustomAttributesTemplatesIdCustomAttributesIncludePost(id, request_body)

Include CustomAttributes to CustomAttributeTemplate

<br>Use case  <br>User sets attribute template internal identifier  <br>User sets attribute internal identifiers   <br>User runs method execution  <br>System add attributes to attributes tempalte

Parameters

Name Type Description Notes
id UUID Attribute template internal (UUID) identifier [default to null]
request_body Set [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

apiV2CustomAttributesTemplatesIdDelete

NoContentResult apiV2CustomAttributesTemplatesIdDelete(id)

Delete CustomAttributeTemplate

<br>Use case  <br>User sets attribute template internal identifier  <br>User runs method execution  <br>System search and delete attribute template  <br>System returns no content response

Parameters

Name Type Description Notes
id UUID Attribute template internal (UUID) identifier [default to null]

Return type

NoContentResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

apiV2CustomAttributesTemplatesIdGet

CustomAttributeTemplateModel apiV2CustomAttributesTemplatesIdGet(id)

Get CustomAttributeTemplate by ID

<br>Use case  <br>User sets attribute template internal identifier   <br>User runs method execution  <br>System return attribute template (listed in response example)

Parameters

Name Type Description Notes
id UUID CustomAttributeTemplate internal (UUID) identifier [default to null]

Return type

CustomAttributeTemplateModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

apiV2CustomAttributesTemplatesNameGet

CustomAttributeTemplateModel apiV2CustomAttributesTemplatesNameGet(name)

Get CustomAttributeTemplate by name

<br>Use case  <br>User sets attribute template name  <br>User runs method execution  <br>System search and return list of attribute templates (listed in response example)

Parameters

Name Type Description Notes
name String CustomAttributeTemplate name for search [default to null]

Return type

CustomAttributeTemplateModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

apiV2CustomAttributesTemplatesPost

CustomAttributeTemplateModel apiV2CustomAttributesTemplatesPost(CustomAttributeTemplatePostModel)

Create CustomAttributeTemplate

<br>Use case  <br>User sets attribute template parameters (listed in request example)  <br>User runs method execution  <br>System creates attribute template  <br>System returns attribute template model (example listed in response parameters)

Parameters

Name Type Description Notes
CustomAttributeTemplatePostModel CustomAttributeTemplatePostModel [optional]

Return type

CustomAttributeTemplateModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

apiV2CustomAttributesTemplatesPut

apiV2CustomAttributesTemplatesPut(CustomAttributeTemplatePutModel)

Update custom attributes template

Parameters

Name Type Description Notes
CustomAttributeTemplatePutModel CustomAttributeTemplatePutModel [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

apiV2CustomAttributesTemplatesSearchPost

List apiV2CustomAttributesTemplatesSearchPost(Skip, Take, OrderBy, SearchField, SearchValue, CustomAttributeTemplateSearchQueryModel)

Search CustomAttributeTemplates

<br>Use case  <br>User sets search params model (listed in request example)  <br>User runs method execution  <br>System return attribute templates (listed in response example)

Parameters

Name Type Description Notes
Skip Integer Amount of items to be skipped (offset) [optional] [default to null]
Take Integer Amount of items to be taken (limit) [optional] [default to null]
OrderBy String SQL-like ORDER BY statement (column1 ASC DESC , column2 ASC
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]
CustomAttributeTemplateSearchQueryModel CustomAttributeTemplateSearchQueryModel [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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