{"type":"api","title":"Test Custom Trap Event","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/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":"Test Custom Trap Event","description":"Tests a custom trap event with the provided device details and trap OID. \u003cbr\u003e\n \u003cbr\u003e\n **Mandatory Fields:**\n `deviceIp`,\n `deviceUuid`,\n `trapOid`,\n `varbinds`,\n `varbindOid`,\n `value`,\n `dataType`\n \u003cbr\u003e\n **Optional Fields:**\n `deviceName`\n \u003cbr\u003e\n `Varbinds -\u003e dataType` : Possible values include \"ASN_TIMETICKS\", \"ASN_OBJECT_ID\", \"ASN_OCTETSTRING\",\"ASN_INTEGER\",\"ASN_UINTEGER\",\"ASN_COUNTER32\",\"ASN_GAUGE32\". \u003cbr\u003e","operationId":"testCustomTrap","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request object for testing trap events","properties":{"deviceName":{"type":"string","description":"Name of the device used in testing","example":"ncs540-125"},"deviceIp":{"type":"string","description":"IP address of the device used in testing","example":"3.4.5.6"},"deviceUuid":{"type":"string","description":"UUID of the device used in testing","example":"e9975024-1774-4d64-b855-ee1032a0df21"},"trapOid":{"type":"string","description":"OID of the trap used in testing","example":"1.3.6.1.4.1.9.9.276.0.1"},"varbinds":{"type":"array","description":"Varbinds used in the trap test","items":{"type":"object","properties":{"varbindOid":{"type":"string","description":"OID of the varbind","example":"1.3.6.1.2.1.31.1.1.1.1.45"},"value":{"type":"string","description":"Value associated with the varbind","example":"TenGigE0/0/0/20"},"dataType":{"type":"string","description":"Data type of the varbind value","example":"ASN_OCTETSTRING"}},"required":["varbindOid","value","dataType"]}}},"required":["deviceIp","deviceUuid","trapOid","varbinds"],"$$ref":"#/components/schemas/TrapTestRequest"}}},"required":true},"responses":{"200":{"description":"Trap event tested successfully","content":{"application/json":{"schema":{"type":"object","description":"Response object for testing trap events","properties":{"status":{"type":"string","description":"Status of the trap test operation","example":"Success/Fail"},"message":{"type":"string","description":"Message indicating the result of the trap test operation","example":"error-message"}},"$$ref":"#/components/schemas/TrapTestResponse"}}}},"403":{"description":"Authentication and Authorization errors"},"500":{"description":"operation-failed Response with error"}},"__originalOperationId":"testCustomTrap","method":"post","path":"/custom/trap/test"}}