Create an Event Display Conversion
post
/api/event/DisplayConversions
Create a new event display conversion.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Conversions: array
Conversions
List of unordered conversions for the given field. Array of field value conversion mappings
-
Field: string
Name of Events fieldExample:
EventCategory
Nested Schema : Conversions
Type:
array
List of unordered conversions for the given field. Array of field value conversion mappings
Show Source
Example:
[
{
"CompareValue":1,
"DisplayValue":"Resolution"
},
{
"CompareValue":2,
"DisplayValue":"Problem"
},
{
"CompareValue":3,
"DisplayValue":"Discrete"
}
]
Nested Schema : items
Type:
Show Source
object
-
CompareValue: integer
DB value in the Event database in the related fieldExample:
1
-
DisplayValue: string
Converted value the user will see instead of the raw DB valueExample:
Resolution
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new event display conversion.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventDisplayConversionRead
Type:
Show Source
object
-
ConversionCount: integer
The number of conversions related to the fieldExample:
3
-
Conversions: array
Conversions
List of unordered conversions for the given field. Array of field value conversion mappings
-
Field: string
Name of Events fieldExample:
EventCategory
-
FieldID: string
Name of Events field.Example:
EventCategory
Nested Schema : Conversions
Type:
array
List of unordered conversions for the given field. Array of field value conversion mappings
Show Source
Example:
[
{
"CompareValue":1,
"DisplayValue":"Resolution"
},
{
"CompareValue":2,
"DisplayValue":"Problem"
},
{
"CompareValue":3,
"DisplayValue":"Discrete"
}
]
Nested Schema : items
Type:
Show Source
object
-
CompareValue: integer
DB value in the Event database in the related fieldExample:
1
-
DisplayValue: string
Converted value the user will see instead of the raw DB valueExample:
Resolution
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object