Previous Next JavaScript must be enabled to correctly display this content

## Get all valid event

get

/event

This endpoint is used to get all valid event maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- authStat(optional): string
- evtCategory(optional): string
- evtCode(optional): string
- evtDesc(optional): string
- evtIsEnabled(optional): string
- evtTopic(optional): string
- includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- recordStat(optional): string

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of success or failure
Headers

- Location: string

Body ()
Root Schema : LmmTmEventsCollection
Type: `object`
Collection of events.
Show Source

- data(optional): array data
- paging(optional): object PagingDto

    {
        "description":"Collection of events.",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmEventsDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmmTmEventsDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmEventsDTO"
        }
    }

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

    {
        "type":"object",
        "properties":{
            "totalResults":{
                "type":"integer"
            }
        }
    }

Nested Schema : LmmTmEventsDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmmTmEventsDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "evtCode":{
                        "type":"string",
                        "description":"",
                        "maxLength":50
                    },
                    "evtCategory":{
                        "type":"string",
                        "description":"",
                        "maxLength":20
                    },
                    "evtDesc":{
                        "type":"string",
                        "description":"",
                        "maxLength":100
                    },
                    "evtTopic":{
                        "type":"string",
                        "description":"",
                        "maxLength":50
                    },
                    "evtIsEnabled":{
                        "type":"string",
                        "description":"",
                        "maxLength":1
                    }
                },
                "required":[
                    "id",
                    "evtCode"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : LmmTmEventsDTO-allOf[1]
Type: `object`
Show Source

- evtCategory(optional): string
  Maximum Length: `20`
- evtCode: string
  Maximum Length: `50`
- evtDesc(optional): string
  Maximum Length: `100`
- evtIsEnabled(optional): string
  Maximum Length: `1`
- evtTopic(optional): string
  Maximum Length: `50`

    {
        "type":"object",
        "properties":{
            "evtCode":{
                "type":"string",
                "description":"",
                "maxLength":50
            },
            "evtCategory":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "evtDesc":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "evtTopic":{
                "type":"string",
                "description":"",
                "maxLength":50
            },
            "evtIsEnabled":{
                "type":"string",
                "description":"",
                "maxLength":1
            }
        },
        "required":[
            "id",
            "evtCode"
        ]
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 405 Response

Invalid input

#### 500 Response

Internal error
Back to Top