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
"use strict";
export class EventSourcePerspective {
    /** @param {{eventSourceId?:number,eventSourceSystem?:string,eventSourceVersion?:string,perspectiveId?:number,perspectiveName?:string,isActive?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    eventSourceId;
    /** @type {string} */
    eventSourceSystem;
    /** @type {string} */
    eventSourceVersion;
    /** @type {number} */
    perspectiveId;
    /** @type {string} */
    perspectiveName;
    /** @type {boolean} */
    isActive;
}
export class GetEventSourcePerspectiveResponse {
    /** @param {{eventSourcePerspectives?:EventSourcePerspective[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {EventSourcePerspective[]} */
    eventSourcePerspectives;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetEventSourcePerspectiveRequest {
    /** @param {{includeInactive?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {boolean}
     * @description Flag to indicate if to return only active perspectives (false) or all (true) */
    includeInactive;
}

JavaScript GetEventSourcePerspectiveRequest DTOs

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
		}
	}
}