{"type":"api","title":"Get Query Fields","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Events"],"description":"Get query fields","operationId":"getQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"component":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"system"},"value":{"type":"string","example":"System"}},"$$ref":"#/components/schemas/SimpleKeyValueMapping"}},"severityOptions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"system"},"value":{"type":"string","example":"System"}},"$$ref":"#/components/schemas/SimpleKeyValueMapping"}},"timeOptions":{"type":"array","items":{"type":"object","properties":{"enableDateFields":{"type":"boolean","example":false},"key":{"type":"string","example":"last_24_hours"},"value":{"type":"string","example":"Last 24 hours"}},"$$ref":"#/components/schemas/TimeOptions"}}},"$$ref":"#/components/schemas/EventQueryInputResponse"},"examples":{"Query fields":{"description":"Query fields","value":{"data":[{"isRequired":true,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"Event Time","options":[{"enableDateFields":false,"number":"1","value":"Last 1 hour","key":"last_1_hour"},{"enableDateFields":false,"number":"3","isSelected":true,"value":"Last 3 hours","key":"last_3_hours"},{"enableDateFields":false,"number":"6","value":"Last 6 hours","key":"last_6_hours"},{"enableDateFields":false,"number":"12","value":"Last 12 hours","key":"last_12_hours"},{"enableDateFields":false,"number":"24","value":"Last 24 hours","key":"last_24_hours"},{"enableDateFields":false,"number":"168","value":"Last 7 days","key":"last_168_hours"},{"enableDateFields":true,"value":"Custom","key":"custom"}]},{"isRequired":false,"fieldData":{"type":"enum"},"dataType":"string","property":"severity_level","name":"Severity","options":[{"value":"Critical","key":"critical"},{"value":"Major","key":"major"},{"value":"Minor","key":"minor"}],"multiSelect":true},{"isRequired":false,"fieldData":{"type":"url","url":"dataservice/event/component/keyvalue"},"dataType":"string","property":"component","name":"Component","multiSelect":true},{"isRequired":false,"fieldData":{"type":"url","url":"dataservice/device/keyvalue"},"dataType":"string","property":"system_ip","name":"System IP","multiSelect":true},{"isRequired":false,"fieldData":{"type":"url","url":"dataservice/event/types/keyvalue"},"dataType":"string","property":"eventname","name":"Event name","multiSelect":true}]},"$$ref":"#/components/examples/ComViptelaVmanageServerEventResponseQueryFields"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read","method":"get","path":"/event/query/fields"}}