Jump to

• Request
• Response

Get an Event Display Conversion by Field Name

get

/api/event/DisplayConversions/{id}

Gets the event display conversion that matches the specified field name.

Request

Path Parameters

• id(required): string
  The field name to retrieve the conversion for.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventDisplayConversionRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventDisplayConversionRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object eventDisplayConversionRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventDisplayConversionRead"
    }
}

Nested Schema : eventDisplayConversionRead

Type: object

Show Source

• ConversionCount: integer
  The number of conversions related to the field

  Example: 3
• Conversions: array Conversions
  List of unordered conversions for the given field. Array of field value conversion mappings
• Field: string
  Name of Events field

  Example: EventCategory
• FieldID: string
  Name of Events field.

  Example: EventCategory

{
    "type":"object",
    "properties":{
        "FieldID":{
            "description":"Name of Events field.",
            "type":"string",
            "example":"EventCategory"
        },
        "Field":{
            "description":"Name of Events field",
            "type":"string",
            "example":"EventCategory"
        },
        "ConversionCount":{
            "description":"The number of conversions related to the field",
            "type":"integer",
            "example":"3"
        },
        "Conversions":{
            "description":"List of unordered conversions for the given field. Array of field value conversion mappings",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "CompareValue":{
                        "description":"DB value in the Event database in the related field",
                        "type":"integer",
                        "example":1
                    },
                    "DisplayValue":{
                        "description":"Converted value the user will see instead of the raw DB value",
                        "type":"string",
                        "example":"Resolution"
                    }
                }
            },
            "example":[
                {
                    "CompareValue":1,
                    "DisplayValue":"Resolution"
                },
                {
                    "CompareValue":2,
                    "DisplayValue":"Problem"
                },
                {
                    "CompareValue":3,
                    "DisplayValue":"Discrete"
                }
            ]
        }
    }
}

Nested Schema : Conversions

Type: array

List of unordered conversions for the given field. Array of field value conversion mappings

Show Source

• Array of: object items

{
    "description":"List of unordered conversions for the given field. Array of field value conversion mappings",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "CompareValue":{
                "description":"DB value in the Event database in the related field",
                "type":"integer",
                "example":1
            },
            "DisplayValue":{
                "description":"Converted value the user will see instead of the raw DB value",
                "type":"string",
                "example":"Resolution"
            }
        }
    },
    "example":[
        {
            "CompareValue":1,
            "DisplayValue":"Resolution"
        },
        {
            "CompareValue":2,
            "DisplayValue":"Problem"
        },
        {
            "CompareValue":3,
            "DisplayValue":"Discrete"
        }
    ]
}

Example:

[
    {
        "CompareValue":1,
        "DisplayValue":"Resolution"
    },
    {
        "CompareValue":2,
        "DisplayValue":"Problem"
    },
    {
        "CompareValue":3,
        "DisplayValue":"Discrete"
    }
]

Nested Schema : items

Type: object

Show Source

• CompareValue: integer
  DB value in the Event database in the related field

  Example: 1
• DisplayValue: string
  Converted value the user will see instead of the raw DB value

  Example: Resolution

{
    "type":"object",
    "properties":{
        "CompareValue":{
            "description":"DB value in the Event database in the related field",
            "type":"integer",
            "example":1
        },
        "DisplayValue":{
            "description":"Converted value the user will see instead of the raw DB value",
            "type":"string",
            "example":"Resolution"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top