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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventSourcePerspective:
    event_source_id: int = 0
    event_source_system: Optional[str] = None
    event_source_version: Optional[str] = None
    perspective_id: int = 0
    perspective_name: Optional[str] = None
    is_active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEventSourcePerspectiveResponse:
    event_source_perspectives: Optional[List[EventSourcePerspective]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEventSourcePerspectiveRequest(IGet):
    # @ApiMember(DataType="boolean", Description="Flag to indicate if to return only active perspectives (false) or all (true)", IsRequired=true)
    include_inactive: bool = False
    """
    Flag to indicate if to return only active perspectives (false) or all (true)
    """

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