POST api/IndexedTagValues/CreateCustomTag

Create a Custom Tag

Request Information

URI Parameters

None.

Body Parameters

Custom Tag parameters

CustomTag
NameDescriptionTypeAdditional information
Name

CCustom Tag Name

string

None.

Type

Data type. String (0), Double (1), Integer (2), DateTime (3), Currency (4)

integer

None.

MultiplyValues

Multiple values can be assigned to the same file (Keywords, Categories).

boolean

None.

Hierarchy

Tag values can be hierarchical (Keywords, Categories)

boolean

None.

AllowSynonyms

boolean

None.

LimitedNumber

Tag has a limited number of values that can be assigned to multiple files

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "type": 2,
  "multiplyValues": true,
  "hierarchy": true,
  "allowSynonyms": true,
  "limitedNumber": true
}

application/xml, text/xml

Sample:
<CustomTag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <AllowSynonyms>true</AllowSynonyms>
  <Hierarchy>true</Hierarchy>
  <LimitedNumber>true</LimitedNumber>
  <MultiplyValues>true</MultiplyValues>
  <Name>sample string 1</Name>
  <Type>2</Type>
</CustomTag>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomTag'.

Response Information

Resource Description

Returns true if tag was successfully created (check Data), false if an error occured (check Error).

ObjResultOfBoolean
NameDescriptionTypeAdditional information
Data

boolean

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "data": true,
  "error": "sample string 2",
  "success": true,
  "errorCode": 4
}

application/xml, text/xml

Sample:
<ObjResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>4</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 2</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Data>true</Data>
</ObjResultOfboolean>
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

tag

Custom Tag Parameters

Property Description
Name (String)
            CCustom Tag Name
            
Type (Int32)
            Data type. String (0), Double (1), Integer (2), DateTime (3), Currency (4)
            
MultiplyValues (Boolean)
            Multiple values can be assigned to the same file (Keywords, Categories).
            
Hierarchy (Boolean)
            Tag values can be hierarchical (Keywords, Categories)
            
AllowSynonyms (Boolean)

				
LimitedNumber (Boolean)
            Tag has a limited number of values that can be assigned to multiple files
            
}