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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEventSourcePerspectiveResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.RiskStore.ServiceModel.Requests">
  <EventSourcePerspectives xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nephila.RiskStore.ServiceModel.Types">
    <d2p1:EventSourcePerspective>
      <d2p1:EventSourceId>0</d2p1:EventSourceId>
      <d2p1:EventSourceSystem>String</d2p1:EventSourceSystem>
      <d2p1:EventSourceVersion>String</d2p1:EventSourceVersion>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:PerspectiveId>0</d2p1:PerspectiveId>
      <d2p1:PerspectiveName>String</d2p1:PerspectiveName>
    </d2p1:EventSourcePerspective>
  </EventSourcePerspectives>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetEventSourcePerspectiveResponse>