{"type":"api","title":"Get All Custom Event Types","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/3ba2ebf1-2c82-351f-9129-0701a2a03db6","info":{"title":"APIs exposed by Alarm Rest service","description":"APIs exposed by Alarm Rest service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/fault-emf-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/alarm/v1","description":"Generated server url"}]},"spec":{"tags":["alarm-rest"],"summary":"Get All Custom Event Types","description":"Retrieves all custom event types based on the provided filters.\u003cbr\u003e \u003cbr\u003e `createdThrough`: Possible values include \"syslog\", \"trap\", \"subeventtype\" . \u003cbr\u003e\n `defaultSeverity`: Possible values include \"Critical\", \"Major\", \"Minor\", \"Warning\", \"Information\", \"Cleared\". \u003cbr\u003e\n `sortParams`: Possible values : eventtype.ASC, eventtype.DESC, createdThrough.ASC,createdThrough.DESC, defaultSeverity.ASC, defaultSeverity.DESC,description.ASC,description.DESC. Default – eventtype.ASC\n \u003cbr\u003e ","operationId":"getAllCustomEventTypes","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request object for retrieving custom event types","properties":{"eventType":{"type":"string","description":"Type of custom event","example":"ETHPORT-5-IF_DOWN_ADMIN_DOWN"},"createdThrough":{"type":"string","description":"Method through which the event was created","example":"syslog"},"defaultSeverity":{"type":"array","description":"Default severity levels of the event","items":{"type":"string"},"example":["Critical"]},"description":{"type":"string","description":"Description of the custom event","example":"ETHPORT-5-IF_DOWN_ADMIN_DOWN"},"range":{"type":"string","description":"Range for filtering the events","example":"0-20"},"sortParams":{"type":"string","description":"Parameters for sorting the events","example":"eventtype.DESC"}},"$$ref":"#/components/schemas/EventTypeRequest"}}},"required":true},"responses":{"200":{"description":"Custom event types retrieved successfully","content":{"application/json":{"schema":{"type":"object","description":"Response object for retrieving custom event types","properties":{"eventTypes":{"type":"array","description":"List of custom event types","items":{"type":"object","properties":{"lastUpdated":{"type":"string","description":"Timestamp of the last update","example":"2024-12-05 02:41:03.635"},"description":{"type":"string","description":"Description of the event type","example":"ETHPORT-5-IF_DOWN_ADMIN_DOWN"},"eventType":{"type":"string","description":"Custom event type","example":"ETHPORT-5-IF_DOWN_ADMIN_DOWN"},"createdThrough":{"type":"string","description":"Method through which the event was created","example":"syslog"},"defaultSeverity":{"type":"string","description":"Default severity level of the event","example":"CRITICAL"}}}},"totalCount":{"type":"integer","description":"Total count of custom event types","example":1}},"$$ref":"#/components/schemas/EventTypeResponse"}}}},"403":{"description":"Authentication and Authorization errors"},"500":{"description":"operation-failed Response with error"}},"__originalOperationId":"getAllCustomEventTypes","method":"post","path":"/custom/eventtype"}}