Jump to

• Request
• Response

Get a Custom Event Field by ID

get

/api/event/customEventFields/{id}

Gets the custom event field that matches the specified ID and query parameters.

Request

Path Parameters

• id(required): integer
  The custom event field ID.

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The properties of the specified custom event field.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventCustomEventFieldsReadByID"
                    }
                }
            }
        }
    ]
}

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
  The properties of the specified custom event field.
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Nested Schema : data

Type: array

The properties of the specified custom event field.

Show Source

• Array of: object eventCustomEventFieldsReadByID

{
    "description":"The properties of the specified custom event field.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventCustomEventFieldsReadByID"
    }
}

Nested Schema : eventCustomEventFieldsReadByID

Type: object

Show Source

• DefaultAsExpression: boolean
  Indicates if the default value is an expression (1) or literal (0).

  Example: 1
• DefaultNull: boolean
  Indicates if the default value is null (1) or not (0).

  Example: 0
• DefaultValue: string
  Default value for the field. It can be a literal value based on the field type or an expression.

  Example: CURRENT_TIMESTAMP
• EventSchemaID: integer
  The custom event field ID.

  Example: 2
• FieldName: string
  The custom event field name.

  Example: Example
• FieldType: string
  The custom event field data type.

  Example: TIMESTAMP
• IndexType: string
  The short code for the index type. For example, MUL for Standard or <None> for no index type.

  Example: MUL
• IndexTypeDisplayName: string
  Human-readable name for the index type. For example, Standard.

  Example: Standard

{
    "type":"object",
    "properties":{
        "EventSchemaID":{
            "type":"integer",
            "description":"The custom event field ID.",
            "example":"2"
        },
        "FieldName":{
            "type":"string",
            "description":"The custom event field name.",
            "example":"Example"
        },
        "FieldType":{
            "type":"string",
            "description":"The custom event field data type.",
            "example":"TIMESTAMP"
        },
        "IndexTypeDisplayName":{
            "type":"string",
            "description":"Human-readable name for the index type. For example, <b>Standard</b>.",
            "example":"Standard"
        },
        "IndexType":{
            "type":"string",
            "description":"The short code for the index type. For example, <b>MUL</b> for Standard or <b>&lt;None></b> for no index type.",
            "example":"MUL"
        },
        "DefaultNull":{
            "type":"boolean",
            "description":"Indicates if the default value is null (<b>1</b>) or not (<b>0</b>).",
            "example":"0"
        },
        "DefaultValue":{
            "type":"string",
            "description":"Default value for the field. It can be a literal value based on the field type or an expression.",
            "example":"CURRENT_TIMESTAMP"
        },
        "DefaultAsExpression":{
            "type":"boolean",
            "description":"Indicates if the default value is an expression (<b>1</b>) or literal (<b>0</b>).",
            "example":"1"
        }
    }
}

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