Nephila RiskStore

<back to all web services

GetEventSourcePerspectiveRequest

General
Requires Authentication
The following routes are available for this service:
GET/api/riskstore/eventsource-perspectiveGet event source and their perspectives, used by the Excel Add-On
GetEventSourcePerspectiveRequest Parameters:
NameParameterData TypeRequiredDescription
IncludeInactivequerybooleanYesFlag to indicate if to return only active perspectives (false) or all (true)
GetEventSourcePerspectiveResponse Parameters:
NameParameterData TypeRequiredDescription
EventSourcePerspectivesformList<EventSourcePerspective>No
ResponseStatusformResponseStatusNo
EventSourcePerspective Parameters:
NameParameterData TypeRequiredDescription
EventSourceIdformintNo
EventSourceSystemformstringNo
EventSourceVersionformstringNo
PerspectiveIdformintNo
PerspectiveNameformstringNo
IsActiveformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/riskstore/eventsource-perspective HTTP/1.1 
Host: riskstoreng-dev.nephila.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	eventSourcePerspectives: 
	[
		{
			eventSourceId: 0,
			eventSourceSystem: String,
			eventSourceVersion: String,
			perspectiveId: 0,
			perspectiveName: String,
			isActive: False
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}