Nephila RiskStore

<back to all web services

GetEventSetMetricsRequest

EventSets
Requires Authentication
The following routes are available for this service:
GET/api/riskstore/eventset/metricsGet event set metrics, used by the Excel Add-On
"use strict";
export class DealEventSetMetric {
    /** @param {{sourceModelSystem?:string,modelId?:string,sourceEventSetId?:string,eventSetId?:number,perspectiveId?:number,elAgg?:number,elOcc?:number,pAtt?:number,pExh?:number,sourceDealId?:string,sourceDealSystem?:string,approvedDateTimeUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    sourceModelSystem;
    /** @type {string} */
    modelId;
    /** @type {string} */
    sourceEventSetId;
    /** @type {number} */
    eventSetId;
    /** @type {number} */
    perspectiveId;
    /** @type {?number} */
    elAgg;
    /** @type {?number} */
    elOcc;
    /** @type {?number} */
    pAtt;
    /** @type {?number} */
    pExh;
    /** @type {string} */
    sourceDealId;
    /** @type {string} */
    sourceDealSystem;
    /** @type {string} */
    approvedDateTimeUtc;
}
export class GetEventSetMetricsResponse {
    /** @param {{dealEventSetMetrics?:DealEventSetMetric[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DealEventSetMetric[]} */
    dealEventSetMetrics;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetEventSetMetricsRequest {
    /** @param {{analysisId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The analysis id to get the event set metrics for */
    analysisId;
}

JavaScript GetEventSetMetricsRequest 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/eventset/metrics HTTP/1.1 
Host: riskstoreng-dev.nephila.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	dealEventSetMetrics: 
	[
		{
			sourceModelSystem: String,
			modelId: String,
			sourceEventSetId: String,
			eventSetId: 0,
			perspectiveId: 0,
			elAgg: 0,
			elOcc: 0,
			pAtt: 0,
			pExh: 0,
			sourceDealId: String,
			sourceDealSystem: String,
			approvedDateTimeUtc: 0001-01-01
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}