SymphonyAI Sensa GraphQL API Reference
Sensa API Documentation
Terms of Service
API Endpoints
https://yoursite.com/graphqlQueries
accounts
Description
Get accounts associated to entity.
Response
Returns an AccountObjectResponse!
Arguments
| Name | Description |
|---|---|
query - AccountObjectInput!
|
Example
Query
query Accounts($query: AccountObjectInput!) {
accounts(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
accountBalance
accountBalanceUpdatedOn
accountCurrency
accountNumber
accountSegment
accountType
createdOn
deletedOn
id
pipelineFamilyName
sourceId
subtype
updatedOn
}
totalRecords
}
}
Variables
{"query": AccountObjectInput}
Response
{
"data": {
"accounts": {
"pageInfo": PageInfo,
"records": [Account],
"totalRecords": 123
}
}
}
checkUsername
Description
Check Username.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
query - CheckUsernameInput!
|
Example
Query
query CheckUsername($query: CheckUsernameInput!) {
checkUsername(query: $query)
}
Variables
{"query": CheckUsernameInput}
Response
{"data": {"checkUsername": false}}
dataList
Description
Retrieve one AML rule list.
Response
Returns a DataListPayload!
Arguments
| Name | Description |
|---|---|
query - DataListFilter!
|
Example
Query
query DataList($query: DataListFilter!) {
dataList(query: $query) {
data
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalRecords
}
}
Variables
{"query": DataListFilter}
Response
{
"data": {
"dataList": {
"data": [{}],
"pageInfo": PageInfo,
"totalRecords": 987
}
}
}
dataLists
Description
Retrieve all AML rules.
Response
Returns a DataListsPayload!
Arguments
| Name | Description |
|---|---|
query - OffsetPaginationInput!
|
Default = {limit: 25, pageNumber: 0} |
Example
Query
query DataLists($query: OffsetPaginationInput!) {
dataLists(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
createdOn
key
value {
...RuleListFragment
}
version
}
totalRecords
}
}
Variables
{"query": {"limit": 25, "pageNumber": 0}}
Response
{
"data": {
"dataLists": {
"pageInfo": PageInfo,
"records": [DataList],
"totalRecords": 123
}
}
}
dataSource
Description
Get metadata for particular data source (i.e., BinaryObject) from pipeline family Bucket.
Response
Returns a BinaryObject!
Arguments
| Name | Description |
|---|---|
query - DataSourceFilterRequest!
|
Example
Query
query DataSource($query: DataSourceFilterRequest!) {
dataSource(query: $query) {
bucket
createdOn
id
lastModified
name
relativePath
size
}
}
Variables
{"query": DataSourceFilterRequest}
Response
{
"data": {
"dataSource": {
"bucket": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"lastModified": "2007-12-03T10:15:30Z",
"name": "abc123",
"relativePath": "abc123",
"size": 123.45
}
}
}
dataSources
Description
Get metadata for data sources (i.e., BinaryObject) from all pipeline family Buckets.
Response
Returns [Bucket!]!
Example
Query
query DataSources {
dataSources {
bucket
landingZone {
bucket
createdOn
id
lastModified
name
relativePath
size
}
name
objects {
bucket
createdOn
id
lastModified
name
relativePath
size
}
pipelineFamilyName
size
}
}
Response
{
"data": {
"dataSources": [
{
"bucket": "abc123",
"landingZone": BinaryObject,
"name": "abc123",
"objects": [BinaryObject],
"pipelineFamilyName": "abc123",
"size": 987.65
}
]
}
}
detectionQueue
Description
Find a detection queue by id.
Response
Returns an AlertQueue
Arguments
| Name | Description |
|---|---|
id - ID!
|
The detection queue ID. |
Example
Query
query DetectionQueue($id: ID!) {
detectionQueue(id: $id) {
alertTypes {
createdOn
creator {
...UserEntityFragment
}
deletedOn
id
name
query
score
updatedOn
version
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
currency
deletedOn
detections {
edges {
...DetectionEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
filters {
logic {
...LogicFragment
}
}
id
label
name
pipelineFamilyName
updatedOn
users {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"detectionQueue": {
"alertTypes": [AlertType],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "abc123",
"currency": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "xyz789",
"label": "abc123",
"name": "abc123",
"pipelineFamilyName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
}
}
detectionStatuses
Description
Retrieve list of all alert statuses.
Response
Returns [DetectionStatus!]!
Example
Query
query DetectionStatuses {
detectionStatuses {
color
hasRiskRating
icon
id
isClosed
label
type
}
}
Response
{
"data": {
"detectionStatuses": [
{
"color": "xyz789",
"hasRiskRating": false,
"icon": "abc123",
"id": "xyz789",
"isClosed": false,
"label": "xyz789",
"type": "xyz789"
}
]
}
}
detections
Description
Find all detections by queue ID.
Response
Returns a DetectionsResponse!
Arguments
| Name | Description |
|---|---|
query - DetectionsInput!
|
Example
Query
query Detections($query: DetectionsInput!) {
detections(query: $query) {
edges {
cursor
node {
...DetectionWithoutTransactionsFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{"query": DetectionsInput}
Response
{
"data": {
"detections": {
"edges": [DetectionWithoutTransactionsEdge],
"pageInfo": LegacyCursorPageInfo,
"totalCount": 987
}
}
}
entityTrades
Use
trades instead. Removal on v6.0.0. Description
Get Entity Trades.
Response
Returns a PaginatedEntityTrades
Arguments
| Name | Description |
|---|---|
query - GetEntityTradesInput!
|
Example
Query
query EntityTrades($query: GetEntityTradesInput!) {
entityTrades(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
amount
amountNorm
beneficiary {
...TradeOriginatorOrBeneficiaryFragment
}
beneficiaryAccountNumber
bookId
buySell
cleanNetPrice
cleanPrice
countryOfResidence
currencyNorm
currencyTwo
dirtyPrice
entityId
expiryDate
farCashSettlementAmount
farLegAmountOne
farLegAmountTwo
farLegCurrencyOne
farLegCurrencyTwo
farLegFxRate
farLegValueDate
fixedRate
fixedRateTwo
floatingRate
floatingRateTwo
id
indexTicker
instrumentDetails
internalTrade
isin
isinInstrument
lastTradeEvent
nearLegAmountTwo
nearLegCurrencyTwo
nearLegFxRate
nearLegValueDate
nominalAmount
notionalTwo
numberOfUnits
originator {
...TradeOriginatorOrBeneficiaryFragment
}
originatorAccountNumber
paymentDate
pipelineFamilyName
quantity
quantityAmount
rulesTriggered {
...TradeRuleFragment
}
settlementAmount
settlementCurrency
settlementDate
strikePrice
tenor
tenorTwo
terminationDate
ticker
tickerInstrument
tradeStatus
tradeType
transactionCurrency
transactionDate
transactionId
transactionType
underlyingSecMarketPrice
unitPrice
workerCode
}
totalRecords
}
}
Variables
{"query": GetEntityTradesInput}
Response
{
"data": {
"entityTrades": {
"pageInfo": PageInfo,
"records": [GetEntityTradesResponse],
"totalRecords": 987
}
}
}
etlStatus
Description
Lookup the status of a Styx ETL job by id.
Response
Returns a JobStatusPayload!
Arguments
| Name | Description |
|---|---|
query - EtlStatusInput!
|
Example
Query
query EtlStatus($query: EtlStatusInput!) {
etlStatus(query: $query) {
error
processId
status
}
}
Variables
{"query": EtlStatusInput}
Response
{
"data": {
"etlStatus": {
"error": "abc123",
"processId": "abc123",
"status": "abc123"
}
}
}
exemptions
Description
Retrieve exemptions.
Response
Returns [ExemptionList!]!
Arguments
| Name | Description |
|---|---|
query - ExemptionsInput!
|
Example
Query
query Exemptions($query: ExemptionsInput!) {
exemptions(query: $query) {
createdOn
endsOn
entityId
pipelineFamilyName
ruleId
ruleSetId
}
}
Variables
{"query": ExemptionsInput}
Response
{
"data": {
"exemptions": [
{
"createdOn": "2007-12-03T10:15:30Z",
"endsOn": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"pipelineFamilyName": "abc123",
"ruleId": "abc123",
"ruleSetId": "xyz789"
}
]
}
}
filterableAttributeValues
Description
Get Filterable Values
Response
Returns a FilterableValuesResponse!
Arguments
| Name | Description |
|---|---|
trades - TradeFilterableValuesInput!
|
Example
Query
query FilterableAttributeValues($trades: TradeFilterableValuesInput!) {
filterableAttributeValues(trades: $trades) {
filterableValues
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"trades": TradeFilterableValuesInput}
Response
{
"data": {
"filterableAttributeValues": {
"filterableValues": ["abc123"],
"pageInfo": CursorPageInfo
}
}
}
flowOfFundsLinks
Response
Returns a RelationshipsLinks!
Arguments
| Name | Description |
|---|---|
query - FlowOfFundsLinksInput!
|
Example
Query
query FlowOfFundsLinks($query: FlowOfFundsLinksInput!) {
flowOfFundsLinks(query: $query) {
edges {
cursor
node {
... on LinkedAccount {
...LinkedAccountFragment
}
... on LinkedEntity {
...LinkedEntityFragment
}
... on LinkedMatch {
...LinkedMatchFragment
}
... on LinkedTransactionSummary {
...LinkedTransactionSummaryFragment
}
}
}
isQueued
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"query": FlowOfFundsLinksInput}
Response
{
"data": {
"flowOfFundsLinks": {
"edges": [DataModelEdge],
"isQueued": true,
"pageInfo": PageInfo
}
}
}
getActiveAndAlertedEntitiesCount
Description
Retrieve list of total active and alerted entities.
Response
Returns [ActiveAlertedEntity!]!
Arguments
| Name | Description |
|---|---|
query - GetActiveAlertedEntitiesInput!
|
Example
Query
query GetActiveAndAlertedEntitiesCount($query: GetActiveAlertedEntitiesInput!) {
getActiveAndAlertedEntitiesCount(query: $query) {
month
totalActive
totalAlerted
year
}
}
Variables
{"query": GetActiveAlertedEntitiesInput}
Response
{
"data": {
"getActiveAndAlertedEntitiesCount": [
{"month": 123, "totalActive": 123, "totalAlerted": 123, "year": 123}
]
}
}
getActivitiesByReferenceId
Description
Retrieve a list of Activitys by alertId.
Response
Returns [ActivityWithNoteAttachments!]!
Arguments
| Name | Description |
|---|---|
query - GetActivitiesInput!
|
Example
Query
query GetActivitiesByReferenceId($query: GetActivitiesInput!) {
getActivitiesByReferenceId(query: $query) {
activityAttributes
activityType
assignedUser {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
attachments {
createdOn
deletedOn
file {
...FileFragment
}
fileId
fileName
id
updatedOn
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
deletedOn
id
ip
message
messageType
referenceId
unassignedUser {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"query": GetActivitiesInput}
Response
{
"data": {
"getActivitiesByReferenceId": [
{
"activityAttributes": {},
"activityType": "Alert",
"assignedUser": UserEntity,
"attachments": [AttachmentWithNote],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"ip": "abc123",
"message": "abc123",
"messageType": "xyz789",
"referenceId": "abc123",
"unassignedUser": UserEntity
}
]
}
}
getAlertCountsByStatus
Description
Retrieve Alert counts by status.
Response
Returns [AlertStatusCount!]!
Arguments
| Name | Description |
|---|---|
query - GetAlertsByInput!
|
Input type of GetAlertCountsByStatus. |
Example
Query
query GetAlertCountsByStatus($query: GetAlertsByInput!) {
getAlertCountsByStatus(query: $query) {
day
escalatedExternally
notRisk
pending
risk
}
}
Variables
{"query": GetAlertsByInput}
Response
{
"data": {
"getAlertCountsByStatus": [
{
"day": 123.45,
"escalatedExternally": 123.45,
"notRisk": 987.65,
"pending": 123.45,
"risk": 123.45
}
]
}
}
getAlertCountsByType
Description
Retrieve Alert counts by type.
Response
Returns [AlertTypeCounts!]!
Arguments
| Name | Description |
|---|---|
query - GetAlertsByInput!
|
Input type of GetAlertCountsByType. |
Example
Query
query GetAlertCountsByType($query: GetAlertsByInput!) {
getAlertCountsByType(query: $query) {
alert_types {
alert_type
count
}
day
}
}
Variables
{"query": GetAlertsByInput}
Response
{
"data": {
"getAlertCountsByType": [
{"alert_types": [AlertTypeCount], "day": 987.65}
]
}
}
getAlertFeatures
Description
Retrieve list of all features for Alert.
Response
Returns a GetAlertFeaturesResponse
Arguments
| Name | Description |
|---|---|
entityId - String
|
ID of Entity. |
featureDate - Date
|
Date of Feature. |
query - GetAlertFeaturesInput
|
Default = {orderBy: {sort: DESC}, page: {limit: 25, pageNumber: 0}} |
Example
Query
query GetAlertFeatures(
$entityId: String,
$featureDate: Date,
$query: GetAlertFeaturesInput
) {
getAlertFeatures(
entityId: $entityId,
featureDate: $featureDate,
query: $query
) {
alerts {
alertDate
anomalyScore
assignedToUserId
category
cibScore
compositeScore
createdOn
decision
deletedOn
detectionType
domainCode
entityDetectionTypesForMonth
hotspotScore
id
overallScore
pipelineFamilyName
ruleIds
rules {
...RuleFragment
}
sourceId
sourceTable
status
subtype
supervisedScore
updatedOn
}
entity {
accounts {
...AccountConnectionFragment
}
activeExemption {
...ExemptionListFragment
}
annualIncome
businessUnit
countryOfResidence
customerSegment
email
entityType
externalEntityId
file {
...FileFragment
}
fullAddress
fullName
furtherInformation
id
label
onboardDate
orgUnitCode
overallRiskScore
phone
pipelineFamilyName
sourceId
sourceName
sourceTable
subtype
}
entityId
featureDate
features {
averageFeatureValue
averagePeerGroupValue
featureName
featureValue
shapValue
}
id
totalRecords
}
}
Variables
{
"entityId": "abc123",
"featureDate": "2007-12-03",
"query": {"orderBy": {"sort": "DESC"}, "page": {"limit": 25, "pageNumber": 0}}
}
Response
{
"data": {
"getAlertFeatures": {
"alerts": [Alert],
"entity": Entity,
"entityId": "abc123",
"featureDate": "2007-12-03T10:15:30Z",
"features": [ShapFeature],
"id": "xyz789",
"totalRecords": 987
}
}
}
getAlertFeaturesList
Replaced by
getDetectionFeaturesList. Removal on v5.0.0. Description
Retrieve list of all feature-list-items for Alert.
Response
Returns [AlertFeatureListItem!]
Example
Query
query GetAlertFeaturesList {
getAlertFeaturesList {
description
inputType
key
}
}
Response
{
"data": {
"getAlertFeaturesList": [
{
"description": "xyz789",
"inputType": "abc123",
"key": "abc123"
}
]
}
}
getAlertNotes
Description
Retrieve a list of Notes by alertId.
Response
Returns [AlertNote!]!
Arguments
| Name | Description |
|---|---|
query - GetNotesInput!
|
Example
Query
query GetAlertNotes($query: GetNotesInput!) {
getAlertNotes(query: $query) {
alertId
attachments {
createdOn
deletedOn
file {
...FileFragment
}
fileId
fileName
id
updatedOn
}
createdOn
deletedOn
id
ip
message
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"query": GetNotesInput}
Response
{
"data": {
"getAlertNotes": [
{
"alertId": "abc123",
"attachments": [AttachmentWithNote],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"ip": "abc123",
"message": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
]
}
}
getAlertQueue
Replaced by
Query.detectionQueue. Description
Retrieve a single AlertQueue.
Response
Returns an AlertQueue!
Arguments
| Name | Description |
|---|---|
query - AlertQueueIdInput!
|
Input type of GetAlertQueue. |
Example
Query
query GetAlertQueue($query: AlertQueueIdInput!) {
getAlertQueue(query: $query) {
alertTypes {
createdOn
creator {
...UserEntityFragment
}
deletedOn
id
name
query
score
updatedOn
version
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
currency
deletedOn
detections {
edges {
...DetectionEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
filters {
logic {
...LogicFragment
}
}
id
label
name
pipelineFamilyName
updatedOn
users {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"query": AlertQueueIdInput}
Response
{
"data": {
"getAlertQueue": {
"alertTypes": [AlertType],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "xyz789",
"currency": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "xyz789",
"label": "xyz789",
"name": "abc123",
"pipelineFamilyName": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
}
}
getAlertQueues
Description
Retrieve all AlertQueues.
Response
Returns [AlertQueueSummary!]!
Example
Query
query GetAlertQueues {
getAlertQueues {
alertTypes {
createdOn
creator {
...UserEntityFragment
}
deletedOn
id
name
query
score
updatedOn
version
}
alerts {
closed
pending
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
currency
deletedOn
detections {
edges {
...DetectionEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
filters {
logic {
...LogicFragment
}
}
id
label
name
pipelineFamilyName
updatedOn
users {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Response
{
"data": {
"getAlertQueues": [
{
"alertTypes": [AlertType],
"alerts": AlertSummary,
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "abc123",
"currency": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "xyz789",
"label": "xyz789",
"name": "abc123",
"pipelineFamilyName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
]
}
}
getAlertStatusFilter
Description
Retrieve list of Alerts statuses.
Response
Returns [AlertStatusFilter!]!
Example
Query
query GetAlertStatusFilter {
getAlertStatusFilter {
status
}
}
Response
{
"data": {
"getAlertStatusFilter": [
{"status": "xyz789"}
]
}
}
getAlertTypes
Description
Retrieve all AlertTypes.
Response
Returns [AlertType!]!
Example
Query
query GetAlertTypes {
getAlertTypes {
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
id
name
query
score
updatedOn
version
}
}
Response
{
"data": {
"getAlertTypes": [
{
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"name": "xyz789",
"query": "xyz789",
"score": 987.65,
"updatedOn": "2007-12-03T10:15:30Z",
"version": 123.45
}
]
}
}
getAllDetections
Description
Retrieve paginated list of Alerts.
Response
Returns a DetectionsPage!
Arguments
| Name | Description |
|---|---|
query - GetAllDetectionsInput!
|
Example
Query
query GetAllDetections($query: GetAllDetectionsInput!) {
getAllDetections(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertDate
anomalyScore
assignedTo {
...AssignedToFragment
}
assignedToUserId
category
cibScore
compositeScore
decision {
...RiskRatingFragment
}
detectionType
domainCode
entity {
...EntityFragment
}
entityDetectionTypesForMonth
hotspotScore
id
overallScore
pipelineFamilyName
ruleIds
rules {
...RuleFragment
}
shap {
...ShapFragment
}
sourceId
sourceTable
status
statusUpdatedOn
subtype
supervisedScore
transactions {
...DetectionTransactionConnectionFragment
}
}
totalRecords
}
}
Variables
{"query": GetAllDetectionsInput}
Response
{
"data": {
"getAllDetections": {
"pageInfo": PageInfo,
"records": [DetectionWithoutDetails],
"totalRecords": 987
}
}
}
getAllFeatureHistoryRecords
Description
Retrieve list of FeatureHistory. Returns FeatureHistory[].
Response
Returns [FeatureHistory!]!
Example
Query
query GetAllFeatureHistoryRecords {
getAllFeatureHistoryRecords {
createDate
entityId
featureName
value
}
}
Response
{
"data": {
"getAllFeatureHistoryRecords": [
{
"createDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"featureName": "abc123",
"value": 987.65
}
]
}
}
getAllFeatureToggles
Description
Retrieve a list of all Feature toggles.
Response
Returns an AllFeatureTogglesDto!
Example
Query
query GetAllFeatureToggles {
getAllFeatureToggles {
toggles {
key
value
}
}
}
Response
{
"data": {
"getAllFeatureToggles": {
"toggles": [FeatureToggleDto]
}
}
}
getAllRiskRatings
Description
Retrieve list of all RiskRatings.
Response
Returns [RiskRating!]!
Example
Query
query GetAllRiskRatings {
getAllRiskRatings {
color
deletedOn
displayOrder
id
label
}
}
Response
{
"data": {
"getAllRiskRatings": [
{
"color": "abc123",
"deletedOn": "2007-12-03",
"displayOrder": 123.45,
"id": "xyz789",
"label": "abc123"
}
]
}
}
getAllRiskScores
Replaced by
Query.riskScores. Removal on v5.0.0. Description
Retrieve paginated list of RiskScores s.
Response
Returns a RiskScoresPage
Arguments
| Name | Description |
|---|---|
query - RiskScoresInput!
|
Example
Query
query GetAllRiskScores($query: RiskScoresInput!) {
getAllRiskScores(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertingFeatures {
...ShapFeatureFragment
}
anomalyScore
cibScore
compositeScore
createdOn
customerData
deletedOn
entityId
hotspotScore
id
pipelineFamilyName
riskScoreDate
riskScoreSource
similarityScore
sourceId
sourceTable
updatedOn
}
totalRecords
}
}
Variables
{"query": RiskScoresInput}
Response
{
"data": {
"getAllRiskScores": {
"pageInfo": PageInfo,
"records": [RiskScore],
"totalRecords": 123
}
}
}
getAppVersion
Description
Retrieve Application Version details.
Response
Returns a GetAppVersionResponse!
Example
Query
query GetAppVersion {
getAppVersion {
api {
ref
sha
}
hermes {
ref
sha
}
ref
sha
styx {
ref
sha
}
}
}
Response
{
"data": {
"getAppVersion": {
"api": AppVersionDetails,
"hermes": AppVersionDetails,
"ref": "xyz789",
"sha": "xyz789",
"styx": AppVersionDetails
}
}
}
getAuditLogs
Description
Retrieve paginated list of Audit Logs.
Response
Returns an AuditLogsPage!
Arguments
| Name | Description |
|---|---|
query - GetAuditLogsInput!
|
Example
Query
query GetAuditLogs($query: GetAuditLogsInput!) {
getAuditLogs(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
activity
actor {
...AuditLogActorFragment
}
auditedObject {
...AuditLogObjectFragment
}
auditedValues {
...AuditLogAuditedAttributeFragment
}
createdOn
id
}
totalRecords
}
}
Variables
{"query": GetAuditLogsInput}
Response
{
"data": {
"getAuditLogs": {
"pageInfo": PageInfo,
"records": [AuditLogDto],
"totalRecords": 123
}
}
}
getCountries
Description
Retrieve pageinated list of legal entity's country of residence associated with Alerts.
Response
Returns [Country!]!
Arguments
| Name | Description |
|---|---|
query - GetCountriesInput!
|
Example
Query
query GetCountries($query: GetCountriesInput!) {
getCountries(query: $query) {
abbreviation
}
}
Variables
{"query": GetCountriesInput}
Response
{
"data": {
"getCountries": [
{"abbreviation": "xyz789"}
]
}
}
getDetectedEntitiesBreakdown
Description
Retrieve summary of Detections by Entity.id and Detection.category.
Response
Returns a DetectedEntitiesBreakdown!
Arguments
| Name | Description |
|---|---|
query - GetDetectedEntitiesBreakdownInput!
|
Example
Query
query GetDetectedEntitiesBreakdown($query: GetDetectedEntitiesBreakdownInput!) {
getDetectedEntitiesBreakdown(query: $query) {
detectedAtLeastOneRuleAndNoScore
detectedAtLeastOneScoreAndNoRule
detectedAtLeastOneScoreAndRule
detectedNoScoreAndNoRule
}
}
Variables
{"query": GetDetectedEntitiesBreakdownInput}
Response
{
"data": {
"getDetectedEntitiesBreakdown": {
"detectedAtLeastOneRuleAndNoScore": 987.65,
"detectedAtLeastOneScoreAndNoRule": 123.45,
"detectedAtLeastOneScoreAndRule": 987.65,
"detectedNoScoreAndNoRule": 123.45
}
}
}
getDetection
Description
Retrieve a single Detection.
Response
Returns a Detection!
Arguments
| Name | Description |
|---|---|
query - GetDetectionInput!
|
Example
Query
query GetDetection($query: GetDetectionInput!) {
getDetection(query: $query) {
alertDate
anomalyScore
assignedTo {
email
first_name
id
imageId
last_name
}
assignedToUserId
category
cibScore
compositeScore
decision {
color
deletedOn
displayOrder
id
label
}
detectionType
domainCode
entity {
accounts {
...AccountConnectionFragment
}
activeExemption {
...ExemptionListFragment
}
annualIncome
businessUnit
countryOfResidence
customerSegment
email
entityType
externalEntityId
file {
...FileFragment
}
fullAddress
fullName
furtherInformation
id
label
onboardDate
orgUnitCode
overallRiskScore
phone
pipelineFamilyName
sourceId
sourceName
sourceTable
subtype
}
entityDetectionTypesForMonth
hotspotScore
id
overallScore
pipelineFamilyName
ruleIds
rules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
shap {
entityId
featureDate
features {
...ShapFeatureFragment
}
id
}
sourceId
sourceTable
status
statusUpdatedOn
subtype
supervisedScore
supplementaryInformation {
edges {
...DetectionRuleDetailsEdgeFragment
}
pageInfo {
...CursorPageInfoFragment
}
totalCount
}
transactions {
edges {
...EventModelEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
}
}
Variables
{"query": GetDetectionInput}
Response
{
"data": {
"getDetection": {
"alertDate": "2007-12-03",
"anomalyScore": 123.45,
"assignedTo": AssignedTo,
"assignedToUserId": "xyz789",
"category": "abc123",
"cibScore": 123.45,
"compositeScore": 987.65,
"decision": RiskRating,
"detectionType": "abc123",
"domainCode": "xyz789",
"entity": Entity,
"entityDetectionTypesForMonth": [
"abc123"
],
"hotspotScore": 123.45,
"id": "xyz789",
"overallScore": 987.65,
"pipelineFamilyName": "abc123",
"ruleIds": ["xyz789"],
"rules": [Rule],
"shap": Shap,
"sourceId": "abc123",
"sourceTable": "abc123",
"status": "abc123",
"statusUpdatedOn": "2007-12-03",
"subtype": "xyz789",
"supervisedScore": 987.65,
"supplementaryInformation": DetectionRuleDetailConnection,
"transactions": DetectionTransactionConnection
}
}
}
getDetectionDetailsAdminSettings
Description
Retrieves Detection Details Admin Settings .
Response
Arguments
| Name | Description |
|---|---|
query - GetDetectionDetailsAdminSettingsInput!
|
Example
Query
query GetDetectionDetailsAdminSettings($query: GetDetectionDetailsAdminSettingsInput!) {
getDetectionDetailsAdminSettings(query: $query) {
id
panels {
id
visibility
}
visibility
}
}
Variables
{"query": GetDetectionDetailsAdminSettingsInput}
Response
{
"data": {
"getDetectionDetailsAdminSettings": [
{
"id": "xyz789",
"panels": [DetectionDetailsAdminSettingsBase],
"visibility": 987.65
}
]
}
}
getDetectionFeaturesList
Description
Retrieve list of all all unique feature names for Detection.
Response
Returns [DetectionFeatureList!]!
Example
Query
query GetDetectionFeaturesList {
getDetectionFeaturesList {
description
inputType
key
}
}
Response
{
"data": {
"getDetectionFeaturesList": [
{
"description": "xyz789",
"inputType": "xyz789",
"key": "xyz789"
}
]
}
}
getDetectionTypesFilter
Description
Retrieve list of all unique Detections types.
Response
Returns [DetectionTypesFilter!]!
Example
Query
query GetDetectionTypesFilter {
getDetectionTypesFilter {
detectionType
}
}
Response
{
"data": {
"getDetectionTypesFilter": [
{"detectionType": "xyz789"}
]
}
}
getDetectionsByQueue
Description
Retrieve paginated list of Detections by queue.
Response
Returns a DetectionsPage!
Arguments
| Name | Description |
|---|---|
query - GetDetectionsByQueueInput!
|
Example
Query
query GetDetectionsByQueue($query: GetDetectionsByQueueInput!) {
getDetectionsByQueue(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertDate
anomalyScore
assignedTo {
...AssignedToFragment
}
assignedToUserId
category
cibScore
compositeScore
decision {
...RiskRatingFragment
}
detectionType
domainCode
entity {
...EntityFragment
}
entityDetectionTypesForMonth
hotspotScore
id
overallScore
pipelineFamilyName
ruleIds
rules {
...RuleFragment
}
shap {
...ShapFragment
}
sourceId
sourceTable
status
statusUpdatedOn
subtype
supervisedScore
transactions {
...DetectionTransactionConnectionFragment
}
}
totalRecords
}
}
Variables
{"query": GetDetectionsByQueueInput}
Response
{
"data": {
"getDetectionsByQueue": {
"pageInfo": PageInfo,
"records": [DetectionWithoutDetails],
"totalRecords": 987
}
}
}
getEntities
Description
Get all Entities
Response
Returns an EntitiesPayload!
Arguments
| Name | Description |
|---|---|
query - GetEntitiesInput!
|
Example
Query
query GetEntities($query: GetEntitiesInput!) {
getEntities(query: $query) {
records {
accounts {
...AccountConnectionFragment
}
activeExemption {
...ExemptionListFragment
}
annualIncome
businessUnit
countryOfResidence
customerSegment
email
entityType
externalEntityId
file {
...FileFragment
}
fullAddress
fullName
furtherInformation
id
label
onboardDate
orgUnitCode
overallRiskScore
phone
pipelineFamilyName
sourceId
sourceName
sourceTable
subtype
}
totalRecords
}
}
Variables
{"query": GetEntitiesInput}
Response
{
"data": {
"getEntities": {
"records": [Entity],
"totalRecords": 987
}
}
}
getEntity
Description
Get Entity.
Response
Returns an Entity!
Arguments
| Name | Description |
|---|---|
query - GetEntityInput!
|
Example
Query
query GetEntity($query: GetEntityInput!) {
getEntity(query: $query) {
accounts {
edges {
...AccountEdgeFragment
}
pageInfo {
...CursorPageInfoFragment
}
totalCount
}
activeExemption {
createdOn
endsOn
entityId
pipelineFamilyName
ruleId
ruleSetId
}
annualIncome
businessUnit
countryOfResidence
customerSegment
email
entityType
externalEntityId
file {
bucket
createdOn
deletedOn
id
mimetype
name
size
type
updatedOn
}
fullAddress
fullName
furtherInformation
id
label
onboardDate
orgUnitCode
overallRiskScore
phone
pipelineFamilyName
sourceId
sourceName
sourceTable
subtype
}
}
Variables
{"query": GetEntityInput}
Response
{
"data": {
"getEntity": {
"accounts": AccountConnection,
"activeExemption": ExemptionList,
"annualIncome": 123.45,
"businessUnit": "xyz789",
"countryOfResidence": "xyz789",
"customerSegment": "abc123",
"email": "xyz789",
"entityType": "abc123",
"externalEntityId": "abc123",
"file": File,
"fullAddress": "xyz789",
"fullName": "xyz789",
"furtherInformation": "abc123",
"id": "xyz789",
"label": "xyz789",
"onboardDate": "2007-12-03T10:15:30Z",
"orgUnitCode": "xyz789",
"overallRiskScore": 123.45,
"phone": "abc123",
"pipelineFamilyName": "xyz789",
"sourceId": "xyz789",
"sourceName": "xyz789",
"sourceTable": "abc123",
"subtype": "abc123"
}
}
}
getEvent
Description
Get Event
Response
Returns an Event!
Arguments
| Name | Description |
|---|---|
input - GetEventInput!
|
Example
Query
query GetEvent($input: GetEventInput!) {
getEvent(input: $input) {
... on WithCorrespondentBankingAttributes {
accountWithInstitution
accountWithInstitutionCountry
attributes {
...CorrespondentBankingAttributesFragment
}
baseCurrency
beneficiaries {
...EntityModelFragment
}
beneficiariesV2 {
...BeneficiariesV2Fragment
}
beneficiaryCustomer
beneficiaryId
beneficiaryInstitution
beneficiaryInstitutionCountry
branchId
buyer
cardId
createdOn
creditDebitFlag
deletedOn
destinationCountry
deviceId
eventDate
file {
...FileFragment
}
financialInstrumentCountry
financialInstrumentDetails
financialInstrumentIsin
financialInstrumentQuantity
functionalAmount
functionalCurrency
id
intermediary
intermediaryCountry
label
orderingCustomer
orderingInstitution
orderingInstitutionCountry
originCountry
originalAmount
originalCurrency
originationDate
originatorId
originators {
...EntityModelFragment
}
originatorsV2 {
...OriginatorsV2Fragment
}
pipelineFamilyName
postingDate
receiverBic
receiverCorrespondent
receiverCorrespondentCountry
region
scope
seller
senderBic
senderCorrespondent
senderCorrespondentCountry
sendingInstitution
sendingInstitutionCountry
settlementBic
settlementPlaceCountry
sourceId
sourceName
sourceSystem
sourceTable
subtype
tellerId
transactionType
transactionTypeDescription
txnId
updatedOn
}
... on WithRetailBankingAttributes {
accountWithInstitution
accountWithInstitutionCountry
attributes {
...RetailBankingAttributesFragment
}
baseCurrency
beneficiaries {
...EntityModelFragment
}
beneficiariesV2 {
...BeneficiariesV2Fragment
}
beneficiaryCustomer
beneficiaryId
beneficiaryInstitution
beneficiaryInstitutionCountry
branchId
buyer
cardId
createdOn
creditDebitFlag
deletedOn
destinationCountry
deviceId
eventDate
file {
...FileFragment
}
financialInstrumentCountry
financialInstrumentDetails
financialInstrumentIsin
financialInstrumentQuantity
functionalAmount
functionalCurrency
id
intermediary
intermediaryCountry
label
orderingCustomer
orderingInstitution
orderingInstitutionCountry
originCountry
originalAmount
originalCurrency
originationDate
originatorId
originators {
...EntityModelFragment
}
originatorsV2 {
...OriginatorsV2Fragment
}
pipelineFamilyName
postingDate
receiverBic
receiverCorrespondent
receiverCorrespondentCountry
region
scope
seller
senderBic
senderCorrespondent
senderCorrespondentCountry
sendingInstitution
sendingInstitutionCountry
settlementBic
settlementPlaceCountry
sourceId
sourceName
sourceSystem
sourceTable
subtype
tellerId
transactionType
transactionTypeDescription
txnId
updatedOn
}
}
}
Variables
{"input": GetEventInput}
Response
{"data": {"getEvent": WithCorrespondentBankingAttributes}}
getEvents
Description
Get Events
Response
Returns a PaginatedEvents!
Arguments
| Name | Description |
|---|---|
query - GetEventsInput!
|
Example
Query
query GetEvents($query: GetEventsInput!) {
getEvents(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
accountWithInstitution
accountWithInstitutionCountry
baseCurrency
beneficiaries {
...EntityModelFragment
}
beneficiariesV2 {
...BeneficiariesV2Fragment
}
beneficiaryCustomer
beneficiaryId
beneficiaryInstitution
beneficiaryInstitutionCountry
branchId
buyer
cardId
createdOn
creditDebitFlag
deletedOn
destinationCountry
deviceId
eventDate
file {
...FileFragment
}
financialInstrumentCountry
financialInstrumentDetails
financialInstrumentIsin
financialInstrumentQuantity
functionalAmount
functionalCurrency
id
intermediary
intermediaryCountry
label
orderingCustomer
orderingInstitution
orderingInstitutionCountry
originCountry
originalAmount
originalCurrency
originationDate
originatorId
originators {
...EntityModelFragment
}
originatorsV2 {
...OriginatorsV2Fragment
}
pipelineFamilyName
postingDate
receiverBic
receiverCorrespondent
receiverCorrespondentCountry
region
scope
seller
senderBic
senderCorrespondent
senderCorrespondentCountry
sendingInstitution
sendingInstitutionCountry
settlementBic
settlementPlaceCountry
sourceId
sourceName
sourceSystem
sourceTable
subtype
tellerId
transactionType
transactionTypeDescription
txnId
updatedOn
}
totalRecords
}
}
Variables
{"query": GetEventsInput}
Response
{
"data": {
"getEvents": {
"pageInfo": PageInfo,
"records": [EventModel],
"totalRecords": 987
}
}
}
getFeatureHistory
Description
Retrieve a single FeatureHistory. Returns FeatureHistory.
Response
Returns a FeatureHistory!
Arguments
| Name | Description |
|---|---|
ids - GetFeatureHistoryInput!
|
Example
Query
query GetFeatureHistory($ids: GetFeatureHistoryInput!) {
getFeatureHistory(ids: $ids) {
createDate
entityId
featureName
value
}
}
Variables
{"ids": GetFeatureHistoryInput}
Response
{
"data": {
"getFeatureHistory": {
"createDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"featureName": "xyz789",
"value": 987.65
}
}
}
getFeatureToggle
Description
Retrieve a Feature toggle.
Response
Returns a FeatureToggleDto!
Arguments
| Name | Description |
|---|---|
query - GetFeatureToggleInput!
|
Example
Query
query GetFeatureToggle($query: GetFeatureToggleInput!) {
getFeatureToggle(query: $query) {
key
value
}
}
Variables
{"query": GetFeatureToggleInput}
Response
{"data": {"getFeatureToggle": {"key": "EntityLinksExplorer", "value": false}}}
getFeatures
Replaced by
Query.getAlertFeatures. Removal on v5.0.0. Description
Get Features.
Response
Returns [Feature!]
Arguments
| Name | Description |
|---|---|
input - GetFeaturesInput!
|
Example
Query
query GetFeatures($input: GetFeaturesInput!) {
getFeatures(input: $input) {
createdOn
deletedOn
entity
features
id
pipeline
runDate
updatedOn
}
}
Variables
{"input": GetFeaturesInput}
Response
{
"data": {
"getFeatures": [
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"entity": "xyz789",
"features": {},
"id": "xyz789",
"pipeline": "abc123",
"runDate": "2007-12-03T10:15:30Z",
"updatedOn": "2007-12-03T10:15:30Z"
}
]
}
}
getFieldSuggestions
Description
Get field suggestions
Response
Returns a FieldSuggestionResponse!
Arguments
| Name | Description |
|---|---|
input - GetFieldsSuggestionsInput!
|
Example
Query
query GetFieldSuggestions($input: GetFieldsSuggestionsInput!) {
getFieldSuggestions(input: $input) {
suggestions
}
}
Variables
{"input": GetFieldsSuggestionsInput}
Response
{
"data": {
"getFieldSuggestions": {
"suggestions": ["xyz789"]
}
}
}
getFile
Description
Get file by file id.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
query - FileInput!
|
Example
Query
query GetFile($query: FileInput!) {
getFile(query: $query)
}
Variables
{"query": FileInput}
Response
{"data": {"getFile": "xyz789"}}
getFileMetadata
Description
Get file metadata by file id.
Response
Returns a FileWithLatestStatus!
Arguments
| Name | Description |
|---|---|
query - FileInput!
|
Example
Query
query GetFileMetadata($query: FileInput!) {
getFileMetadata(query: $query) {
bucket
createdOn
deletedOn
fileStatus {
createdOn
deletedOn
file {
...FileFragment
}
id
info
recordCount
status
updatedOn
}
id
mimetype
name
size
type
updatedOn
}
}
Variables
{"query": FileInput}
Response
{
"data": {
"getFileMetadata": {
"bucket": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"fileStatus": [FileStatus],
"id": "abc123",
"mimetype": "xyz789",
"name": "abc123",
"size": 987.65,
"type": "DataSource",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
getFileStatuses
Description
Get paginated list of FileStatus records.
Response
Returns a PaginatedFileStatuses!
Arguments
| Name | Description |
|---|---|
query - GetFileStatusesInput!
|
Example
Query
query GetFileStatuses($query: GetFileStatusesInput!) {
getFileStatuses(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
createdOn
deletedOn
file {
...FileFragment
}
id
info
recordCount
status
updatedOn
}
totalRecords
}
}
Variables
{"query": GetFileStatusesInput}
Response
{
"data": {
"getFileStatuses": {
"pageInfo": PageInfo,
"records": [FileStatus],
"totalRecords": 123
}
}
}
getFiles
Description
Get all files by bucket name.
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
query - GetAllFilesInput!
|
Example
Query
query GetFiles($query: GetAllFilesInput!) {
getFiles(query: $query)
}
Variables
{"query": GetAllFilesInput}
Response
{"data": {"getFiles": ["abc123"]}}
getFlowOfFundsLinksView
Replaced by
flowOfFundsLinks. Removal on v5.0.0. Description
Get Relationships and all associated records – including transaction summaries.
Response
Returns a PaginatedRelationshipsLinksView
Arguments
| Name | Description |
|---|---|
query - GetFlowOfFundsViewInput!
|
Example
Query
query GetFlowOfFundsLinksView($query: GetFlowOfFundsViewInput!) {
getFlowOfFundsLinksView(query: $query) {
attributes
children {
attributes
compositeScore
customerData
id
label
links
sourceName
subtype
watchlistFlags {
...WatchlistFlagFragment
}
}
compositeScore
customerData
id
label
pageInfo {
endCursor {
...RelationshipCursorTypeFragment
}
hasNextPage
hasPreviousPage
startCursor {
...RelationshipCursorTypeFragment
}
totalConnections
}
sourceName
subtype
watchlistFlags {
notes
type
}
}
}
Variables
{"query": GetFlowOfFundsViewInput}
Response
{
"data": {
"getFlowOfFundsLinksView": {
"attributes": {},
"children": [RelationshipNode],
"compositeScore": 987.65,
"customerData": {},
"id": "abc123",
"label": "xyz789",
"pageInfo": RelationshipPageInfo,
"sourceName": "xyz789",
"subtype": "xyz789",
"watchlistFlags": [WatchlistFlag]
}
}
}
getGeneratedAlertsSummary
Description
Retrieve Alerts Generated Summary reports.
Response
Returns a GetAlertsGeneratedSummary!
Arguments
| Name | Description |
|---|---|
query - GetAlertsGeneratedSummaryInput!
|
Input type of getGeneratedAlertsSummary. |
Example
Query
query GetGeneratedAlertsSummary($query: GetAlertsGeneratedSummaryInput!) {
getGeneratedAlertsSummary(query: $query) {
byRiskRating {
date
summary {
...ReportSummaryRowFragment
}
}
bySource {
date
summary {
...ReportSummaryRowFragment
}
}
byStatus {
date
summary {
...ReportSummaryRowFragment
}
}
}
}
Variables
{"query": GetAlertsGeneratedSummaryInput}
Response
{
"data": {
"getGeneratedAlertsSummary": {
"byRiskRating": [ReportSummaryObject],
"bySource": [ReportSummaryObject],
"byStatus": [ReportSummaryObject]
}
}
}
getImage
Description
Get file by file id.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
query - FileInput!
|
Example
Query
query GetImage($query: FileInput!) {
getImage(query: $query)
}
Variables
{"query": FileInput}
Response
{"data": {"getImage": "xyz789"}}
getInstallationDetails
Description
Retrieve Installation Details.
Response
Returns an InstallationDetails!
Example
Query
query GetInstallationDetails {
getInstallationDetails {
installValid
}
}
Response
{"data": {"getInstallationDetails": {"installValid": false}}}
getItemMetadata
Description
Retrieve ItemMetadata by pipeline family name, table name, and type.
Response
Returns an ItemMetadata!
Arguments
| Name | Description |
|---|---|
query - ItemMetadataFilterRequest!
|
Example
Query
query GetItemMetadata($query: ItemMetadataFilterRequest!) {
getItemMetadata(query: $query) {
attributes
createdOn
deletedOn
fields
id
pipelineFamilyName
table
type
updatedOn
}
}
Variables
{"query": ItemMetadataFilterRequest}
Response
{
"data": {
"getItemMetadata": {
"attributes": {},
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"fields": {},
"id": "xyz789",
"pipelineFamilyName": "abc123",
"table": "xyz789",
"type": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
getItemsMetadata
Description
Retrieve all ItemMetadata.
Response
Returns [ItemMetadata!]!
Arguments
| Name | Description |
|---|---|
query - ItemsMetadataFilterRequest
|
Example
Query
query GetItemsMetadata($query: ItemsMetadataFilterRequest) {
getItemsMetadata(query: $query) {
attributes
createdOn
deletedOn
fields
id
pipelineFamilyName
table
type
updatedOn
}
}
Variables
{"query": ItemsMetadataFilterRequest}
Response
{
"data": {
"getItemsMetadata": [
{
"attributes": {},
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"fields": {},
"id": "xyz789",
"pipelineFamilyName": "abc123",
"table": "abc123",
"type": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
]
}
}
getKeyValue
Description
Retrieve a single KeyValue by key and version (optional).
Response
Returns a KeyValueType!
Arguments
| Name | Description |
|---|---|
query - GetKeyValueInput!
|
Example
Query
query GetKeyValue($query: GetKeyValueInput!) {
getKeyValue(query: $query) {
createdOn
editPermissions
isEncrypted
isEnv
key
readPermissions
value
version
}
}
Variables
{"query": GetKeyValueInput}
Response
{
"data": {
"getKeyValue": {
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": true,
"isEnv": true,
"key": "xyz789",
"readPermissions": {},
"value": {},
"version": "xyz789"
}
}
}
getLatestKeyValuesByPrefix
Description
Retrieve a list of latest unencrypted KeyValues by prefix.
Response
Returns [KeyValueType!]!
Arguments
| Name | Description |
|---|---|
query - GetLatestKeyValuesByPrefixInput!
|
Example
Query
query GetLatestKeyValuesByPrefix($query: GetLatestKeyValuesByPrefixInput!) {
getLatestKeyValuesByPrefix(query: $query) {
createdOn
editPermissions
isEncrypted
isEnv
key
readPermissions
value
version
}
}
Variables
{"query": GetLatestKeyValuesByPrefixInput}
Response
{
"data": {
"getLatestKeyValuesByPrefix": [
{
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": true,
"isEnv": false,
"key": "xyz789",
"readPermissions": {},
"value": {},
"version": "abc123"
}
]
}
}
getLatestRiskScores
Replaced by
Query.latestRiskScores. Removal on v5.0.0. Description
Retrieve paginated list of Latest RiskScoress.
Response
Returns a RiskScoresPage
Arguments
| Name | Description |
|---|---|
query - LatestRiskScoresInput!
|
Example
Query
query GetLatestRiskScores($query: LatestRiskScoresInput!) {
getLatestRiskScores(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertingFeatures {
...ShapFeatureFragment
}
anomalyScore
cibScore
compositeScore
createdOn
customerData
deletedOn
entityId
hotspotScore
id
pipelineFamilyName
riskScoreDate
riskScoreSource
similarityScore
sourceId
sourceTable
updatedOn
}
totalRecords
}
}
Variables
{"query": LatestRiskScoresInput}
Response
{
"data": {
"getLatestRiskScores": {
"pageInfo": PageInfo,
"records": [RiskScore],
"totalRecords": 987
}
}
}
getMonthHighlights
Description
Retrieve month highlights for Alert.
Response
Returns [MonthHighlights!]!
Arguments
| Name | Description |
|---|---|
query - GetAlertsByInput!
|
Input type of GetMonthHighlights. |
Example
Query
query GetMonthHighlights($query: GetAlertsByInput!) {
getMonthHighlights(query: $query) {
label
lastMonth
thisMonth
type
}
}
Variables
{"query": GetAlertsByInput}
Response
{
"data": {
"getMonthHighlights": [
{
"label": "abc123",
"lastMonth": 987.65,
"thisMonth": 123.45,
"type": "xyz789"
}
]
}
}
getObject
Description
Get Object.
Response
Returns an ObjectModel!
Arguments
| Name | Description |
|---|---|
input - GetObjectInput!
|
Example
Query
query GetObject($input: GetObjectInput!) {
getObject(input: $input) {
accountBalance
accountBalanceUpdatedOn
accountCurrency
accountNumber
accountSegment
accountType
attributes
createdOn
customerData
deletedOn
file {
bucket
createdOn
deletedOn
id
mimetype
name
size
type
updatedOn
}
id
label
pipelineFamilyName
sourceId
sourceName
sourceTable
subtype
updatedOn
}
}
Variables
{"input": GetObjectInput}
Response
{
"data": {
"getObject": {
"accountBalance": 987.65,
"accountBalanceUpdatedOn": "2007-12-03T10:15:30Z",
"accountCurrency": "xyz789",
"accountNumber": "abc123",
"accountSegment": "xyz789",
"accountType": "abc123",
"attributes": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"customerData": {},
"deletedOn": "2007-12-03T10:15:30Z",
"file": File,
"id": "abc123",
"label": "xyz789",
"pipelineFamilyName": "abc123",
"sourceId": "xyz789",
"sourceName": "xyz789",
"sourceTable": "abc123",
"subtype": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
getOidcLoginUrl
Description
OIDC Login URL to ask user credentials.
Response
Returns an OidcUrl!
Example
Query
query GetOidcLoginUrl {
getOidcLoginUrl {
loginUrl
}
}
Response
{
"data": {
"getOidcLoginUrl": {
"loginUrl": "xyz789"
}
}
}
getPipeline
Description
Retrieve single Pipeline.
Response
Returns a PipelineDetailDto!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query GetPipeline($id: String!) {
getPipeline(id: $id) {
config
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
dependencies {
displayName
id
label
}
description
displayName
featureSchedule
id
label
pipelineConfigStatus {
dataSource
featureSets
mlModels
ruleSets
}
pipelineFamilyName
pipelineStatus {
createdOn
deletedOn
duration
finishTime
id
logPath
message
pipelineId
runId
startTime
status
step
updatedOn
}
ruleSets {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
systemName
triggeringFrequency
type
updatedOn
updater {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"getPipeline": {
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": [PipelineDependencyDto],
"description": "xyz789",
"displayName": "abc123",
"featureSchedule": "abc123",
"id": "abc123",
"label": "xyz789",
"pipelineConfigStatus": PipelineConfigStatus,
"pipelineFamilyName": "abc123",
"pipelineStatus": PipelineStatus,
"ruleSets": [RuleSet],
"systemName": "xyz789",
"triggeringFrequency": "abc123",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updater": UserEntity
}
}
}
getPipelineFamilyNames
Description
Update a single Pipeline.
Response
Returns a PipelineFamilyNames!
Arguments
| Name | Description |
|---|---|
orderBy - PipelineFamilyNamesOrderByInput
|
Specify the ordering of records. Default = {field: Name, sort: ASC} |
Example
Query
query GetPipelineFamilyNames($orderBy: PipelineFamilyNamesOrderByInput) {
getPipelineFamilyNames(orderBy: $orderBy) {
names
}
}
Variables
{"orderBy": {"field": "Name", "sort": "ASC"}}
Response
{
"data": {
"getPipelineFamilyNames": {
"names": ["xyz789"]
}
}
}
getPipelineFeature
Description
Retrieve single PipelineFeature.
Response
Returns a PipelineFeatureModel!
Arguments
| Name | Description |
|---|---|
query - GetPipelineFeatureInput!
|
Example
Query
query GetPipelineFeature($query: GetPipelineFeatureInput!) {
getPipelineFeature(query: $query) {
activeFlag
config
createdOn
deletedOn
featureName
featureType
id
pipelineName
updatedOn
}
}
Variables
{"query": GetPipelineFeatureInput}
Response
{
"data": {
"getPipelineFeature": {
"activeFlag": true,
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"featureName": "abc123",
"featureType": "xyz789",
"id": "xyz789",
"pipelineName": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
getPipelineFeatures
Description
Retrieve all PipelineFeature.
Response
Returns [PipelineFeatureModel!]!
Arguments
| Name | Description |
|---|---|
query - GetPipelineFeaturesInput!
|
Example
Query
query GetPipelineFeatures($query: GetPipelineFeaturesInput!) {
getPipelineFeatures(query: $query) {
activeFlag
config
createdOn
deletedOn
featureName
featureType
id
pipelineName
updatedOn
}
}
Variables
{"query": GetPipelineFeaturesInput}
Response
{
"data": {
"getPipelineFeatures": [
{
"activeFlag": false,
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"featureName": "xyz789",
"featureType": "xyz789",
"id": "xyz789",
"pipelineName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
]
}
}
getPipelineRuns
Description
Retrieve all PipelineRuns from a Pipeline.
Response
Returns a PaginatedPipelineRuns!
Arguments
| Name | Description |
|---|---|
query - GetPipelineRunsInput!
|
Example
Query
query GetPipelineRuns($query: GetPipelineRunsInput!) {
getPipelineRuns(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
createdOn
deletedOn
duration
finishTime
hasLogsFile
logPath
message
pipelineId
pipelineStatus
runId
startTime
status
statuses {
...PipelineStatusModelFragment
}
step
updatedOn
}
totalRecords
}
}
Variables
{"query": GetPipelineRunsInput}
Response
{
"data": {
"getPipelineRuns": {
"pageInfo": PageInfo,
"records": [PipelineRun],
"totalRecords": 123
}
}
}
getPipelineScheduleException
Description
Retrieve a single PipelineScheduleException
Response
Returns a PipelineScheduleException!
Arguments
| Name | Description |
|---|---|
pipelineScheduleExceptionId - String!
|
Example
Query
query GetPipelineScheduleException($pipelineScheduleExceptionId: String!) {
getPipelineScheduleException(pipelineScheduleExceptionId: $pipelineScheduleExceptionId) {
action
batchId
createdOn
deletedOn
id
newDateTime
oldDateTime
pipelineId
pipelineName
updatedOn
}
}
Variables
{"pipelineScheduleExceptionId": "xyz789"}
Response
{
"data": {
"getPipelineScheduleException": {
"action": "xyz789",
"batchId": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"newDateTime": "2007-12-03T10:15:30Z",
"oldDateTime": "2007-12-03T10:15:30Z",
"pipelineId": "abc123",
"pipelineName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
getPipelineScheduleExceptions
Description
Retrieve list of all PipelineScheduleExceptions.
Response
Returns a PaginatedPipelineScheduleExceptions!
Arguments
| Name | Description |
|---|---|
query - GetPipelineScheduleExceptionsInput!
|
Example
Query
query GetPipelineScheduleExceptions($query: GetPipelineScheduleExceptionsInput!) {
getPipelineScheduleExceptions(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
action
batchId
createdOn
deletedOn
id
newDateTime
oldDateTime
pipelineId
pipelineName
updatedOn
}
totalRecords
}
}
Variables
{"query": GetPipelineScheduleExceptionsInput}
Response
{
"data": {
"getPipelineScheduleExceptions": {
"pageInfo": PageInfo,
"records": [PipelineScheduleException],
"totalRecords": 987
}
}
}
getPipelineScheduledRuns
Description
Retrieves the past and planned PipelineRuns of a Pipeline.
Response
Returns [PipelineScheduledRun!]!
Arguments
| Name | Description |
|---|---|
query - GetPipelineScheduledRunsInput!
|
Example
Query
query GetPipelineScheduledRuns($query: GetPipelineScheduledRunsInput!) {
getPipelineScheduledRuns(query: $query) {
date
id
status
type
}
}
Variables
{"query": GetPipelineScheduledRunsInput}
Response
{
"data": {
"getPipelineScheduledRuns": [
{
"date": "2007-12-03T10:15:30Z",
"id": "abc123",
"status": "Error",
"type": "Auto"
}
]
}
}
getPipelines
Description
Retrieve list of all Pipelines.
Response
Returns a PaginatedPipelines!
Arguments
| Name | Description |
|---|---|
query - GetPipelinesInput!
|
Example
Query
query GetPipelines($query: GetPipelinesInput!) {
getPipelines(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
config
createdOn
creator {
...UserEntityFragment
}
deletedOn
dependencies {
...PipelineDependencyDtoFragment
}
description
displayName
featureSchedule
id
label
pipelineConfigStatus {
...PipelineConfigStatusFragment
}
pipelineFamilyName
pipelineStatus {
...PipelineStatusFragment
}
ruleSets {
...RuleSetFragment
}
systemName
triggeringFrequency
type
updatedOn
updater {
...UserEntityFragment
}
}
totalRecords
}
}
Variables
{"query": GetPipelinesInput}
Response
{
"data": {
"getPipelines": {
"pageInfo": PageInfo,
"records": [PipelineDetailDto],
"totalRecords": 123
}
}
}
getRelationshipsLinksView
Replaced by
relationshipsLinks. Removal on v5.0.0. Description
Get Relationships and associated Entity records for Entity Links Explorer's relationship view.
Response
Returns a GetRelationshipsLinksViewResponse
Arguments
| Name | Description |
|---|---|
query - GetRelationshipsLinksViewInput!
|
Example
Query
query GetRelationshipsLinksView($query: GetRelationshipsLinksViewInput!) {
getRelationshipsLinksView(query: $query) {
attributes
children {
attributes
compositeScore
customerData
id
label
links
sourceName
subtype
watchlistFlags {
...WatchlistFlagFragment
}
}
compositeScore
customerData
id
label
links
sourceName
subtype
watchlistFlags {
notes
type
}
}
}
Variables
{"query": GetRelationshipsLinksViewInput}
Response
{
"data": {
"getRelationshipsLinksView": {
"attributes": {},
"children": [RelationshipNode],
"compositeScore": 123.45,
"customerData": {},
"id": "xyz789",
"label": "xyz789",
"links": ["xyz789"],
"sourceName": "abc123",
"subtype": "abc123",
"watchlistFlags": [WatchlistFlag]
}
}
}
getRiskRating
Description
Retrieve a single RiskRating.
Response
Returns a RiskRating!
Arguments
| Name | Description |
|---|---|
input - GetRiskRating!
|
Example
Query
query GetRiskRating($input: GetRiskRating!) {
getRiskRating(input: $input) {
color
deletedOn
displayOrder
id
label
}
}
Variables
{"input": GetRiskRating}
Response
{
"data": {
"getRiskRating": {
"color": "xyz789",
"deletedOn": "2007-12-03",
"displayOrder": 987.65,
"id": "xyz789",
"label": "abc123"
}
}
}
getRiskScoreTrends
Replaced by
riskScoreTrends. Removal on v5.0.0. Description
Retrieve list of RiskScoreTrend by month in provided year.
Response
Returns [RiskScoreTrend!]
Arguments
| Name | Description |
|---|---|
query - GetRiskScoreTrends!
|
Example
Query
query GetRiskScoreTrends($query: GetRiskScoreTrends!) {
getRiskScoreTrends(query: $query) {
count
month
riskScore
year
}
}
Variables
{"query": GetRiskScoreTrends}
Response
{
"data": {
"getRiskScoreTrends": [
{
"count": 987,
"month": 987,
"riskScore": "xyz789",
"year": 123
}
]
}
}
getRole
Description
Get Role by name.
Response
Returns a Role
Arguments
| Name | Description |
|---|---|
input - GetRoleInput!
|
Example
Query
query GetRole($input: GetRoleInput!) {
getRole(input: $input) {
name
permissions
}
}
Variables
{"input": GetRoleInput}
Response
{
"data": {
"getRole": {
"name": "xyz789",
"permissions": {}
}
}
}
getRoles
Description
Get all Roles.
Response
Returns [Role!]!
Example
Query
query GetRoles {
getRoles {
name
permissions
}
}
Response
{
"data": {
"getRoles": [
{"name": "abc123", "permissions": {}}
]
}
}
getRule
Description
Retrieve a single Rule.
Response
Returns a GetRuleResponse
Arguments
| Name | Description |
|---|---|
query - GetRule!
|
Example
Query
query GetRule($query: GetRule!) {
getRule(query: $query) {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
id
name
}
ruleSet {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleSetId
score
type
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
versions {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
}
}
Variables
{"query": GetRule}
Response
{
"data": {
"getRule": {
"active": false,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"eventType": "abc123",
"id": "xyz789",
"name": "xyz789",
"rule": {},
"ruleActionIds": ["abc123"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "abc123",
"score": 123.45,
"type": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123",
"versions": [Rule]
}
}
}
getRuleActions
To obtain a list of unique
RuleActions, please use KeyValue resolver methods. Removal on v5.0.0. Description
Retrieve list of all Rule Actions.
Response
Returns [RuleActionModel!]
Example
Query
query GetRuleActions {
getRuleActions {
createdOn
deletedOn
id
rule {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleActionIds
ruleId
updatedOn
}
}
Response
{
"data": {
"getRuleActions": [
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"rule": Rule,
"ruleActionIds": ["xyz789"],
"ruleId": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
]
}
}
getRuleEngineStatusByRunId
Description
Run Engine Status
Response
Returns a RuleEngineStatusResponse!
Arguments
| Name | Description |
|---|---|
runId - String!
|
Example
Query
query GetRuleEngineStatusByRunId($runId: String!) {
getRuleEngineStatusByRunId(runId: $runId) {
createdTime
date
endDate
endedTime
errorMessage
errorType
errors
generatedAlerts
pipelineId
redisJobId
rulesetIds
runId
startDate
startedTime
status
}
}
Variables
{"runId": "abc123"}
Response
{
"data": {
"getRuleEngineStatusByRunId": {
"createdTime": "xyz789",
"date": "abc123",
"endDate": "abc123",
"endedTime": "xyz789",
"errorMessage": "abc123",
"errorType": "abc123",
"errors": ["xyz789"],
"generatedAlerts": {},
"pipelineId": "xyz789",
"redisJobId": "xyz789",
"rulesetIds": ["abc123"],
"runId": "xyz789",
"startDate": "abc123",
"startedTime": "abc123",
"status": "xyz789"
}
}
}
getRuleLibraryAttributes
Description
Run Engine Status
Response
Returns a RuleLibraryAttributesResponse!
Arguments
| Name | Description |
|---|---|
pipelineId - String!
|
Example
Query
query GetRuleLibraryAttributes($pipelineId: String!) {
getRuleLibraryAttributes(pipelineId: $pipelineId) {
attributes {
columns {
...RuleLibraryAttributeColumnFragment
}
tableDescription
tableName
}
}
}
Variables
{"pipelineId": "abc123"}
Response
{
"data": {
"getRuleLibraryAttributes": {
"attributes": [RuleLibraryAttribute]
}
}
}
getRuleSet
Response
Returns [MockRuleSet!]!
Example
Query
query GetRuleSet {
getRuleSet {
entity_name
id
label
pipelines
rule_name
rule_performance
score
}
}
Response
{
"data": {
"getRuleSet": [
{
"entity_name": "xyz789",
"id": "abc123",
"label": "abc123",
"pipelines": ["abc123"],
"rule_name": "xyz789",
"rule_performance": 123.45,
"score": 123.45
}
]
}
}
getRuleSets
Description
Retrieve list of all RuleSets.
Response
Returns [RuleSet!]!
Example
Query
query GetRuleSets {
getRuleSets {
createdOn
deletedOn
description
enabled
id
name
pipeline {
config
createdOn
creatorId
deletedOn
dependencies
description
displayName
featureSchedule
id
isDisabled
label
pipelineStatus {
...PipelineStatusModelFragment
}
systemName
triggeringFrequency
type
updatedOn
updaterId
}
pipelineId
preconditions
rules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Response
{
"data": {
"getRuleSets": [
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"enabled": true,
"id": "xyz789",
"name": "abc123",
"pipeline": PipelineModel,
"pipelineId": "xyz789",
"preconditions": {},
"rules": [RuleEntity],
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
]
}
}
getRuleSetsById
Description
Retrieve a single RuleSet.
Response
Returns a RuleSetResponse!
Arguments
| Name | Description |
|---|---|
input - GetRuleSetInput!
|
Example
Query
query GetRuleSetsById($input: GetRuleSetInput!) {
getRuleSetsById(input: $input) {
createdOn
deletedOn
description
enabled
id
name
pipeline {
config
createdOn
creatorId
deletedOn
dependencies
description
displayName
featureSchedule
id
isDisabled
label
pipelineStatus {
...PipelineStatusModelFragment
}
systemName
triggeringFrequency
type
updatedOn
updaterId
}
pipelineId
preconditions
rules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
versions {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
}
}
Variables
{"input": GetRuleSetInput}
Response
{
"data": {
"getRuleSetsById": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"enabled": false,
"id": "xyz789",
"name": "xyz789",
"pipeline": PipelineModel,
"pipelineId": "abc123",
"preconditions": {},
"rules": [RuleEntity],
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123",
"versions": [RuleSet]
}
}
}
getRules
Description
Retrieve list of all Rules.
Response
Returns [Rule!]!
Example
Query
query GetRules {
getRules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
id
name
}
ruleSet {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleSetId
score
type
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Response
{
"data": {
"getRules": [
{
"active": false,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"eventType": "xyz789",
"id": "xyz789",
"name": "abc123",
"rule": {},
"ruleActionIds": ["abc123"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "xyz789",
"score": 123.45,
"type": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123"
}
]
}
}
getSamlSettings
Description
Retrieve SAML Settings
Response
Returns a SamlSettings!
Example
Query
query GetSamlSettings {
getSamlSettings {
entityId
fieldMappingEmail
fieldMappingFirstName
fieldMappingGroup
fieldMappingLastName
fileName
redirectUrl
roleMappings {
groupId
groupName
role
}
status
url
}
}
Response
{
"data": {
"getSamlSettings": {
"entityId": "xyz789",
"fieldMappingEmail": "abc123",
"fieldMappingFirstName": "xyz789",
"fieldMappingGroup": "abc123",
"fieldMappingLastName": "abc123",
"fileName": "xyz789",
"redirectUrl": "abc123",
"roleMappings": [SamlRoleMappingResponse],
"status": "Empty",
"url": "xyz789"
}
}
}
getSummarizedTransactionByType
Description
Retrieve summarized Transactions by Type.
Response
Returns a SummarizedTransactionsByTypeResponse!
Arguments
| Name | Description |
|---|---|
query - GetSummarizedTransactionsByTypeInput!
|
Example
Query
query GetSummarizedTransactionByType($query: GetSummarizedTransactionsByTypeInput!) {
getSummarizedTransactionByType(query: $query) {
credit {
transactionType
value
}
debit {
transactionType
value
}
totalCredit
totalDebit
}
}
Variables
{"query": GetSummarizedTransactionsByTypeInput}
Response
{
"data": {
"getSummarizedTransactionByType": {
"credit": [SummarizedTransaction],
"debit": [SummarizedTransaction],
"totalCredit": 123.45,
"totalDebit": 123.45
}
}
}
getSummarizedTransactions
Description
Retrieve summarized Transactions.
Response
Returns a SummarizedTransactionsResponse!
Arguments
| Name | Description |
|---|---|
query - GetSummarizedTransactionsInput!
|
Example
Query
query GetSummarizedTransactions($query: GetSummarizedTransactionsInput!) {
getSummarizedTransactions(query: $query) {
credit {
date
summary {
...SummarizedTransactionFragment
}
}
debit {
date
summary {
...SummarizedTransactionFragment
}
}
totalCredit
totalDebit
}
}
Variables
{"query": GetSummarizedTransactionsInput}
Response
{
"data": {
"getSummarizedTransactions": {
"credit": [DebitCreditSummarizedTransaction],
"debit": [DebitCreditSummarizedTransaction],
"totalCredit": 987.65,
"totalDebit": 987.65
}
}
}
getSummarizedTransactionsByCounterparty
Description
Retrieve summarized Transactions.
Response
Returns [CounterpartyTransactionGroup!]!
Arguments
| Name | Description |
|---|---|
query - GetSummarizedTransactionsByCounterpartyInput!
|
Example
Query
query GetSummarizedTransactionsByCounterparty($query: GetSummarizedTransactionsByCounterpartyInput!) {
getSummarizedTransactionsByCounterparty(query: $query) {
accountId
legalEntityName
transactionsByCreditType {
totalTransactionAmount
transactionType
}
transactionsByDebitType {
totalTransactionAmount
transactionType
}
}
}
Variables
{"query": GetSummarizedTransactionsByCounterpartyInput}
Response
{
"data": {
"getSummarizedTransactionsByCounterparty": [
{
"accountId": "abc123",
"legalEntityName": "xyz789",
"transactionsByCreditType": [
TransactionsByCreditOrDebitType
],
"transactionsByDebitType": [
TransactionsByCreditOrDebitType
]
}
]
}
}
getTargets
Description
Retrieve list of all Targets.
Response
Returns [Target!]!
Example
Query
query GetTargets {
getTargets {
health
instanceLabel
jobLabel
lastScrape
}
}
Response
{
"data": {
"getTargets": [
{
"health": "xyz789",
"instanceLabel": "xyz789",
"jobLabel": "abc123",
"lastScrape": "xyz789"
}
]
}
}
getTotalAlertsBySource
Description
Retrieve list of total alerts by source.
Response
Returns a TotalAlertsBySourceResponse!
Arguments
| Name | Description |
|---|---|
query - GetTotalAlertsBySourceInput!
|
Example
Query
query GetTotalAlertsBySource($query: GetTotalAlertsBySourceInput!) {
getTotalAlertsBySource(query: $query) {
totalAlertsByRiskRating {
category
riskRating
riskRatingId
totalAlerts
}
totalAlertsByStatus {
category
status
totalAlerts
}
}
}
Variables
{"query": GetTotalAlertsBySourceInput}
Response
{
"data": {
"getTotalAlertsBySource": {
"totalAlertsByRiskRating": [
CategoryTotalAlertsByRiskRating
],
"totalAlertsByStatus": [CategoryTotalAlertsByStatus]
}
}
}
getTrainingModel
Description
Retrieve a Training Model.
Response
Returns a TrainingModel!
Arguments
| Name | Description |
|---|---|
query - GetTrainingModelInput!
|
Example
Query
query GetTrainingModel($query: GetTrainingModelInput!) {
getTrainingModel(query: $query) {
createdOn
deletedOn
id
modelData
modelName
updatedOn
}
}
Variables
{"query": GetTrainingModelInput}
Response
{
"data": {
"getTrainingModel": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"modelData": {},
"modelName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
getTransactionDetailsBetweenEdges
Replaced by
transactionDetailsBetweenEdges. Removal on v5.0.0. Description
Get all Transaction records associated between two Accounts.
Response
Returns a PaginatedTransactionDetails
Arguments
| Name | Description |
|---|---|
query - GetTransactionDetailsBetweenEdgesInput!
|
Example
Query
query GetTransactionDetailsBetweenEdges($query: GetTransactionDetailsBetweenEdgesInput!) {
getTransactionDetailsBetweenEdges(query: $query) {
pageInfo {
endCursor {
...RelationshipCursorTypeFragment
}
hasNextPage
hasPreviousPage
startCursor {
...RelationshipCursorTypeFragment
}
totalConnections
}
records {
attributes
compositeScore
customerData
id
label
sourceName
subtype
watchlistFlags {
...WatchlistFlagFragment
}
}
}
}
Variables
{"query": GetTransactionDetailsBetweenEdgesInput}
Response
{
"data": {
"getTransactionDetailsBetweenEdges": {
"pageInfo": RelationshipPageInfo,
"records": [RelationshipNodeWithoutLinks]
}
}
}
getTransactionsThroughput
Description
Transactions throughput by time period.
Response
Returns a TransactionsThroughputDto!
Arguments
| Name | Description |
|---|---|
query - GetTransactionsThroughputInput!
|
Example
Query
query GetTransactionsThroughput($query: GetTransactionsThroughputInput!) {
getTransactionsThroughput(query: $query) {
avgEntitiesPerMonth
avgTransactionsPerMonth
dataByMonth {
month
numberOfActiveEntities
numberOfTransactions
year
}
isEmpty
totalEntities
totalTransactions
}
}
Variables
{"query": GetTransactionsThroughputInput}
Response
{
"data": {
"getTransactionsThroughput": {
"avgEntitiesPerMonth": 987.65,
"avgTransactionsPerMonth": 987.65,
"dataByMonth": [TransactionsEntitiesDataByMonth],
"isEmpty": false,
"totalEntities": 987.65,
"totalTransactions": 987.65
}
}
}
getTransactionsWithEntities
Description
Get Event of subtype transaction with associated Entity.
Response
Returns a GetTransactionsWithEntitiesResponse!
Arguments
| Name | Description |
|---|---|
query - GetTransactionsWithEntitiesInput
|
Default = {filter: {endDate: null, fields: [], startDate: null}, filterBy: {}, orderBy: {sort: DESC}, page: {limit: 25, pageNumber: 0}} |
Example
Query
query GetTransactionsWithEntities($query: GetTransactionsWithEntitiesInput) {
getTransactionsWithEntities(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
accountWithInstitution
accountWithInstitutionCountry
baseCurrency
beneficiaries {
...EntityModelFragment
}
beneficiariesV2 {
...BeneficiariesV2Fragment
}
beneficiaryCustomer
beneficiaryId
beneficiaryInstitution
beneficiaryInstitutionCountry
branchId
buyer
cardId
createdOn
creditDebitFlag
deletedOn
destinationCountry
deviceId
eventDate
file {
...FileFragment
}
financialInstrumentCountry
financialInstrumentDetails
financialInstrumentIsin
financialInstrumentQuantity
functionalAmount
functionalCurrency
id
intermediary
intermediaryCountry
label
orderingCustomer
orderingInstitution
orderingInstitutionCountry
originCountry
originalAmount
originalCurrency
originationDate
originatorId
originators {
...EntityModelFragment
}
originatorsV2 {
...OriginatorsV2Fragment
}
pipelineFamilyName
postingDate
receiverBic
receiverCorrespondent
receiverCorrespondentCountry
region
scope
seller
senderBic
senderCorrespondent
senderCorrespondentCountry
sendingInstitution
sendingInstitutionCountry
settlementBic
settlementPlaceCountry
sourceId
sourceName
sourceSystem
sourceTable
subtype
tellerId
transactionType
transactionTypeDescription
txnId
ultimateBeneficiary
ultimateOriginator
updatedOn
}
totalRecords
}
}
Variables
{
"query": {
"filter": {"endDate": "null", "fields": [""], "startDate": "null"},
"filterBy": {},
"orderBy": {"sort": "DESC"},
"page": {"limit": 25, "pageNumber": 0}
}
}
Response
{
"data": {
"getTransactionsWithEntities": {
"pageInfo": PageInfo,
"records": [
IntersectionEventModelWithEntityFullName
],
"totalRecords": 987
}
}
}
getUser
Description
Retrieve a single User.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
query - GetUserInput!
|
Example
Query
query GetUser($query: GetUserInput!) {
getUser(query: $query) {
alert_queues_assigned {
alertQueue {
...AlertQueueFragment
}
alertQueueId
usersId
}
alert_queues_owned {
alertTypes {
...AlertTypeFragment
}
createdOn
creator {
...UserEntityFragment
}
creatorId
currency
deletedOn
detections {
...DetectionConnectionFragment
}
filters {
...FiltersFragment
}
id
label
name
pipelineFamilyName
updatedOn
users {
...UserEntityFragment
}
}
createdOn
deletedOn
email
enabled
first_name
fullName
id
imageId
language
last_name
login_codes {
code
createDate
email
user {
...UserEntityFragment
}
}
permissions
preferences {
currencyCode
language
timezone
weekStartsOn
}
role
time_zone
tokens {
createdOn
deletedOn
id
ip
token
updatedOn
user {
...UserEntityFragment
}
}
updatedOn
username
weekStartsOn
}
}
Variables
{"query": GetUserInput}
Response
{
"data": {
"getUser": {
"alert_queues_assigned": [AlertQueueAssigned],
"alert_queues_owned": [AlertQueue],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"enabled": false,
"first_name": "abc123",
"fullName": "abc123",
"id": "xyz789",
"imageId": "abc123",
"language": "abc123",
"last_name": "abc123",
"login_codes": LoginCode,
"permissions": {},
"preferences": UserPreference,
"role": "xyz789",
"time_zone": "abc123",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "xyz789"
}
}
}
getUserLogHistory
Description
Retrieve paginated list of Audit Logs.
Response
Returns an AuditLogsPage!
Arguments
| Name | Description |
|---|---|
query - GetUserLogHistoryInput!
|
Example
Query
query GetUserLogHistory($query: GetUserLogHistoryInput!) {
getUserLogHistory(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
activity
actor {
...AuditLogActorFragment
}
auditedObject {
...AuditLogObjectFragment
}
auditedValues {
...AuditLogAuditedAttributeFragment
}
createdOn
id
}
totalRecords
}
}
Variables
{"query": GetUserLogHistoryInput}
Response
{
"data": {
"getUserLogHistory": {
"pageInfo": PageInfo,
"records": [AuditLogDto],
"totalRecords": 123
}
}
}
getUsers
Description
Retrieve list of all Users.
Response
Returns a PaginatedUsers!
Arguments
| Name | Description |
|---|---|
query - GetPaginatedUsersInput!
|
Example
Query
query GetUsers($query: GetPaginatedUsersInput!) {
getUsers(query: $query) {
records {
alert_queues_assigned {
...AlertQueueAssignedFragment
}
alert_queues_owned {
...AlertQueueFragment
}
createdOn
deletedOn
email
enabled
first_name
fullName
id
imageId
language
last_name
login_codes {
...LoginCodeFragment
}
permissions
preferences {
...UserPreferenceFragment
}
role
time_zone
tokens {
...TokenFragment
}
updatedOn
username
weekStartsOn
}
totalRecords
}
}
Variables
{"query": GetPaginatedUsersInput}
Response
{
"data": {
"getUsers": {"records": [User], "totalRecords": 123}
}
}
getValidateCache
Description
Check whether cache exists for ResolverName and Query arguments.
Response
Returns a ValidateCache!
Arguments
| Name | Description |
|---|---|
query - ValidateCacheInput!
|
Example
Query
query GetValidateCache($query: ValidateCacheInput!) {
getValidateCache(query: $query) {
isCached
isQueryCached
}
}
Variables
{"query": ValidateCacheInput}
Response
{"data": {"getValidateCache": {"isCached": false, "isQueryCached": false}}}
issues
Description
Retrieve system health issues.
Response
Returns a SystemIssuesResponse!
Arguments
| Name | Description |
|---|---|
input - PaginationWithSystemIssuesInput!
|
Example
Query
query Issues($input: PaginationWithSystemIssuesInput!) {
issues(input: $input) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
createdOn
description
id
isOpen
nature
natureType
nodeId
nodeLabel
operatingSystem
privateIPv4
privateIPv6
publicIPv4
publicIPv6
serviceId
serviceLabel
status
timestamp
updatedOn
}
totalRecords
}
}
Variables
{"input": PaginationWithSystemIssuesInput}
Response
{
"data": {
"issues": {
"pageInfo": PageInfo,
"records": [SystemIssue],
"totalRecords": 123
}
}
}
keyValues
Description
Retrieve a list of KeyValue by key and version (optional).
Response
Returns [KeyValueType!]!
Arguments
| Name | Description |
|---|---|
query - KeyValuesInput!
|
Example
Query
query KeyValues($query: KeyValuesInput!) {
keyValues(query: $query) {
createdOn
editPermissions
isEncrypted
isEnv
key
readPermissions
value
version
}
}
Variables
{"query": KeyValuesInput}
Response
{
"data": {
"keyValues": [
{
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": true,
"isEnv": true,
"key": "abc123",
"readPermissions": {},
"value": {},
"version": "xyz789"
}
]
}
}
latestRiskScores
Description
Retrieve paginated list of Latest RiskScoress.
Response
Returns a RiskScoresPage!
Arguments
| Name | Description |
|---|---|
query - LatestRiskScoresInput!
|
Example
Query
query LatestRiskScores($query: LatestRiskScoresInput!) {
latestRiskScores(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertingFeatures {
...ShapFeatureFragment
}
anomalyScore
cibScore
compositeScore
createdOn
customerData
deletedOn
entityId
hotspotScore
id
pipelineFamilyName
riskScoreDate
riskScoreSource
similarityScore
sourceId
sourceTable
updatedOn
}
totalRecords
}
}
Variables
{"query": LatestRiskScoresInput}
Response
{
"data": {
"latestRiskScores": {
"pageInfo": PageInfo,
"records": [RiskScore],
"totalRecords": 987
}
}
}
latestRiskScoresFromDataLake
Description
Retrieve paginated list of latest RiskScore from DataLake
Response
Returns a RiskScoresPage!
Arguments
| Name | Description |
|---|---|
query - LatestRiskScoresFromDataLakeInput!
|
Example
Query
query LatestRiskScoresFromDataLake($query: LatestRiskScoresFromDataLakeInput!) {
latestRiskScoresFromDataLake(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertingFeatures {
...ShapFeatureFragment
}
anomalyScore
cibScore
compositeScore
createdOn
customerData
deletedOn
entityId
hotspotScore
id
pipelineFamilyName
riskScoreDate
riskScoreSource
similarityScore
sourceId
sourceTable
updatedOn
}
totalRecords
}
}
Variables
{"query": LatestRiskScoresFromDataLakeInput}
Response
{
"data": {
"latestRiskScoresFromDataLake": {
"pageInfo": PageInfo,
"records": [RiskScore],
"totalRecords": 987
}
}
}
notifications
Description
Get notifications associated to authenticated user.
Response
Returns [EleNotification!]
Example
Query
query Notifications {
notifications {
batchDate
createdOn
id
message
meta {
detectionId
fullName
userId
}
metaId
nodeId
status
}
}
Response
{
"data": {
"notifications": [
{
"batchDate": "2007-12-03",
"createdOn": "2007-12-03",
"id": 4,
"message": {},
"meta": EleMetadata,
"metaId": "4",
"nodeId": "4",
"status": "COMPLETE"
}
]
}
}
pod
Description
Get Kubernetes Pod details.
Response
Returns a PodResponse!
Arguments
| Name | Description |
|---|---|
query - PodInput!
|
Example
Query
query Pod($query: PodInput!) {
pod(query: $query) {
databases {
name
schema
size
tables {
...TableDtoFragment
}
}
folders {
label
size
}
name
status
topics {
analytics {
...AnalyticsFragment
}
label
}
totalRecords
type
version
}
}
Variables
{"query": PodInput}
Response
{
"data": {
"pod": {
"databases": [Database],
"folders": [FileStorage],
"name": "abc123",
"status": "Failed",
"topics": [Topic],
"totalRecords": 987.65,
"type": "Analytics",
"version": "xyz789"
}
}
}
pods
Description
Retrieve Kubernetes Pods.
Response
Returns a PodsResponse!
Arguments
| Name | Description |
|---|---|
query - PodsInput!
|
Example
Query
query Pods($query: PodsInput!) {
pods(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
name
status
type
version
}
totalRecords
}
}
Variables
{"query": PodsInput}
Response
{
"data": {
"pods": {
"pageInfo": PageInfo,
"records": [Pod],
"totalRecords": 987
}
}
}
profile
Description
Retrieve authenticated User profile.
Response
Returns a User!
Example
Query
query Profile {
profile {
alert_queues_assigned {
alertQueue {
...AlertQueueFragment
}
alertQueueId
usersId
}
alert_queues_owned {
alertTypes {
...AlertTypeFragment
}
createdOn
creator {
...UserEntityFragment
}
creatorId
currency
deletedOn
detections {
...DetectionConnectionFragment
}
filters {
...FiltersFragment
}
id
label
name
pipelineFamilyName
updatedOn
users {
...UserEntityFragment
}
}
createdOn
deletedOn
email
enabled
first_name
fullName
id
imageId
language
last_name
login_codes {
code
createDate
email
user {
...UserEntityFragment
}
}
permissions
preferences {
currencyCode
language
timezone
weekStartsOn
}
role
time_zone
tokens {
createdOn
deletedOn
id
ip
token
updatedOn
user {
...UserEntityFragment
}
}
updatedOn
username
weekStartsOn
}
}
Response
{
"data": {
"profile": {
"alert_queues_assigned": [AlertQueueAssigned],
"alert_queues_owned": [AlertQueue],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "abc123",
"enabled": false,
"first_name": "xyz789",
"fullName": "abc123",
"id": "xyz789",
"imageId": "xyz789",
"language": "xyz789",
"last_name": "xyz789",
"login_codes": LoginCode,
"permissions": {},
"preferences": UserPreference,
"role": "xyz789",
"time_zone": "abc123",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "abc123"
}
}
}
reindexNodes
Description
Trigger reindexing of Meilisearch records sourced from datalake.
Response
Returns a ReindexNodesResponse!
Arguments
| Name | Description |
|---|---|
query - ReindexNodesInput!
|
Example
Query
query ReindexNodes($query: ReindexNodesInput!) {
reindexNodes(query: $query) {
message
success
}
}
Variables
{"query": ReindexNodesInput}
Response
{
"data": {
"reindexNodes": {
"message": "abc123",
"success": false
}
}
}
relationshipsLinks
Description
Get Relationships and associated Entity records for Entity Links Explorer's relationship view.
Response
Returns a RelationshipsLinks!
Arguments
| Name | Description |
|---|---|
query - RelationshipsLinksInput!
|
Example
Query
query RelationshipsLinks($query: RelationshipsLinksInput!) {
relationshipsLinks(query: $query) {
edges {
cursor
node {
... on LinkedAccount {
...LinkedAccountFragment
}
... on LinkedEntity {
...LinkedEntityFragment
}
... on LinkedMatch {
...LinkedMatchFragment
}
... on LinkedTransactionSummary {
...LinkedTransactionSummaryFragment
}
}
}
isQueued
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"query": RelationshipsLinksInput}
Response
{
"data": {
"relationshipsLinks": {
"edges": [DataModelEdge],
"isQueued": true,
"pageInfo": PageInfo
}
}
}
riskScoreTrends
Description
Retrieve list of RiskScoreTrend by month in provided year.
Response
Returns [RiskScorePayload!]!
Arguments
| Name | Description |
|---|---|
query - RiskScoreTrendsInput!
|
Example
Query
query RiskScoreTrends($query: RiskScoreTrendsInput!) {
riskScoreTrends(query: $query) {
count
month
riskScore
year
}
}
Variables
{"query": RiskScoreTrendsInput}
Response
{
"data": {
"riskScoreTrends": [
{
"count": 123,
"month": 987,
"riskScore": "xyz789",
"year": 987
}
]
}
}
riskScores
Description
Retrieve paginated list of RiskScores s.
Response
Returns a RiskScoresPage!
Arguments
| Name | Description |
|---|---|
query - RiskScoresInput!
|
Example
Query
query RiskScores($query: RiskScoresInput!) {
riskScores(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertingFeatures {
...ShapFeatureFragment
}
anomalyScore
cibScore
compositeScore
createdOn
customerData
deletedOn
entityId
hotspotScore
id
pipelineFamilyName
riskScoreDate
riskScoreSource
similarityScore
sourceId
sourceTable
updatedOn
}
totalRecords
}
}
Variables
{"query": RiskScoresInput}
Response
{
"data": {
"riskScores": {
"pageInfo": PageInfo,
"records": [RiskScore],
"totalRecords": 123
}
}
}
riskScoresFromDataLake
Description
Retrieve paginated list of RiskScore from Datalake
Response
Returns a RiskScoresPage!
Arguments
| Name | Description |
|---|---|
query - RiskScoresFromDataLakeInput!
|
Example
Query
query RiskScoresFromDataLake($query: RiskScoresFromDataLakeInput!) {
riskScoresFromDataLake(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
alertingFeatures {
...ShapFeatureFragment
}
anomalyScore
cibScore
compositeScore
createdOn
customerData
deletedOn
entityId
hotspotScore
id
pipelineFamilyName
riskScoreDate
riskScoreSource
similarityScore
sourceId
sourceTable
updatedOn
}
totalRecords
}
}
Variables
{"query": RiskScoresFromDataLakeInput}
Response
{
"data": {
"riskScoresFromDataLake": {
"pageInfo": PageInfo,
"records": [RiskScore],
"totalRecords": 123
}
}
}
s3Configuration
Description
Get S3 configuration
Response
Returns a S3ConfigurationResponse!
Example
Query
query S3Configuration {
s3Configuration {
s3
}
}
Response
{
"data": {
"s3Configuration": {"s3": "xyz789"}
}
}
systemNodes
Description
Get system nodes data.
Response
Returns a SystemNodeResponse!
Arguments
| Name | Description |
|---|---|
query - SystemNodesInput!
|
Example
Query
query SystemNodes($query: SystemNodesInput!) {
systemNodes(query: $query) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
cpuUsage {
...ActivityUsageFragment
}
diskUsage {
...ActivityUsageFragment
}
hostname
id
memoryUsage {
...ActivityUsageFragment
}
name
openIssues
operatingSystem
privateIPv4
privateIPv6
publicIPv4
publicIPv6
status
timestamp
}
totalRecords
}
}
Variables
{"query": SystemNodesInput}
Response
{
"data": {
"systemNodes": {
"pageInfo": PageInfo,
"records": [SystemNode],
"totalRecords": 123
}
}
}
systemPreference
Description
Return system preference information.
Response
Returns a SystemPreference!
Example
Query
query SystemPreference {
systemPreference {
currencyCode
language
timezone
weekStartsOn
}
}
Response
{
"data": {
"systemPreference": {
"currencyCode": "xyz789",
"language": "abc123",
"timezone": "abc123",
"weekStartsOn": "abc123"
}
}
}
trades
Description
Get Trades
Response
Returns a PaginatedTrades!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns items that appear after the specified cursor. |
alertId - String
|
ID of Detection. |
alertedEntityId - String
|
ID of alerted Entity. |
before - Cursor
|
Returns items that appear before the specified cursor. |
filterBy - TradeTransactionEventsFilter
|
Filter events by this type. Default = {} |
first - Int
|
Returns the first n items, starting after the cursor specified in the after field. This field is mutually exclusive with last. |
last - Int
|
Returns the last n items, starting before the cursor specified in the before field. This field is mutually exclusive with first. |
orderBy - [TradesOrderByInput!]
|
Specify the ordering of records. Default = [{field: TransactionDate, sort: ASC}] |
Example
Query
query Trades(
$after: Cursor,
$alertId: String,
$alertedEntityId: String,
$before: Cursor,
$filterBy: TradeTransactionEventsFilter,
$first: Int,
$last: Int,
$orderBy: [TradesOrderByInput!]
) {
trades(
after: $after,
alertId: $alertId,
alertedEntityId: $alertedEntityId,
before: $before,
filterBy: $filterBy,
first: $first,
last: $last,
orderBy: $orderBy
) {
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
records {
amount
amountNorm
beneficiary {
...TradeOriginatorOrBeneficiaryFragment
}
beneficiaryAccountNumber
bookId
buySell
cleanNetPrice
cleanPrice
countryOfResidence
currencyNorm
currencyTwo
dirtyPrice
entityId
expiryDate
farCashSettlementAmount
farLegAmountOne
farLegAmountTwo
farLegCurrencyOne
farLegCurrencyTwo
farLegFxRate
farLegValueDate
fixedRate
fixedRateTwo
floatingRate
floatingRateTwo
id
indexTicker
instrumentDetails
internalTrade
isin
isinInstrument
lastTradeEvent
nearLegAmountTwo
nearLegCurrencyTwo
nearLegFxRate
nearLegValueDate
nominalAmount
notionalTwo
numberOfUnits
originator {
...TradeOriginatorOrBeneficiaryFragment
}
originatorAccountNumber
paymentDate
pipelineFamilyName
quantity
quantityAmount
rulesTriggered {
...TradeRuleFragment
}
settlementAmount
settlementCurrency
settlementDate
strikePrice
tenor
tenorTwo
terminationDate
ticker
tickerInstrument
tradeStatus
tradeType
transactionCurrency
transactionDate
transactionId
transactionType
underlyingSecMarketPrice
unitPrice
workerCode
}
totalCount
}
}
Variables
{
"after": Cursor,
"alertId": "abc123",
"alertedEntityId": "xyz789",
"before": Cursor,
"filterBy": {},
"first": 123,
"last": 123,
"orderBy": [{"field": "TransactionDate", "sort": "ASC"}]
}
Response
{
"data": {
"trades": {
"pageInfo": CursorPageInfo,
"records": [TradesResponse],
"totalCount": 987
}
}
}
transactionSummaryDetails
Response
Returns a TransactionSummaryDetails!
Arguments
| Name | Description |
|---|---|
query - TransactionSummaryDetailsInput!
|
Example
Query
query TransactionSummaryDetails($query: TransactionSummaryDetailsInput!) {
transactionSummaryDetails(query: $query) {
edges {
cursor
node {
...EventModelFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalRecords
}
}
Variables
{"query": TransactionSummaryDetailsInput}
Response
{
"data": {
"transactionSummaryDetails": {
"edges": [TransactionEdge],
"pageInfo": PageInfo,
"totalRecords": 987
}
}
}
transactionTypes
Description
Retrieve list of latest transaction types for UI.
Response
Returns [TransactionType!]!
Example
Query
query TransactionTypes {
transactionTypes {
icon
label
value
}
}
Response
{
"data": {
"transactionTypes": [
{
"icon": "abc123",
"label": "abc123",
"value": "xyz789"
}
]
}
}
uiColumnVisibilityConfiguration
Description
This GraphQL query fetches field visibility settings from a YAML configuration file, determining which fields are displayed in Sensa UI table components.
Response
Returns an UiColumnVisibilityConfig!
Arguments
| Name | Description |
|---|---|
input - UiColumnVisibilityConfigInput!
|
Example
Query
query UiColumnVisibilityConfiguration($input: UiColumnVisibilityConfigInput!) {
uiColumnVisibilityConfiguration(input: $input) {
fields {
default
fields {
...FieldConfigFragment
}
name
}
}
}
Variables
{"input": UiColumnVisibilityConfigInput}
Response
{
"data": {
"uiColumnVisibilityConfiguration": {
"fields": [FieldConfig]
}
}
}
Mutations
acknowledgeNotification
Description
Acknowledgement from consumer for message sent.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - AcknowledgeNotificationInput!
|
Example
Query
mutation AcknowledgeNotification($input: AcknowledgeNotificationInput!) {
acknowledgeNotification(input: $input)
}
Variables
{"input": AcknowledgeNotificationInput}
Response
{"data": {"acknowledgeNotification": true}}
apiLogin
Description
Login with API Key to access protected resources.
Response
Returns an Auth!
Arguments
| Name | Description |
|---|---|
input - ApiLoginInput!
|
Example
Query
mutation ApiLogin($input: ApiLoginInput!) {
apiLogin(input: $input) {
accessToken
id
refreshToken
}
}
Variables
{"input": ApiLoginInput}
Response
{
"data": {
"apiLogin": {
"accessToken": "xyz789",
"id": "abc123",
"refreshToken": "abc123"
}
}
}
assignUserToDetections
Description
Assign user to detections
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AssignDetectionsInput!
|
Example
Query
mutation AssignUserToDetections($input: AssignDetectionsInput!) {
assignUserToDetections(input: $input)
}
Variables
{"input": AssignDetectionsInput}
Response
{"data": {"assignUserToDetections": true}}
createAdvancedRule
Description
Create a new Advanced Rule.
Response
Returns a Rule!
Arguments
| Name | Description |
|---|---|
input - CreateRuleInput!
|
Example
Query
mutation CreateAdvancedRule($input: CreateRuleInput!) {
createAdvancedRule(input: $input) {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
id
name
}
ruleSet {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleSetId
score
type
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"input": CreateRuleInput}
Response
{
"data": {
"createAdvancedRule": {
"active": false,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"eventType": "xyz789",
"id": "xyz789",
"name": "xyz789",
"rule": {},
"ruleActionIds": ["xyz789"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "xyz789",
"score": 987.65,
"type": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
}
}
createAlertNote
Description
Create a note for Alert.
Response
Returns an AlertNote!
Arguments
| Name | Description |
|---|---|
input - CreateNoteInput!
|
Example
Query
mutation CreateAlertNote($input: CreateNoteInput!) {
createAlertNote(input: $input) {
alertId
attachments {
createdOn
deletedOn
file {
...FileFragment
}
fileId
fileName
id
updatedOn
}
createdOn
deletedOn
id
ip
message
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"input": CreateNoteInput}
Response
{
"data": {
"createAlertNote": {
"alertId": "abc123",
"attachments": [AttachmentWithNote],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"ip": "xyz789",
"message": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123"
}
}
}
createAlertQueue
Description
Create a single AlertQueue.
Response
Returns an AlertQueue!
Arguments
| Name | Description |
|---|---|
input - CreateAlertQueueInput!
|
Example
Query
mutation CreateAlertQueue($input: CreateAlertQueueInput!) {
createAlertQueue(input: $input) {
alertTypes {
createdOn
creator {
...UserEntityFragment
}
deletedOn
id
name
query
score
updatedOn
version
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
currency
deletedOn
detections {
edges {
...DetectionEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
filters {
logic {
...LogicFragment
}
}
id
label
name
pipelineFamilyName
updatedOn
users {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": CreateAlertQueueInput}
Response
{
"data": {
"createAlertQueue": {
"alertTypes": [AlertType],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "xyz789",
"currency": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "abc123",
"label": "abc123",
"name": "xyz789",
"pipelineFamilyName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
}
}
createAlertType
Description
Create a single AlertType.
Response
Returns an AlertType!
Arguments
| Name | Description |
|---|---|
input - CreateAlertTypeInput!
|
Example
Query
mutation CreateAlertType($input: CreateAlertTypeInput!) {
createAlertType(input: $input) {
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
id
name
query
score
updatedOn
version
}
}
Variables
{"input": CreateAlertTypeInput}
Response
{
"data": {
"createAlertType": {
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"name": "abc123",
"query": "xyz789",
"score": 987.65,
"updatedOn": "2007-12-03T10:15:30Z",
"version": 123.45
}
}
}
createApiKey
Description
Create API Key for User.
Response
Returns a CreateApiKeyResponse!
Example
Query
mutation CreateApiKey {
createApiKey {
apiKey
}
}
Response
{
"data": {
"createApiKey": {"apiKey": "xyz789"}
}
}
createAuditLog
Description
Create a new Audit Log.
Response
Returns an AuditLogDto!
Arguments
| Name | Description |
|---|---|
input - CreateAuditLogInput!
|
Example
Query
mutation CreateAuditLog($input: CreateAuditLogInput!) {
createAuditLog(input: $input) {
activity
actor {
email
firstName
id
lastName
}
auditedObject {
id
label
type
}
auditedValues {
key
newValue
oldValue
}
createdOn
id
}
}
Variables
{"input": CreateAuditLogInput}
Response
{
"data": {
"createAuditLog": {
"activity": "xyz789",
"actor": AuditLogActor,
"auditedObject": AuditLogObject,
"auditedValues": [AuditLogAuditedAttribute],
"createdOn": "2007-12-03T10:15:30Z",
"id": "xyz789"
}
}
}
createDetectionStatus
Description
Create a single DetectionStatus.
Response
Returns a DetectionStatus!
Arguments
| Name | Description |
|---|---|
input - CreateAlertStatusInput!
|
Example
Query
mutation CreateDetectionStatus($input: CreateAlertStatusInput!) {
createDetectionStatus(input: $input) {
color
hasRiskRating
icon
id
isClosed
label
type
}
}
Variables
{"input": CreateAlertStatusInput}
Response
{
"data": {
"createDetectionStatus": {
"color": "abc123",
"hasRiskRating": true,
"icon": "abc123",
"id": "abc123",
"isClosed": true,
"label": "abc123",
"type": "abc123"
}
}
}
createFile
Description
Create a file.
Response
Returns a CreateFileResponseDto!
Arguments
| Name | Description |
|---|---|
input - CreateFileInput!
|
Example
Query
mutation CreateFile($input: CreateFileInput!) {
createFile(input: $input) {
bucket
createdOn
deletedOn
id
mimetype
name
size
updatedOn
}
}
Variables
{"input": CreateFileInput}
Response
{
"data": {
"createFile": {
"bucket": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"mimetype": "xyz789",
"name": "abc123",
"size": 123.45,
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
createFileStatus
Description
Create a file status.
Response
Returns a CreateFileStatusMessage!
Arguments
| Name | Description |
|---|---|
input - CreateFileStatusInput!
|
Example
Query
mutation CreateFileStatus($input: CreateFileStatusInput!) {
createFileStatus(input: $input) {
message
}
}
Variables
{"input": CreateFileStatusInput}
Response
{
"data": {
"createFileStatus": {
"message": "xyz789"
}
}
}
createKeyValue
Description
Create a single KeyValue.
Response
Returns a KeyValueType!
Arguments
| Name | Description |
|---|---|
input - CreateKeyValueInput!
|
Example
Query
mutation CreateKeyValue($input: CreateKeyValueInput!) {
createKeyValue(input: $input) {
createdOn
editPermissions
isEncrypted
isEnv
key
readPermissions
value
version
}
}
Variables
{"input": CreateKeyValueInput}
Response
{
"data": {
"createKeyValue": {
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": true,
"isEnv": true,
"key": "xyz789",
"readPermissions": {},
"value": {},
"version": "abc123"
}
}
}
createNewLoginCode
Replaced by
generateLoginCode. Removal on v5.0.0. Description
Create new login code for User.
Response
Returns a LoginCodeResponseObject
Arguments
| Name | Description |
|---|---|
input - CreateLoginCodeInput!
|
Example
Query
mutation CreateNewLoginCode($input: CreateLoginCodeInput!) {
createNewLoginCode(input: $input) {
appMode
refreshToken
samlCallbackUrl
success
token
}
}
Variables
{"input": CreateLoginCodeInput}
Response
{
"data": {
"createNewLoginCode": {
"appMode": "abc123",
"refreshToken": "xyz789",
"samlCallbackUrl": "xyz789",
"success": true,
"token": "xyz789"
}
}
}
createNotification
Description
Create notification and append message to queue.
Response
Returns a CreateEleNotificationPayload
Arguments
| Name | Description |
|---|---|
input - CreateNotificationInput!
|
Example
Query
mutation CreateNotification($input: CreateNotificationInput!) {
createNotification(input: $input) {
id
}
}
Variables
{"input": CreateNotificationInput}
Response
{"data": {"createNotification": {"id": 4}}}
createPipeline
Description
Create Pipelines.
Response
Returns a Pipeline!
Arguments
| Name | Description |
|---|---|
input - PipelineInput!
|
Example
Query
mutation CreatePipeline($input: PipelineInput!) {
createPipeline(input: $input) {
config
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
dependencies
description
displayName
featureSchedule
id
label
pipelineStatus {
createdOn
deletedOn
duration
finishTime
id
message
pipelineId
runId
startTime
status
step
updatedOn
}
ruleSets {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
systemName
triggeringFrequency
type
updatedOn
updater {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": PipelineInput}
Response
{
"data": {
"createPipeline": {
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": "xyz789",
"description": "abc123",
"displayName": "abc123",
"featureSchedule": "xyz789",
"id": "abc123",
"label": "xyz789",
"pipelineStatus": [PipelineStatusModel],
"ruleSets": [RuleSet],
"systemName": "xyz789",
"triggeringFrequency": "abc123",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updater": UserEntity
}
}
}
createPipelineFeature
Description
Create PipelineFeature.
Response
Returns a PipelineFeatureResponse!
Arguments
| Name | Description |
|---|---|
input - CreatePipelineFeatureInput!
|
Example
Query
mutation CreatePipelineFeature($input: CreatePipelineFeatureInput!) {
createPipelineFeature(input: $input) {
activeFlag
config
featureName
featureType
pipelineName
}
}
Variables
{"input": CreatePipelineFeatureInput}
Response
{
"data": {
"createPipelineFeature": {
"activeFlag": true,
"config": {},
"featureName": "abc123",
"featureType": "xyz789",
"pipelineName": "xyz789"
}
}
}
createPipelineRun
Description
Manually triggers a Pipeline run.
Response
Returns a CreatePipelineRunResponse!
Arguments
| Name | Description |
|---|---|
input - CreatePipelineRunInput!
|
Example
Query
mutation CreatePipelineRun($input: CreatePipelineRunInput!) {
createPipelineRun(input: $input) {
runId
}
}
Variables
{"input": CreatePipelineRunInput}
Response
{
"data": {
"createPipelineRun": {"runId": "xyz789"}
}
}
createPipelineScheduleExceptions
Description
Create PipelineScheduleExceptions.
Response
Returns a BulkInsertResponse!
Arguments
| Name | Description |
|---|---|
input - CreatePipelineScheduleExceptionsInput!
|
Example
Query
mutation CreatePipelineScheduleExceptions($input: CreatePipelineScheduleExceptionsInput!) {
createPipelineScheduleExceptions(input: $input) {
errors {
input
message
}
success
totalRecords
}
}
Variables
{"input": CreatePipelineScheduleExceptionsInput}
Response
{
"data": {
"createPipelineScheduleExceptions": {
"errors": [BulkInsertError],
"success": true,
"totalRecords": 123.45
}
}
}
createPipelineStatus
Description
Create PipelineStatus.
Response
Returns a PipelineStatus!
Arguments
| Name | Description |
|---|---|
input - CreatePipelineStatusInput!
|
Example
Query
mutation CreatePipelineStatus($input: CreatePipelineStatusInput!) {
createPipelineStatus(input: $input) {
createdOn
deletedOn
duration
finishTime
id
logPath
message
pipelineId
runId
startTime
status
step
updatedOn
}
}
Variables
{"input": CreatePipelineStatusInput}
Response
{
"data": {
"createPipelineStatus": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"duration": "abc123",
"finishTime": "2007-12-03T10:15:30Z",
"id": "4",
"logPath": "xyz789",
"message": "abc123",
"pipelineId": "xyz789",
"runId": "xyz789",
"startTime": "2007-12-03T10:15:30Z",
"status": "Error",
"step": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
createRiskRating
Description
Create a risk rating.
Response
Returns a RiskRating!
Arguments
| Name | Description |
|---|---|
createRiskRatingInput - CreateRiskRatingInput!
|
Example
Query
mutation CreateRiskRating($createRiskRatingInput: CreateRiskRatingInput!) {
createRiskRating(createRiskRatingInput: $createRiskRatingInput) {
color
deletedOn
displayOrder
id
label
}
}
Variables
{"createRiskRatingInput": CreateRiskRatingInput}
Response
{
"data": {
"createRiskRating": {
"color": "xyz789",
"deletedOn": "2007-12-03",
"displayOrder": 987.65,
"id": "abc123",
"label": "xyz789"
}
}
}
createRule
Description
Create a new Rule.
Response
Returns a Rule!
Arguments
| Name | Description |
|---|---|
input - CreateRuleInput!
|
Example
Query
mutation CreateRule($input: CreateRuleInput!) {
createRule(input: $input) {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
id
name
}
ruleSet {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleSetId
score
type
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"input": CreateRuleInput}
Response
{
"data": {
"createRule": {
"active": true,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"eventType": "xyz789",
"id": "abc123",
"name": "abc123",
"rule": {},
"ruleActionIds": ["abc123"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "xyz789",
"score": 123.45,
"type": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123"
}
}
}
createRuleAction
Relationships between
Rule and RuleAction is now managed in Rule resolvers. Removal on v5.0.0. Description
Create a new RuleAction.
Response
Returns a RuleActionModel
Arguments
| Name | Description |
|---|---|
input - CreateRuleActionInput!
|
Example
Query
mutation CreateRuleAction($input: CreateRuleActionInput!) {
createRuleAction(input: $input) {
createdOn
deletedOn
id
rule {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleActionIds
ruleId
updatedOn
}
}
Variables
{"input": CreateRuleActionInput}
Response
{
"data": {
"createRuleAction": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"rule": Rule,
"ruleActionIds": ["xyz789"],
"ruleId": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
createRuleFlags
Description
Create RuleFlags.
Response
Returns a BulkInsertResponse!
Arguments
| Name | Description |
|---|---|
input - CreateRuleFlagsInput!
|
Example
Query
mutation CreateRuleFlags($input: CreateRuleFlagsInput!) {
createRuleFlags(input: $input) {
errors {
input
message
}
success
totalRecords
}
}
Variables
{"input": CreateRuleFlagsInput}
Response
{
"data": {
"createRuleFlags": {
"errors": [BulkInsertError],
"success": true,
"totalRecords": 123.45
}
}
}
createRuleSet
Description
Create a single RuleSet.
Response
Returns a RuleSet!
Arguments
| Name | Description |
|---|---|
input - CreateRuleSetsInput!
|
Example
Query
mutation CreateRuleSet($input: CreateRuleSetsInput!) {
createRuleSet(input: $input) {
createdOn
deletedOn
description
enabled
id
name
pipeline {
config
createdOn
creatorId
deletedOn
dependencies
description
displayName
featureSchedule
id
isDisabled
label
pipelineStatus {
...PipelineStatusModelFragment
}
systemName
triggeringFrequency
type
updatedOn
updaterId
}
pipelineId
preconditions
rules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"input": CreateRuleSetsInput}
Response
{
"data": {
"createRuleSet": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"enabled": true,
"id": "abc123",
"name": "xyz789",
"pipeline": PipelineModel,
"pipelineId": "xyz789",
"preconditions": {},
"rules": [RuleEntity],
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123"
}
}
}
createTrainingModel
Description
Create a Training Model.
Response
Returns a TrainingModel!
Arguments
| Name | Description |
|---|---|
input - CreateTrainingModelInput!
|
Example
Query
mutation CreateTrainingModel($input: CreateTrainingModelInput!) {
createTrainingModel(input: $input) {
createdOn
deletedOn
id
modelData
modelName
updatedOn
}
}
Variables
{"input": CreateTrainingModelInput}
Response
{
"data": {
"createTrainingModel": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"modelData": {},
"modelName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
}
}
createUser
Description
Create a single User.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - CreateUserInput!
|
Example
Query
mutation CreateUser($input: CreateUserInput!) {
createUser(input: $input) {
alert_queues_assigned {
alertQueue {
...AlertQueueFragment
}
alertQueueId
usersId
}
alert_queues_owned {
alertTypes {
...AlertTypeFragment
}
createdOn
creator {
...UserEntityFragment
}
creatorId
currency
deletedOn
detections {
...DetectionConnectionFragment
}
filters {
...FiltersFragment
}
id
label
name
pipelineFamilyName
updatedOn
users {
...UserEntityFragment
}
}
createdOn
deletedOn
email
enabled
first_name
fullName
id
imageId
language
last_name
login_codes {
code
createDate
email
user {
...UserEntityFragment
}
}
permissions
preferences {
currencyCode
language
timezone
weekStartsOn
}
role
time_zone
tokens {
createdOn
deletedOn
id
ip
token
updatedOn
user {
...UserEntityFragment
}
}
updatedOn
username
weekStartsOn
}
}
Variables
{"input": CreateUserInput}
Response
{
"data": {
"createUser": {
"alert_queues_assigned": [AlertQueueAssigned],
"alert_queues_owned": [AlertQueue],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "abc123",
"enabled": false,
"first_name": "abc123",
"fullName": "xyz789",
"id": "xyz789",
"imageId": "abc123",
"language": "xyz789",
"last_name": "xyz789",
"login_codes": LoginCode,
"permissions": {},
"preferences": UserPreference,
"role": "abc123",
"time_zone": "xyz789",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "abc123"
}
}
}
createUsers
Description
Create multiple Users.
Response
Returns a BulkInsertResponse!
Arguments
| Name | Description |
|---|---|
input - CreateUsersInput!
|
Example
Query
mutation CreateUsers($input: CreateUsersInput!) {
createUsers(input: $input) {
errors {
input
message
}
success
totalRecords
}
}
Variables
{"input": CreateUsersInput}
Response
{
"data": {
"createUsers": {
"errors": [BulkInsertError],
"success": true,
"totalRecords": 123.45
}
}
}
deleteActivity
Description
Delete an Activity.
Response
Returns an ActivityModel!
Arguments
| Name | Description |
|---|---|
input - DeleteActivityInput!
|
Example
Query
mutation DeleteActivity($input: DeleteActivityInput!) {
deleteActivity(input: $input) {
activityAttributes
activityType
assignedUser {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
deletedOn
id
ip
message
messageType
referenceId
unassignedUser {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": DeleteActivityInput}
Response
{
"data": {
"deleteActivity": {
"activityAttributes": {},
"activityType": "Alert",
"assignedUser": UserEntity,
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"ip": "xyz789",
"message": "xyz789",
"messageType": "abc123",
"referenceId": "abc123",
"unassignedUser": UserEntity
}
}
}
deleteAlertQueue
Description
Delete a single AlertQueue.
Response
Returns an AlertQueue!
Arguments
| Name | Description |
|---|---|
input - AlertQueueIdInput!
|
Input type of DeleteAlertQueue. |
Example
Query
mutation DeleteAlertQueue($input: AlertQueueIdInput!) {
deleteAlertQueue(input: $input) {
alertTypes {
createdOn
creator {
...UserEntityFragment
}
deletedOn
id
name
query
score
updatedOn
version
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
currency
deletedOn
detections {
edges {
...DetectionEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
filters {
logic {
...LogicFragment
}
}
id
label
name
pipelineFamilyName
updatedOn
users {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": AlertQueueIdInput}
Response
{
"data": {
"deleteAlertQueue": {
"alertTypes": [AlertType],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "abc123",
"currency": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "xyz789",
"label": "xyz789",
"name": "xyz789",
"pipelineFamilyName": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
}
}
deleteAlertType
Description
Delete a single AlertType.
Response
Returns an AlertType!
Arguments
| Name | Description |
|---|---|
input - DeleteAlertTypeInput!
|
Example
Query
mutation DeleteAlertType($input: DeleteAlertTypeInput!) {
deleteAlertType(input: $input) {
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
id
name
query
score
updatedOn
version
}
}
Variables
{"input": DeleteAlertTypeInput}
Response
{
"data": {
"deleteAlertType": {
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"name": "abc123",
"query": "xyz789",
"score": 987.65,
"updatedOn": "2007-12-03T10:15:30Z",
"version": 123.45
}
}
}
deleteFeatureToggle
Description
Delete a Feature toggle.
Response
Returns a FeatureToggleDto!
Arguments
| Name | Description |
|---|---|
input - DeleteFeatureToggleInput!
|
Example
Query
mutation DeleteFeatureToggle($input: DeleteFeatureToggleInput!) {
deleteFeatureToggle(input: $input) {
key
value
}
}
Variables
{"input": DeleteFeatureToggleInput}
Response
{
"data": {
"deleteFeatureToggle": {"key": "EntityLinksExplorer", "value": false}
}
}
deleteFile
Description
Delete a file.
Response
Returns a DeleteFileMessage!
Arguments
| Name | Description |
|---|---|
input - FileInput!
|
Example
Query
mutation DeleteFile($input: FileInput!) {
deleteFile(input: $input) {
message
}
}
Variables
{"input": FileInput}
Response
{
"data": {
"deleteFile": {"message": "xyz789"}
}
}
deleteRiskRating
Description
Delete a single RiskRating.
Response
Returns a RiskRating!
Arguments
| Name | Description |
|---|---|
input - GetRiskRating!
|
Example
Query
mutation DeleteRiskRating($input: GetRiskRating!) {
deleteRiskRating(input: $input) {
color
deletedOn
displayOrder
id
label
}
}
Variables
{"input": GetRiskRating}
Response
{
"data": {
"deleteRiskRating": {
"color": "abc123",
"deletedOn": "2007-12-03",
"displayOrder": 123.45,
"id": "abc123",
"label": "abc123"
}
}
}
deleteRule
Description
Delete a single Rule.
Response
Returns a Rule!
Arguments
| Name | Description |
|---|---|
input - DeleteRuleInput!
|
Example
Query
mutation DeleteRule($input: DeleteRuleInput!) {
deleteRule(input: $input) {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
id
name
}
ruleSet {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleSetId
score
type
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"input": DeleteRuleInput}
Response
{
"data": {
"deleteRule": {
"active": true,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"eventType": "abc123",
"id": "abc123",
"name": "xyz789",
"rule": {},
"ruleActionIds": ["abc123"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "xyz789",
"score": 987.65,
"type": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123"
}
}
}
deleteRuleSet
Description
Delete a single RuleSet.
Response
Returns a RuleSetResponse!
Arguments
| Name | Description |
|---|---|
input - DeleteRuleSetInput!
|
Example
Query
mutation DeleteRuleSet($input: DeleteRuleSetInput!) {
deleteRuleSet(input: $input) {
createdOn
deletedOn
description
enabled
id
name
pipeline {
config
createdOn
creatorId
deletedOn
dependencies
description
displayName
featureSchedule
id
isDisabled
label
pipelineStatus {
...PipelineStatusModelFragment
}
systemName
triggeringFrequency
type
updatedOn
updaterId
}
pipelineId
preconditions
rules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
versions {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
}
}
Variables
{"input": DeleteRuleSetInput}
Response
{
"data": {
"deleteRuleSet": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"enabled": true,
"id": "abc123",
"name": "abc123",
"pipeline": PipelineModel,
"pipelineId": "xyz789",
"preconditions": {},
"rules": [RuleEntity],
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789",
"versions": [RuleSet]
}
}
}
deleteSamlSettings
Description
Delete SAML Settings from KVS
Response
Returns a Boolean!
Example
Query
mutation DeleteSamlSettings {
deleteSamlSettings
}
Response
{"data": {"deleteSamlSettings": false}}
deleteUser
Description
Delete a single User.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - DeleteUserInput!
|
Example
Query
mutation DeleteUser($input: DeleteUserInput!) {
deleteUser(input: $input) {
alert_queues_assigned {
alertQueue {
...AlertQueueFragment
}
alertQueueId
usersId
}
alert_queues_owned {
alertTypes {
...AlertTypeFragment
}
createdOn
creator {
...UserEntityFragment
}
creatorId
currency
deletedOn
detections {
...DetectionConnectionFragment
}
filters {
...FiltersFragment
}
id
label
name
pipelineFamilyName
updatedOn
users {
...UserEntityFragment
}
}
createdOn
deletedOn
email
enabled
first_name
fullName
id
imageId
language
last_name
login_codes {
code
createDate
email
user {
...UserEntityFragment
}
}
permissions
preferences {
currencyCode
language
timezone
weekStartsOn
}
role
time_zone
tokens {
createdOn
deletedOn
id
ip
token
updatedOn
user {
...UserEntityFragment
}
}
updatedOn
username
weekStartsOn
}
}
Variables
{"input": DeleteUserInput}
Response
{
"data": {
"deleteUser": {
"alert_queues_assigned": [AlertQueueAssigned],
"alert_queues_owned": [AlertQueue],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "abc123",
"enabled": false,
"first_name": "xyz789",
"fullName": "abc123",
"id": "abc123",
"imageId": "xyz789",
"language": "abc123",
"last_name": "abc123",
"login_codes": LoginCode,
"permissions": {},
"preferences": UserPreference,
"role": "abc123",
"time_zone": "abc123",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "xyz789"
}
}
}
disablePipeline
Description
Disable Pipeline.
Response
Returns a Pipeline!
Arguments
| Name | Description |
|---|---|
input - DisablePipelineInput!
|
Example
Query
mutation DisablePipeline($input: DisablePipelineInput!) {
disablePipeline(input: $input) {
config
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
dependencies
description
displayName
featureSchedule
id
label
pipelineStatus {
createdOn
deletedOn
duration
finishTime
id
message
pipelineId
runId
startTime
status
step
updatedOn
}
ruleSets {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
systemName
triggeringFrequency
type
updatedOn
updater {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": DisablePipelineInput}
Response
{
"data": {
"disablePipeline": {
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": "abc123",
"description": "xyz789",
"displayName": "abc123",
"featureSchedule": "xyz789",
"id": "xyz789",
"label": "xyz789",
"pipelineStatus": [PipelineStatusModel],
"ruleSets": [RuleSet],
"systemName": "abc123",
"triggeringFrequency": "abc123",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updater": UserEntity
}
}
}
enablePipeline
Description
Enable Pipeline.
Response
Returns a Pipeline!
Arguments
| Name | Description |
|---|---|
input - EnablePipelineInput!
|
Example
Query
mutation EnablePipeline($input: EnablePipelineInput!) {
enablePipeline(input: $input) {
config
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
dependencies
description
displayName
featureSchedule
id
label
pipelineStatus {
createdOn
deletedOn
duration
finishTime
id
message
pipelineId
runId
startTime
status
step
updatedOn
}
ruleSets {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
systemName
triggeringFrequency
type
updatedOn
updater {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": EnablePipelineInput}
Response
{
"data": {
"enablePipeline": {
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": "xyz789",
"description": "abc123",
"displayName": "xyz789",
"featureSchedule": "xyz789",
"id": "xyz789",
"label": "xyz789",
"pipelineStatus": [PipelineStatusModel],
"ruleSets": [RuleSet],
"systemName": "abc123",
"triggeringFrequency": "abc123",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updater": UserEntity
}
}
}
flushAll
Description
Flush all cached data.
Response
Returns a Boolean!
Example
Query
mutation FlushAll {
flushAll
}
Response
{"data": {"flushAll": true}}
flushCache
Description
Flush data from in-memory cache.
Response
Returns a Boolean!
Example
Query
mutation FlushCache {
flushCache
}
Response
{"data": {"flushCache": false}}
flushDb
Description
Flush data from DB.
Response
Returns a Boolean!
Example
Query
mutation FlushDb {
flushDb
}
Response
{"data": {"flushDb": true}}
flushSearch
Description
Flush data from Meilisearch.
Response
Returns a FlushSearchPayload!
Example
Query
mutation FlushSearch {
flushSearch {
error
message
success
}
}
Response
{
"data": {
"flushSearch": {
"error": "xyz789",
"message": "xyz789",
"success": true
}
}
}
generateLoginCode
Description
Generates a new login code or SAML redirect URL for user authentication.
Response
Returns a LoginCodeResponseObject!
Arguments
| Name | Description |
|---|---|
input - CreateLoginCodeInput!
|
Example
Query
mutation GenerateLoginCode($input: CreateLoginCodeInput!) {
generateLoginCode(input: $input) {
appMode
refreshToken
samlCallbackUrl
success
token
}
}
Variables
{"input": CreateLoginCodeInput}
Response
{
"data": {
"generateLoginCode": {
"appMode": "abc123",
"refreshToken": "xyz789",
"samlCallbackUrl": "abc123",
"success": true,
"token": "abc123"
}
}
}
initialSetup
Description
Initial app setup
Response
Returns an InitialSetupResponse!
Arguments
| Name | Description |
|---|---|
input - InitialSetupByEmail!
|
Example
Query
mutation InitialSetup($input: InitialSetupByEmail!) {
initialSetup(input: $input) {
apiKey
message
status
}
}
Variables
{"input": InitialSetupByEmail}
Response
{
"data": {
"initialSetup": {
"apiKey": "abc123",
"message": "xyz789",
"status": "xyz789"
}
}
}
invalidateCache
Description
Invalidate cache. Optionally receives a string to search if included.
Response
Returns an InvalidateCache!
Arguments
| Name | Description |
|---|---|
input - InvalidateCacheInput!
|
Example
Query
mutation InvalidateCache($input: InvalidateCacheInput!) {
invalidateCache(input: $input) {
deletedCacheObjects
}
}
Variables
{"input": InvalidateCacheInput}
Response
{"data": {"invalidateCache": {"deletedCacheObjects": 123.45}}}
login
Description
Login with code to access protected resources.
Response
Returns an Auth!
Arguments
| Name | Description |
|---|---|
input - LoginInput!
|
Example
Query
mutation Login($input: LoginInput!) {
login(input: $input) {
accessToken
id
refreshToken
}
}
Variables
{"input": LoginInput}
Response
{
"data": {
"login": {
"accessToken": "xyz789",
"id": "abc123",
"refreshToken": "xyz789"
}
}
}
oidcLogin
Description
Login with OIDC code to access protected resources.
Response
Returns an Auth!
Arguments
| Name | Description |
|---|---|
input - OidcLoginInput!
|
Example
Query
mutation OidcLogin($input: OidcLoginInput!) {
oidcLogin(input: $input) {
accessToken
id
refreshToken
}
}
Variables
{"input": OidcLoginInput}
Response
{
"data": {
"oidcLogin": {
"accessToken": "xyz789",
"id": "abc123",
"refreshToken": "abc123"
}
}
}
refreshToken
Description
Refresh token.
Example
Query
mutation RefreshToken($token: String!) {
refreshToken(token: $token) {
accessToken
id
refreshToken
}
}
Variables
{"token": "abc123"}
Response
{
"data": {
"refreshToken": {
"accessToken": "abc123",
"id": "abc123",
"refreshToken": "abc123"
}
}
}
restartPod
Description
Restart a particular Kubernetes Pod.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RestartPodInput!
|
Example
Query
mutation RestartPod($input: RestartPodInput!) {
restartPod(input: $input)
}
Variables
{"input": RestartPodInput}
Response
{"data": {"restartPod": true}}
ruleEngineEvaluate
Description
Run Engine Evaluate.
Response
Returns a RuleEngineEvaluateResponse!
Arguments
| Name | Description |
|---|---|
input - RuleEngineEvaluateInput!
|
Example
Query
mutation RuleEngineEvaluate($input: RuleEngineEvaluateInput!) {
ruleEngineEvaluate(input: $input) {
runId
status
}
}
Variables
{"input": RuleEngineEvaluateInput}
Response
{
"data": {
"ruleEngineEvaluate": {
"runId": "abc123",
"status": "abc123"
}
}
}
setFeatureToggle
Description
Set the value of a Feature toggle.
Response
Returns a FeatureToggleDto!
Arguments
| Name | Description |
|---|---|
input - SetFeatureToggleInput!
|
Example
Query
mutation SetFeatureToggle($input: SetFeatureToggleInput!) {
setFeatureToggle(input: $input) {
key
value
}
}
Variables
{"input": SetFeatureToggleInput}
Response
{"data": {"setFeatureToggle": {"key": "EntityLinksExplorer", "value": false}}}
signOut
Description
Sign out and revoke all active tokens.
Response
Returns a Boolean!
Example
Query
mutation SignOut {
signOut
}
Response
{"data": {"signOut": false}}
testSMTPSettings
Response
Returns an TestSMTPSettingsResponse!
Arguments
| Name | Description |
|---|---|
input - TestSMTPSettingsInput!
|
Example
Query
mutation TestSMTPSettings($input: TestSMTPSettingsInput!) {
testSMTPSettings(input: $input) {
success
}
}
Variables
{"input": TestSMTPSettingsInput}
Response
{"data": {"testSMTPSettings": {"success": false}}}
toggleIssueStatus
Description
Toggle open status of a single issue.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ToggleIssueStatusInput!
|
Example
Query
mutation ToggleIssueStatus($input: ToggleIssueStatusInput!) {
toggleIssueStatus(input: $input)
}
Variables
{"input": ToggleIssueStatusInput}
Response
{"data": {"toggleIssueStatus": false}}
triggerEntityLinksMapping
Description
Trigger Entity Links Mapping process.
Response
Returns an EntityLinksMappingResponse!
Example
Query
mutation TriggerEntityLinksMapping {
triggerEntityLinksMapping {
errors
success
totalRecords
}
}
Response
{
"data": {
"triggerEntityLinksMapping": {
"errors": ["abc123"],
"success": false,
"totalRecords": 987.65
}
}
}
triggerEtlJob
Description
Trigger ETL process via Styx`.
Response
Returns a JobStatusPayload!
Arguments
| Name | Description |
|---|---|
input - TriggerEtlJobInput!
|
Example
Query
mutation TriggerEtlJob($input: TriggerEtlJobInput!) {
triggerEtlJob(input: $input) {
error
processId
status
}
}
Variables
{"input": TriggerEtlJobInput}
Response
{
"data": {
"triggerEtlJob": {
"error": "abc123",
"processId": "xyz789",
"status": "xyz789"
}
}
}
unassignUserFromDetections
Description
Unassign user from detections
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - [String!]!
|
Example
Query
mutation UnassignUserFromDetections($input: [String!]!) {
unassignUserFromDetections(input: $input)
}
Variables
{"input": ["abc123"]}
Response
{"data": {"unassignUserFromDetections": true}}
updateAdminSettings
Description
Update a batch/list of ADMIN_SETTINGS KeyValues.
Response
Returns [KeyValueType!]!
Arguments
| Name | Description |
|---|---|
input - UpdateAdminSettingsKeyValuesInput!
|
Example
Query
mutation UpdateAdminSettings($input: UpdateAdminSettingsKeyValuesInput!) {
updateAdminSettings(input: $input) {
createdOn
editPermissions
isEncrypted
isEnv
key
readPermissions
value
version
}
}
Variables
{"input": UpdateAdminSettingsKeyValuesInput}
Response
{
"data": {
"updateAdminSettings": [
{
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": true,
"isEnv": true,
"key": "xyz789",
"readPermissions": {},
"value": {},
"version": "abc123"
}
]
}
}
updateAlertDecision
Description
Update decision of Detection.
Response
Returns a Detection!
Arguments
| Name | Description |
|---|---|
input - UpdateAlertDecisionInput!
|
Example
Query
mutation UpdateAlertDecision($input: UpdateAlertDecisionInput!) {
updateAlertDecision(input: $input) {
alertDate
anomalyScore
assignedTo {
email
first_name
id
imageId
last_name
}
assignedToUserId
category
cibScore
compositeScore
decision {
color
deletedOn
displayOrder
id
label
}
detectionType
domainCode
entity {
accounts {
...AccountConnectionFragment
}
activeExemption {
...ExemptionListFragment
}
annualIncome
businessUnit
countryOfResidence
customerSegment
email
entityType
externalEntityId
file {
...FileFragment
}
fullAddress
fullName
furtherInformation
id
label
onboardDate
orgUnitCode
overallRiskScore
phone
pipelineFamilyName
sourceId
sourceName
sourceTable
subtype
}
entityDetectionTypesForMonth
hotspotScore
id
overallScore
pipelineFamilyName
ruleIds
rules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
shap {
entityId
featureDate
features {
...ShapFeatureFragment
}
id
}
sourceId
sourceTable
status
statusUpdatedOn
subtype
supervisedScore
supplementaryInformation {
edges {
...DetectionRuleDetailsEdgeFragment
}
pageInfo {
...CursorPageInfoFragment
}
totalCount
}
transactions {
edges {
...EventModelEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
}
}
Variables
{"input": UpdateAlertDecisionInput}
Response
{
"data": {
"updateAlertDecision": {
"alertDate": "2007-12-03",
"anomalyScore": 987.65,
"assignedTo": AssignedTo,
"assignedToUserId": "xyz789",
"category": "abc123",
"cibScore": 987.65,
"compositeScore": 123.45,
"decision": RiskRating,
"detectionType": "abc123",
"domainCode": "xyz789",
"entity": Entity,
"entityDetectionTypesForMonth": [
"abc123"
],
"hotspotScore": 987.65,
"id": "xyz789",
"overallScore": 123.45,
"pipelineFamilyName": "xyz789",
"ruleIds": ["abc123"],
"rules": [Rule],
"shap": Shap,
"sourceId": "abc123",
"sourceTable": "abc123",
"status": "abc123",
"statusUpdatedOn": "2007-12-03",
"subtype": "abc123",
"supervisedScore": 123.45,
"supplementaryInformation": DetectionRuleDetailConnection,
"transactions": DetectionTransactionConnection
}
}
}
updateAlertQueue
Description
Update a single AlertQueue.
Response
Returns an AlertQueue!
Arguments
| Name | Description |
|---|---|
input - UpdateAlertQueueInput!
|
Example
Query
mutation UpdateAlertQueue($input: UpdateAlertQueueInput!) {
updateAlertQueue(input: $input) {
alertTypes {
createdOn
creator {
...UserEntityFragment
}
deletedOn
id
name
query
score
updatedOn
version
}
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
creatorId
currency
deletedOn
detections {
edges {
...DetectionEdgeFragment
}
pageInfo {
...LegacyCursorPageInfoFragment
}
totalCount
}
filters {
logic {
...LogicFragment
}
}
id
label
name
pipelineFamilyName
updatedOn
users {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": UpdateAlertQueueInput}
Response
{
"data": {
"updateAlertQueue": {
"alertTypes": [AlertType],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "abc123",
"currency": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "xyz789",
"label": "abc123",
"name": "xyz789",
"pipelineFamilyName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
}
}
updateAlertType
Description
Update a single AlertType.
Response
Returns an AlertType!
Arguments
| Name | Description |
|---|---|
input - UpdateAlertTypeInput!
|
Example
Query
mutation UpdateAlertType($input: UpdateAlertTypeInput!) {
updateAlertType(input: $input) {
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
id
name
query
score
updatedOn
version
}
}
Variables
{"input": UpdateAlertTypeInput}
Response
{
"data": {
"updateAlertType": {
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"name": "xyz789",
"query": "abc123",
"score": 123.45,
"updatedOn": "2007-12-03T10:15:30Z",
"version": 123.45
}
}
}
updateDetectionDetailsAdminSettings
Description
Updates Detection Details Admin Settings .
Response
Arguments
| Name | Description |
|---|---|
input - UpdateKeyValueInput!
|
Example
Query
mutation UpdateDetectionDetailsAdminSettings($input: UpdateKeyValueInput!) {
updateDetectionDetailsAdminSettings(input: $input) {
id
panels {
id
visibility
}
visibility
}
}
Variables
{"input": UpdateKeyValueInput}
Response
{
"data": {
"updateDetectionDetailsAdminSettings": [
{
"id": "xyz789",
"panels": [DetectionDetailsAdminSettingsBase],
"visibility": 123.45
}
]
}
}
updateDetectionStatus
Description
Update a single DetectionStatus.
Response
Returns a DetectionStatus!
Arguments
| Name | Description |
|---|---|
input - UpdateAlertStatusInput!
|
Example
Query
mutation UpdateDetectionStatus($input: UpdateAlertStatusInput!) {
updateDetectionStatus(input: $input) {
color
hasRiskRating
icon
id
isClosed
label
type
}
}
Variables
{"input": UpdateAlertStatusInput}
Response
{
"data": {
"updateDetectionStatus": {
"color": "abc123",
"hasRiskRating": true,
"icon": "xyz789",
"id": "xyz789",
"isClosed": true,
"label": "abc123",
"type": "abc123"
}
}
}
updateKeyValue
Description
Update a single KeyValue
Response
Returns a KeyValueType!
Arguments
| Name | Description |
|---|---|
input - UpdateKeyValueInput!
|
Example
Query
mutation UpdateKeyValue($input: UpdateKeyValueInput!) {
updateKeyValue(input: $input) {
createdOn
editPermissions
isEncrypted
isEnv
key
readPermissions
value
version
}
}
Variables
{"input": UpdateKeyValueInput}
Response
{
"data": {
"updateKeyValue": {
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": false,
"isEnv": false,
"key": "abc123",
"readPermissions": {},
"value": {},
"version": "xyz789"
}
}
}
updateKeyValues
Description
Update a batch/list of KeyValues.
Response
Returns [KeyValueType!]!
Arguments
| Name | Description |
|---|---|
input - UpdateKeyValuesInput!
|
Example
Query
mutation UpdateKeyValues($input: UpdateKeyValuesInput!) {
updateKeyValues(input: $input) {
createdOn
editPermissions
isEncrypted
isEnv
key
readPermissions
value
version
}
}
Variables
{"input": UpdateKeyValuesInput}
Response
{
"data": {
"updateKeyValues": [
{
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": false,
"isEnv": true,
"key": "xyz789",
"readPermissions": {},
"value": {},
"version": "xyz789"
}
]
}
}
updatePipeline
Description
Update a single Pipeline.
Response
Returns a PipelineDetailDto!
Arguments
| Name | Description |
|---|---|
input - UpdatePipelineInput!
|
Example
Query
mutation UpdatePipeline($input: UpdatePipelineInput!) {
updatePipeline(input: $input) {
config
createdOn
creator {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
deletedOn
dependencies {
displayName
id
label
}
description
displayName
featureSchedule
id
label
pipelineConfigStatus {
dataSource
featureSets
mlModels
ruleSets
}
pipelineFamilyName
pipelineStatus {
createdOn
deletedOn
duration
finishTime
id
logPath
message
pipelineId
runId
startTime
status
step
updatedOn
}
ruleSets {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
systemName
triggeringFrequency
type
updatedOn
updater {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
}
}
Variables
{"input": UpdatePipelineInput}
Response
{
"data": {
"updatePipeline": {
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": [PipelineDependencyDto],
"description": "xyz789",
"displayName": "abc123",
"featureSchedule": "xyz789",
"id": "abc123",
"label": "xyz789",
"pipelineConfigStatus": PipelineConfigStatus,
"pipelineFamilyName": "xyz789",
"pipelineStatus": PipelineStatus,
"ruleSets": [RuleSet],
"systemName": "xyz789",
"triggeringFrequency": "abc123",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updater": UserEntity
}
}
}
updateProfile
Description
Update authenticated User profile.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - UpdateProfileInput!
|
Example
Query
mutation UpdateProfile($input: UpdateProfileInput!) {
updateProfile(input: $input) {
alert_queues_assigned {
alertQueue {
...AlertQueueFragment
}
alertQueueId
usersId
}
alert_queues_owned {
alertTypes {
...AlertTypeFragment
}
createdOn
creator {
...UserEntityFragment
}
creatorId
currency
deletedOn
detections {
...DetectionConnectionFragment
}
filters {
...FiltersFragment
}
id
label
name
pipelineFamilyName
updatedOn
users {
...UserEntityFragment
}
}
createdOn
deletedOn
email
enabled
first_name
fullName
id
imageId
language
last_name
login_codes {
code
createDate
email
user {
...UserEntityFragment
}
}
permissions
preferences {
currencyCode
language
timezone
weekStartsOn
}
role
time_zone
tokens {
createdOn
deletedOn
id
ip
token
updatedOn
user {
...UserEntityFragment
}
}
updatedOn
username
weekStartsOn
}
}
Variables
{"input": UpdateProfileInput}
Response
{
"data": {
"updateProfile": {
"alert_queues_assigned": [AlertQueueAssigned],
"alert_queues_owned": [AlertQueue],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"enabled": false,
"first_name": "xyz789",
"fullName": "abc123",
"id": "abc123",
"imageId": "xyz789",
"language": "abc123",
"last_name": "abc123",
"login_codes": LoginCode,
"permissions": {},
"preferences": UserPreference,
"role": "abc123",
"time_zone": "abc123",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "abc123"
}
}
}
updateRiskRating
Description
Update a single RiskRating.
Response
Returns a RiskRating!
Arguments
| Name | Description |
|---|---|
input - UpdateRiskRatingInput!
|
Example
Query
mutation UpdateRiskRating($input: UpdateRiskRatingInput!) {
updateRiskRating(input: $input) {
color
deletedOn
displayOrder
id
label
}
}
Variables
{"input": UpdateRiskRatingInput}
Response
{
"data": {
"updateRiskRating": {
"color": "abc123",
"deletedOn": "2007-12-03",
"displayOrder": 987.65,
"id": "abc123",
"label": "abc123"
}
}
}
updateRiskRatings
Description
Update all RiskRatings. This will overwrite all existing RiskRatings. Exclude RiskRating from input to delete.
Response
Returns [RiskRating!]!
Arguments
| Name | Description |
|---|---|
input - UpdateRiskRatingsInput!
|
Example
Query
mutation UpdateRiskRatings($input: UpdateRiskRatingsInput!) {
updateRiskRatings(input: $input) {
color
deletedOn
displayOrder
id
label
}
}
Variables
{"input": UpdateRiskRatingsInput}
Response
{
"data": {
"updateRiskRatings": [
{
"color": "abc123",
"deletedOn": "2007-12-03",
"displayOrder": 123.45,
"id": "xyz789",
"label": "abc123"
}
]
}
}
updateRule
Description
Update a single Rule.
Response
Returns a Rule!
Arguments
| Name | Description |
|---|---|
input - UpdateRuleInput!
|
Example
Query
mutation UpdateRule($input: UpdateRuleInput!) {
updateRule(input: $input) {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
id
name
}
ruleSet {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleSetId
score
type
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"input": UpdateRuleInput}
Response
{
"data": {
"updateRule": {
"active": false,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"eventType": "xyz789",
"id": "abc123",
"name": "abc123",
"rule": {},
"ruleActionIds": ["abc123"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "abc123",
"score": 987.65,
"type": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
}
}
updateRuleActive
Description
Update the status of Rule.
Response
Returns a Rule!
Arguments
| Name | Description |
|---|---|
input - UpdateRuleActiveInput!
|
Example
Query
mutation UpdateRuleActive($input: UpdateRuleActiveInput!) {
updateRuleActive(input: $input) {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
id
name
}
ruleSet {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
ruleSetId
score
type
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
}
}
Variables
{"input": UpdateRuleActiveInput}
Response
{
"data": {
"updateRuleActive": {
"active": false,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"eventType": "abc123",
"id": "xyz789",
"name": "abc123",
"rule": {},
"ruleActionIds": ["abc123"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "abc123",
"score": 987.65,
"type": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
}
}
updateRuleSet
Description
Update a single RuleSet.
Response
Returns a RuleSetResponse!
Arguments
| Name | Description |
|---|---|
input - UpdateRuleSetsInput!
|
Example
Query
mutation UpdateRuleSet($input: UpdateRuleSetsInput!) {
updateRuleSet(input: $input) {
createdOn
deletedOn
description
enabled
id
name
pipeline {
config
createdOn
creatorId
deletedOn
dependencies
description
displayName
featureSchedule
id
isDisabled
label
pipelineStatus {
...PipelineStatusModelFragment
}
systemName
triggeringFrequency
type
updatedOn
updaterId
}
pipelineId
preconditions
rules {
active
createdOn
deletedOn
description
eventType
id
name
rule
ruleActionIds
ruleActions {
...RuleActionFragment
}
ruleSet {
...RuleSetFragment
}
ruleSetId
score
type
updatedOn
user {
...UserEntityFragment
}
userId
}
updatedOn
user {
alertTypes {
...AlertTypeFragment
}
alert_queues {
...AlertQueueFragment
}
alert_queues_users_users {
...AlertQueueAssignedUsersFragment
}
apiKey
createdOn
deletedOn
email
first_name
fullName
id
imageId
last_name
loginCodes {
...LoginCodeFragment
}
permissions
role
tokens {
...TokenFragment
}
updatedOn
username
}
userId
versions {
createdOn
deletedOn
description
enabled
id
name
pipeline {
...PipelineModelFragment
}
pipelineId
preconditions
rules {
...RuleEntityFragment
}
updatedOn
user {
...UserEntityFragment
}
userId
}
}
}
Variables
{"input": UpdateRuleSetsInput}
Response
{
"data": {
"updateRuleSet": {
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"enabled": false,
"id": "xyz789",
"name": "abc123",
"pipeline": PipelineModel,
"pipelineId": "abc123",
"preconditions": {},
"rules": [RuleEntity],
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789",
"versions": [RuleSet]
}
}
}
updateSamlSettings
Description
Update Saml Settings Configurations
Response
Returns a SamlSettings!
Arguments
| Name | Description |
|---|---|
input - SamlSettingsInput!
|
Example
Query
mutation UpdateSamlSettings($input: SamlSettingsInput!) {
updateSamlSettings(input: $input) {
entityId
fieldMappingEmail
fieldMappingFirstName
fieldMappingGroup
fieldMappingLastName
fileName
redirectUrl
roleMappings {
groupId
groupName
role
}
status
url
}
}
Variables
{"input": SamlSettingsInput}
Response
{
"data": {
"updateSamlSettings": {
"entityId": "abc123",
"fieldMappingEmail": "abc123",
"fieldMappingFirstName": "abc123",
"fieldMappingGroup": "abc123",
"fieldMappingLastName": "xyz789",
"fileName": "abc123",
"redirectUrl": "xyz789",
"roleMappings": [SamlRoleMappingResponse],
"status": "Empty",
"url": "abc123"
}
}
}
updateSystemPreference
Description
Update system preference by name.
Response
Returns a SystemPreference!
Arguments
| Name | Description |
|---|---|
input - UpdateSystemPreferenceInput!
|
Example
Query
mutation UpdateSystemPreference($input: UpdateSystemPreferenceInput!) {
updateSystemPreference(input: $input) {
currencyCode
language
timezone
weekStartsOn
}
}
Variables
{"input": UpdateSystemPreferenceInput}
Response
{
"data": {
"updateSystemPreference": {
"currencyCode": "xyz789",
"language": "abc123",
"timezone": "abc123",
"weekStartsOn": "abc123"
}
}
}
updateTransactionTypes
Description
Update configuration for transaction types.
Response
Returns [TransactionType!]!
Arguments
| Name | Description |
|---|---|
input - UpdateTransactionTypesInput!
|
Example
Query
mutation UpdateTransactionTypes($input: UpdateTransactionTypesInput!) {
updateTransactionTypes(input: $input) {
icon
label
value
}
}
Variables
{"input": UpdateTransactionTypesInput}
Response
{
"data": {
"updateTransactionTypes": [
{
"icon": "abc123",
"label": "abc123",
"value": "xyz789"
}
]
}
}
updateUser
Description
Update a single User.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput!
|
Example
Query
mutation UpdateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
alert_queues_assigned {
alertQueue {
...AlertQueueFragment
}
alertQueueId
usersId
}
alert_queues_owned {
alertTypes {
...AlertTypeFragment
}
createdOn
creator {
...UserEntityFragment
}
creatorId
currency
deletedOn
detections {
...DetectionConnectionFragment
}
filters {
...FiltersFragment
}
id
label
name
pipelineFamilyName
updatedOn
users {
...UserEntityFragment
}
}
createdOn
deletedOn
email
enabled
first_name
fullName
id
imageId
language
last_name
login_codes {
code
createDate
email
user {
...UserEntityFragment
}
}
permissions
preferences {
currencyCode
language
timezone
weekStartsOn
}
role
time_zone
tokens {
createdOn
deletedOn
id
ip
token
updatedOn
user {
...UserEntityFragment
}
}
updatedOn
username
weekStartsOn
}
}
Variables
{"input": UpdateUserInput}
Response
{
"data": {
"updateUser": {
"alert_queues_assigned": [AlertQueueAssigned],
"alert_queues_owned": [AlertQueue],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"enabled": true,
"first_name": "abc123",
"fullName": "xyz789",
"id": "abc123",
"imageId": "abc123",
"language": "abc123",
"last_name": "abc123",
"login_codes": LoginCode,
"permissions": {},
"preferences": UserPreference,
"role": "xyz789",
"time_zone": "abc123",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "xyz789"
}
}
}
upsertLandingDataSource
Description
Upserts a landing folder of type DataSource
Response
Returns an UpsertLandingDataSourceResponseDto!
Arguments
| Name | Description |
|---|---|
input - UpsertLandingDataSourceInput!
|
Example
Query
mutation UpsertLandingDataSource($input: UpsertLandingDataSourceInput!) {
upsertLandingDataSource(input: $input) {
id
}
}
Variables
{"input": UpsertLandingDataSourceInput}
Response
{
"data": {
"upsertLandingDataSource": {
"id": "xyz789"
}
}
}
Types
Account
Description
Represents an Object of subtype account.
Fields
| Field Name | Description |
|---|---|
accountBalance - Float
|
Account balance. |
accountBalanceUpdatedOn - DateTime
|
It is the date in which Account balance was last updated |
accountCurrency - String
|
Account currency |
accountNumber - String
|
Account number (if this object represents an account; type = account) |
accountSegment - String
|
Account segment |
accountType - String
|
Account type |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of Object. |
pipelineFamilyName - String
|
pipeline family name of Object. |
sourceId - String
|
source id of Object. |
subtype - String!
|
Subtype of Object. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"accountBalance": 123.45,
"accountBalanceUpdatedOn": "2007-12-03T10:15:30Z",
"accountCurrency": "abc123",
"accountNumber": "xyz789",
"accountSegment": "xyz789",
"accountType": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"pipelineFamilyName": "xyz789",
"sourceId": "abc123",
"subtype": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
AccountAttributesFilterInput
Description
Input type with allowed fields for filtering accounts
Example
{
"accountNumber": "xyz789",
"accountTypes": ["xyz789"]
}
AccountConnection
Description
Represents an Object of subtype account.
Fields
| Field Name | Description |
|---|---|
edges - [AccountEdge!]
|
A list of edges |
pageInfo - CursorPageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of edges that can be returned. |
Example
{
"edges": [AccountEdge],
"pageInfo": CursorPageInfo,
"totalCount": 987
}
AccountEdge
AccountObjectInput
Description
Input type used to get accounts related to an entity
Fields
| Input Field | Description |
|---|---|
entityId - String!
|
Filter accounts to those affilated to entity. |
filterBy - AccountAttributesFilterInput
|
Filter accounts to those affilated to entity. |
orderBy - OrderByInput
|
Order by Model's column/field. Default = {sort: DESC} |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{
"entityId": "abc123",
"filterBy": AccountAttributesFilterInput,
"orderBy": OrderByInput,
"page": OffsetPaginationInput
}
AccountObjectResponse
Description
Response type for getAccountsByEntityId.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [Account!]!
|
List of Accounts. |
totalRecords - Int!
|
Total number of Account records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [Account],
"totalRecords": 123
}
AcknowledgeNotificationInput
Description
Input type for AcknowledgeNotificationInput.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of message queue Notification. |
Example
{"id": "4"}
ActiveAlertedEntity
Description
Represents Risk Score Trends for month in provided year.
Example
{"month": 123, "totalActive": 123, "totalAlerted": 123, "year": 123}
ActivityModel
Description
Object type for Activity.
Fields
| Field Name | Description |
|---|---|
activityAttributes - JSONObject
|
Attributes of Activity. |
activityType - ActivityType
|
Type of Activity. |
assignedUser - UserEntity
|
User assigned to Detection.
|
createdOn - DateTime
|
Created on DateTime. |
creator - UserEntity
|
User associated with Activity.
|
creatorId - String
|
ID of User associated with Activity. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of Activity. |
ip - String
|
IP |
message - String
|
Message of Activity. |
messageType - String
|
Message type of Activity. |
referenceId - String!
|
ID of activity source (i.e., Rule or Alert). |
unassignedUser - UserEntity
|
User unassigned from Detection.
|
Example
{
"activityAttributes": {},
"activityType": "Alert",
"assignedUser": UserEntity,
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"ip": "abc123",
"message": "abc123",
"messageType": "xyz789",
"referenceId": "xyz789",
"unassignedUser": UserEntity
}
ActivityType
Description
Represents the type of activity.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Alert"
ActivityUsage
ActivityWithNoteAttachments
Description
Response type for getting activities by reference ID.
Fields
| Field Name | Description |
|---|---|
activityAttributes - JSONObject
|
Attributes of Activity. |
activityType - ActivityType
|
Type of Activity. |
assignedUser - UserEntity
|
User assigned to Detection.
|
attachments - [AttachmentWithNote!]
|
List of attachments belonging to an Activity comment. |
createdOn - DateTime
|
Created on DateTime. |
creator - UserEntity
|
User associated with Activity.
|
creatorId - String
|
ID of User associated with Activity. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of Activity. |
ip - String
|
IP |
message - String
|
Message of Activity. |
messageType - String
|
Message type of Activity. |
referenceId - String!
|
ID of activity source (i.e., Rule or Alert). |
unassignedUser - UserEntity
|
User unassigned from Detection.
|
Example
{
"activityAttributes": {},
"activityType": "Alert",
"assignedUser": UserEntity,
"attachments": [AttachmentWithNote],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"ip": "abc123",
"message": "xyz789",
"messageType": "xyz789",
"referenceId": "abc123",
"unassignedUser": UserEntity
}
AddUserInput
Description
Represents a new user.
Fields
| Input Field | Description |
|---|---|
email - String!
|
Email of User. |
enabled - Boolean
|
Indicates whether User is enabled. |
first_name - String
|
First name of User. |
fullName - String
|
Full name of User. |
imageId - String
|
ImageId of User. |
language - String
|
Language of User. |
last_name - String
|
Last name of User. |
permissions - JSONObject
|
Permissions of User. |
role - String
|
Role of User. |
time_zone - String
|
Time zone of User. |
username - String
|
Username of User. |
weekStartsOn - String
|
The first day of the week User. |
Example
{
"email": "abc123",
"enabled": true,
"first_name": "xyz789",
"fullName": "xyz789",
"imageId": "abc123",
"language": "xyz789",
"last_name": "abc123",
"permissions": {},
"role": "abc123",
"time_zone": "xyz789",
"username": "abc123",
"weekStartsOn": "xyz789"
}
Alert
Description
Alert.
Fields
| Field Name | Description |
|---|---|
alertDate - Date!
|
System created Detection on DateTime. |
anomalyScore - Float
|
Anomaly score of Detection. |
assignedToUserId - String
|
User Id of the user assigned to the detection. |
category - String
|
Category of Detection. |
cibScore - Float
|
CIB score of Detection. |
compositeScore - Float
|
Composite score of Detection. |
createdOn - DateTime
|
Created on DateTime. |
decision - String
|
Latest RiskRating label for Detection. |
deletedOn - DateTime
|
Deleted on DateTime. |
detectionType - String
|
Type of Detection. |
domainCode - String
|
Classification of Detection. |
entityDetectionTypesForMonth - [String!]
|
List of detection types on Entity in given month. This field is no longer supported. Removal on v5.0.0.
|
hotspotScore - Float
|
Hotspot score of Detection. |
id - String!
|
ID of Detection. |
overallScore - Float
|
Overall score of Detection. |
pipelineFamilyName - String
|
Pipeline family name of Detection. |
ruleIds - [String!]
|
List of Rule IDs responsible for Detection creation. |
rules - [Rule!]
|
List of Rules responsible for Detection creation. |
sourceId - String
|
Source ID of Detection. |
sourceTable - String
|
Source table name of Detection. |
status - String
|
Status of Detection. |
subtype - String!
|
Subtype of Detection. |
supervisedScore - Float
|
Supervised score of Detection. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"alertDate": "2007-12-03",
"anomalyScore": 123.45,
"assignedToUserId": "abc123",
"category": "xyz789",
"cibScore": 987.65,
"compositeScore": 123.45,
"createdOn": "2007-12-03T10:15:30Z",
"decision": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"detectionType": "abc123",
"domainCode": "xyz789",
"entityDetectionTypesForMonth": [
"abc123"
],
"hotspotScore": 123.45,
"id": "abc123",
"overallScore": 987.65,
"pipelineFamilyName": "xyz789",
"ruleIds": ["xyz789"],
"rules": [Rule],
"sourceId": "abc123",
"sourceTable": "xyz789",
"status": "xyz789",
"subtype": "abc123",
"supervisedScore": 123.45,
"updatedOn": "2007-12-03T10:15:30Z"
}
AlertFeatureListItem
Description
Feature list item of Alert. @deprecated(reason: "Replaced by DetectionFeatureList. Removal on v5.0.0.")
Example
{
"description": "abc123",
"inputType": "abc123",
"key": "abc123"
}
AlertNote
Description
Note on Alert recorded by User.
Fields
| Field Name | Description |
|---|---|
alertId - String!
|
ID of Alert associated to AlertNote. |
attachments - [AttachmentWithNote!]
|
File(s) provided with AlertNote.
|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of AlertNote. |
ip - String
|
IP address. |
message - String!
|
Message of AlertNote. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UserEntity
|
User that created AlertNote.
|
userId - String!
|
ID of User that created AlertNote. |
Example
{
"alertId": "abc123",
"attachments": [AttachmentWithNote],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"ip": "xyz789",
"message": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
AlertQueue
Description
An AlertQueue.
Fields
| Field Name | Description |
|---|---|
alertTypes - [AlertType!]
|
Alert types of AlertQueue. |
createdOn - DateTime!
|
Created AlertQueue on DateTime. |
creator - UserEntity
|
User that created this AlertQueue.
|
creatorId - String
|
ID of User that created AlertQueue. |
currency - String
|
Currency of AlertQueue. |
deletedOn - DateTime
|
Deleted AlertQueue on DateTime. |
detections - DetectionConnection!
|
List of detections associated to a queue. |
Arguments
|
|
filters - Filters
|
Filters of AlertQueue. |
id - String!
|
ID of AlertQueue. |
label - String
|
Label of AlertQueue. |
name - String
|
Name of AlertQueue. |
pipelineFamilyName - String
|
Pipeline family name of AlertQueue. |
updatedOn - DateTime!
|
Updated AlertQueue on DateTime. |
users - [UserEntity!]
|
List of Users. |
Example
{
"alertTypes": [AlertType],
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "xyz789",
"currency": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "xyz789",
"label": "abc123",
"name": "abc123",
"pipelineFamilyName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
AlertQueueAssigned
Description
Represents assigned AlertQueue.
Fields
| Field Name | Description |
|---|---|
alertQueue - AlertQueue!
|
AlertQueue.
|
alertQueueId - String!
|
ID of AlertQueue. |
usersId - String!
|
ID of User that created AlertQueue. |
Example
{
"alertQueue": AlertQueue,
"alertQueueId": "abc123",
"usersId": "xyz789"
}
AlertQueueAssignedUsers
Description
An AlertQueueAssignedUsers.
Fields
| Field Name | Description |
|---|---|
alertQueue - AlertQueue!
|
AlertQueue.
|
alertQueueId - String!
|
ID of AlertQueue. |
user - UserEntity
|
User that created AlertQueue.
|
usersId - String!
|
ID of User that created AlertQueue. |
Example
{
"alertQueue": AlertQueue,
"alertQueueId": "xyz789",
"user": UserEntity,
"usersId": "xyz789"
}
AlertQueueIdInput
Description
Base Input type for an AlertQueue's ID.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of AlertQueue. |
Example
{"id": "xyz789"}
AlertQueueSummary
Description
Response type for getting alert queues.
Fields
| Field Name | Description |
|---|---|
alertTypes - [AlertType!]
|
Alert types of AlertQueue. |
alerts - AlertSummary
|
Alert summary |
createdOn - DateTime!
|
Created AlertQueue on DateTime. |
creator - UserEntity
|
User that created this AlertQueue.
|
creatorId - String
|
ID of User that created AlertQueue. |
currency - String
|
Currency of AlertQueue. |
deletedOn - DateTime
|
Deleted AlertQueue on DateTime. |
detections - DetectionConnection!
|
List of detections associated to a queue. |
Arguments
|
|
filters - Filters
|
Filters of AlertQueue. |
id - String!
|
ID of AlertQueue. |
label - String
|
Label of AlertQueue. |
name - String
|
Name of AlertQueue. |
pipelineFamilyName - String
|
Pipeline family name of AlertQueue. |
updatedOn - DateTime!
|
Updated AlertQueue on DateTime. |
users - [UserEntity!]
|
List of Users. |
Example
{
"alertTypes": [AlertType],
"alerts": AlertSummary,
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"creatorId": "xyz789",
"currency": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"detections": DetectionConnection,
"filters": Filters,
"id": "abc123",
"label": "xyz789",
"name": "abc123",
"pipelineFamilyName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"users": [UserEntity]
}
AlertStatusCount
Description
Query response from GetAlertCountsBy{Status|Type}.
Fields
| Field Name | Description |
|---|---|
day - Float!
|
Count of Alerts by day. |
escalatedExternally - Float!
|
Count of Alerts with escalatedExternally status. |
notRisk - Float!
|
Count of Alerts with notRisk status. |
pending - Float!
|
Count of Alerts with pending status. |
risk - Float!
|
Count of Alerts with risk status. |
Example
{
"day": 987.65,
"escalatedExternally": 987.65,
"notRisk": 123.45,
"pending": 123.45,
"risk": 123.45
}
AlertStatusFilter
Description
Represents an Alerts's status
Fields
| Field Name | Description |
|---|---|
status - String
|
Status of Alert. |
Example
{"status": "abc123"}
AlertSummary
AlertType
Description
AlertType.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created AlertType on DateTime. |
creator - UserEntity
|
User that created this AlertType.
|
deletedOn - DateTime
|
Deleted AlertType on DateTime. |
id - String!
|
ID of AlertType. |
name - String
|
Name of AlertType. |
query - String
|
Query of AlertType. |
score - Float
|
Score of AlertType. |
updatedOn - DateTime
|
Updated AlertType on DateTime. |
version - Float
|
Version of AlertType. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"name": "xyz789",
"query": "xyz789",
"score": 987.65,
"updatedOn": "2007-12-03T10:15:30Z",
"version": 123.45
}
AlertTypeCount
AlertTypeCounts
Description
Alert type counts.
Fields
| Field Name | Description |
|---|---|
alert_types - [AlertTypeCount!]!
|
List of AlertType count. |
day - Float!
|
Day for AlertType. |
Example
{"alert_types": [AlertTypeCount], "day": 123.45}
AllFeatureTogglesDto
Description
All feature toggles.
Fields
| Field Name | Description |
|---|---|
toggles - [FeatureToggleDto!]!
|
Example
{"toggles": [FeatureToggleDto]}
Analytics
ApiLoginInput
AppVersionDetails
AssignDetectionsInput
Fields
| Input Field | Description |
|---|---|
assignToUserId - String!
|
Id of user to assign detections to. |
detectionIds - [String!]!
|
Detections to assign to user. |
Example
{
"assignToUserId": "xyz789",
"detectionIds": ["abc123"]
}
AssignedTo
Description
User assigned to Detection
Example
{
"email": "xyz789",
"first_name": "abc123",
"id": "xyz789",
"imageId": "xyz789",
"last_name": "xyz789"
}
AttachmentWithNote
Description
Object type for note's attachment on Alert.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
file - File
|
File. |
fileId - String!
|
ID of File associated with note's attachment on Alert. |
fileName - String
|
Name of File associated with note's attachment on Alert. |
id - String!
|
ID of attachment associated with a note on Alert. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"file": File,
"fileId": "abc123",
"fileName": "abc123",
"id": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
AuditLogActor
Description
Audit Log Actor.
Example
{
"email": "xyz789",
"firstName": "abc123",
"id": "xyz789",
"lastName": "xyz789"
}
AuditLogAuditedAttribute
Description
Audit Log Audited Attribute.
Example
{
"key": "abc123",
"newValue": "xyz789",
"oldValue": "xyz789"
}
AuditLogDto
Description
Audit Log.
Fields
| Field Name | Description |
|---|---|
activity - String!
|
Name of the activity being logged. |
actor - AuditLogActor!
|
Identifier of the user whose activity is being logged. |
auditedObject - AuditLogObject!
|
The object of the activity being logged. |
auditedValues - [AuditLogAuditedAttribute!]!
|
The captured change in values for the object. |
createdOn - DateTime!
|
Date the log was created. |
id - String!
|
ID of Audit Log. |
Example
{
"activity": "xyz789",
"actor": AuditLogActor,
"auditedObject": AuditLogObject,
"auditedValues": [AuditLogAuditedAttribute],
"createdOn": "2007-12-03T10:15:30Z",
"id": "abc123"
}
AuditLogObject
AuditLogObjectInput
AuditLogsPage
Description
Response type for GetAuditLogs.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [AuditLogDto!]!
|
List of AuditLogDtos. |
totalRecords - Int!
|
Total number of AuditLogDto records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [AuditLogDto],
"totalRecords": 123
}
Auth
BeneficiariesV2
Description
Represents associated beneficiaries with event.
Fields
| Field Name | Description |
|---|---|
account - Account
|
Account data associated with the beneficiary. |
entities - [EntityModel!]
|
Details of entities related to the beneficiary. |
Example
{
"account": Account,
"entities": [EntityModel]
}
BinaryObject
Description
BinaryObject persisted in Minio/S3 ObjectStore.
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
Bucket for File. |
createdOn - DateTime!
|
Modified timestamp of BinaryObject. |
id - String!
|
ID of File. |
lastModified - DateTime!
|
Modified timestamp of BinaryObject. Replaced with createdOn. Removal on v5.0.0.
|
name - String!
|
Name of BinaryObject. |
relativePath - String!
|
Relative path to BinaryObject. |
size - Float!
|
Size of BinaryObject in bytes. |
Example
{
"bucket": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"lastModified": "2007-12-03T10:15:30Z",
"name": "xyz789",
"relativePath": "abc123",
"size": 987.65
}
Boolean
Description
The Boolean scalar type represents true or false.
Bucket
Description
Bucket in ObjectStore.
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
Bucket name in Object Store.
|
landingZone - BinaryObject
|
Landing zone of type BinaryObject for a given DataSource group. |
name - String!
|
Name of Bucket. Replaced by bucket. Removal on v5.0.0.
|
objects - [BinaryObject!]
|
List of all BinaryObject in Bucket. No longer supported and will be removed in the near future in favor of landingZone. Removal on v5.0.0.
|
pipelineFamilyName - String!
|
Name of pipeline family associated with Bucket. |
size - Float!
|
Size of Bucket in bytes. |
Example
{
"bucket": "abc123",
"landingZone": BinaryObject,
"name": "xyz789",
"objects": [BinaryObject],
"pipelineFamilyName": "xyz789",
"size": 123.45
}
BulkInsertError
BulkInsertResponse
Description
Response type for bulk inserts.
Fields
| Field Name | Description |
|---|---|
errors - [BulkInsertError!]
|
List of error metadata on failed batch request. |
success - Boolean!
|
Status of bulk insert request. |
totalRecords - Float!
|
Total records inserted. |
Example
{
"errors": [BulkInsertError],
"success": true,
"totalRecords": 987.65
}
BulkTransactionType
Description
The list of icons and labels to use for known transaction types.
Input fields for BulkTransactionType.
Example
{
"icon": "xyz789",
"label": "xyz789",
"value": "xyz789"
}
CategoryTotalAlertsByRiskRating
Description
Represents the category total of Alerts by RiskRating.
Example
{
"category": "xyz789",
"riskRating": "abc123",
"riskRatingId": "xyz789",
"totalAlerts": 123.45
}
CategoryTotalAlertsByStatus
CheckUsernameInput
Description
Input type of CheckUsername.
Fields
| Input Field | Description |
|---|---|
username - String!
|
Username of User. |
Example
{"username": "xyz789"}
CorrespondentBankingAttributes
Description
Attributes of Event with subtype transaction (correspondent banking).
Fields
| Field Name | Description |
|---|---|
eventDate - String!
|
Date of subtype event. |
functionalTransactionAmount - Float
|
Amount of functional transaction. |
functionalTransactionCurrency - String
|
Currency of functional transaction. |
intermediaryAccountNumber - String
|
Account number of Intermediary. |
intermediaryId - String
|
ID of Intermediary. |
originalTransactionAmount - Float
|
Amount of original transaction. |
originalTransactionCurrency - String
|
Currency of original transaction. |
referenceNumber - String!
|
Unique identifier of transaction. |
transactionType - String
|
Type of transaction (e.g., wire, card, cash, etc). |
ultimateBeneficiaryAccountNumber - String
|
Account number of Beneficiary. |
ultimateBeneficiaryId - String
|
ID of Beneficiary. |
ultimateOriginatorAccountNumber - String
|
Account number of Originator. |
ultimateOriginatorId - String
|
ID of Originator. |
Example
{
"eventDate": "abc123",
"functionalTransactionAmount": 123.45,
"functionalTransactionCurrency": "xyz789",
"intermediaryAccountNumber": "xyz789",
"intermediaryId": "abc123",
"originalTransactionAmount": 987.65,
"originalTransactionCurrency": "xyz789",
"referenceNumber": "xyz789",
"transactionType": "abc123",
"ultimateBeneficiaryAccountNumber": "abc123",
"ultimateBeneficiaryId": "abc123",
"ultimateOriginatorAccountNumber": "xyz789",
"ultimateOriginatorId": "abc123"
}
CounterpartyTransactionGroup
Description
Counterparty Transaction group object type.
Fields
| Field Name | Description |
|---|---|
accountId - String!
|
ID of Counterparty's Account. |
legalEntityName - String!
|
Name of LegalEntity. |
transactionsByCreditType - [TransactionsByCreditOrDebitType!]!
|
Aggregation of Transaction functional amount by type of transaction for all credit-type transactions from Counterparty perspective. |
transactionsByDebitType - [TransactionsByCreditOrDebitType!]!
|
Aggregation of Transaction functional amount by type of transaction for all debit-type transactions from Counterparty perspective. |
Example
{
"accountId": "xyz789",
"legalEntityName": "xyz789",
"transactionsByCreditType": [
TransactionsByCreditOrDebitType
],
"transactionsByDebitType": [
TransactionsByCreditOrDebitType
]
}
Country
Description
Represents an Entity's country of residence.
Fields
| Field Name | Description |
|---|---|
abbreviation - String
|
Country abbreviation for the Entity related to Alert. |
Example
{"abbreviation": "xyz789"}
CreateAlertQueueInput
Description
Input type of CreateAlertQueue.
Example
{
"currency": "xyz789",
"filters": FiltersInput,
"label": "abc123",
"name": "abc123",
"pipelineFamilyName": "abc123",
"queueUsers": ["abc123"]
}
CreateAlertStatusInput
Description
Input type of CreateAlertStatus.
Fields
| Input Field | Description |
|---|---|
color - String!
|
Icon's color |
hasRiskRating - Boolean!
|
Flag to indicate if a Detection requires a risk rating |
icon - String!
|
Font Awesome icon |
isClosed - Boolean!
|
Flag to indicate if a Detection is considered as closed |
label - String!
|
Alert status label |
type - String!
|
Alert status type |
Example
{
"color": "abc123",
"hasRiskRating": false,
"icon": "xyz789",
"isClosed": true,
"label": "xyz789",
"type": "abc123"
}
CreateAlertTypeInput
CreateApiKeyResponse
Description
Response type for CreateApiKey.
Fields
| Field Name | Description |
|---|---|
apiKey - String!
|
API Key for User. |
Example
{"apiKey": "xyz789"}
CreateAttachmentInput
CreateAuditLogInput
Description
Input type of CreateAuditLog.
Fields
| Input Field | Description |
|---|---|
activity - String!
|
Name of the activity being logged. |
actorUserId - String!
|
ID of User whose activity is being logged.
|
auditedObject - AuditLogObjectInput!
|
Actor whose activity is being logged. |
newData - JSONObject
|
The new values in the audited object. |
oldData - JSONObject
|
The old values in the audited object. |
Example
{
"activity": "xyz789",
"actorUserId": "xyz789",
"auditedObject": AuditLogObjectInput,
"newData": {},
"oldData": {}
}
CreateEleNotificationPayload
Description
Response for CreateNotification.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of message queue Notification. |
Example
{"id": "4"}
CreateFileInput
Description
Input type of CreateFile.
Example
{
"bucket": "xyz789",
"id": "abc123",
"mimetype": "abc123",
"name": "xyz789",
"size": 987.65
}
CreateFileResponseDto
Description
Query response from CreateFile.
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
Bucket for File. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of File. |
mimetype - String
|
Mimetype of File. |
name - String!
|
Name of File. |
size - Float
|
Size of File. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"bucket": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"mimetype": "abc123",
"name": "abc123",
"size": 987.65,
"updatedOn": "2007-12-03T10:15:30Z"
}
CreateFileStatusInput
Description
Input type of CreateFileStatus.
Fields
| Input Field | Description |
|---|---|
file - FileInput
|
File for File Status. |
id - String
|
ID of FileStatus. |
info - JSONObject
|
Info is a JSON object where more details or log messages can be supplied for a file status`. |
recordCount - Float
|
Record count |
status - String
|
status for file |
Example
{
"file": FileInput,
"id": "xyz789",
"info": {},
"recordCount": 987.65,
"status": "abc123"
}
CreateFileStatusMessage
Description
Response for creating a file.
Fields
| Field Name | Description |
|---|---|
message - String!
|
Create file status message. |
Example
{"message": "abc123"}
CreateKeyValueInput
Description
Input type of CreateKeyValue.
Fields
| Input Field | Description |
|---|---|
editPermissions - JSONObject
|
Permissions that have access to update a KeyValue. |
encryptedValues - JSON
|
Values to encrypt. |
isEnv - Boolean
|
Indiciates whether value of KeyValue is an environment variable. |
key - String!
|
Key of KeyValue. |
readPermissions - JSONObject
|
Permissions that have access to update a KeyValue. |
value - JSON
|
Value of KeyValue. |
Example
{
"editPermissions": {},
"encryptedValues": {},
"isEnv": true,
"key": "abc123",
"readPermissions": {},
"value": {}
}
CreateLoginCodeInput
Description
Input type of CreateLoginCode.
Fields
| Input Field | Description |
|---|---|
email - String!
|
Email address associated with LoginCode. |
Example
{"email": "abc123"}
CreateNoteInput
Description
Input type for creating a Note.
Fields
| Input Field | Description |
|---|---|
alertId - String!
|
ID of Alert. |
attachments - [CreateAttachmentInput!]
|
Attachments |
message - String!
|
Message of AlertNote. |
Example
{
"alertId": "xyz789",
"attachments": [CreateAttachmentInput],
"message": "abc123"
}
CreateNotificationInput
Description
Input type for CreateNotification.
Fields
| Input Field | Description |
|---|---|
batchDate - Date!
|
Batch date associated to root node Detection. |
message - JSONObject
|
Payload from message queue. |
meta - EleMetadataInput
|
Entity Links Explorer notification metadata. |
nodeId - ID!
|
Selected node ID for requested relationships. |
status - NotificationStatus!
|
Message queue status. |
Example
{
"batchDate": "2007-12-03",
"message": {},
"meta": EleMetadataInput,
"nodeId": 4,
"status": "COMPLETE"
}
CreatePipelineFeatureInput
Description
Input type for CreatePipelineFeature.
Fields
| Input Field | Description |
|---|---|
activeFlag - Boolean!
|
Indicates whether PipelineFeature is active. |
config - JSONObject
|
Config of PipelineFeature. |
featureName - String
|
Name of PipelineFeature. |
featureType - PipelineFeatureTypes!
|
Type of PipelineFeature. |
pipelineName - String!
|
Display name of associated Pipeline. |
Example
{
"activeFlag": false,
"config": {},
"featureName": "abc123",
"featureType": "Aggregated",
"pipelineName": "xyz789"
}
CreatePipelineRunInput
Description
Input type of CreatePipelineRun.
Example
{
"batchDate": "xyz789",
"id": "xyz789",
"runAsChain": false,
"systemName": "abc123"
}
CreatePipelineRunResponse
Description
Query response from createPipelineRun.
Fields
| Field Name | Description |
|---|---|
runId - String!
|
Run ID for Pipeline. |
Example
{"runId": "abc123"}
CreatePipelineScheduleExceptionsInput
Description
Input type of CreatePipelineScheduleExceptionsInput.
Fields
| Input Field | Description |
|---|---|
pipelines - [PipelineScheduleExceptionInput!]!
|
List of Pipeline objects for batch creation. |
Example
{"pipelines": [PipelineScheduleExceptionInput]}
CreatePipelineStatusInput
Description
Input type of CreatePipelineStatus.
Fields
| Input Field | Description |
|---|---|
finishTime - DateTime
|
Pipeline end execution time. |
logFileLocation - LogFileLocation
|
Full path of log file associated to this PipelineStatus. |
message - String
|
Status message of Pipeline run. |
pipelineId - String!
|
Pipeline Id. |
runId - String!
|
Pipeline Run Id. |
startTime - DateTime
|
Pipeline start execution time. |
status - PipelineStatuses
|
Pipeline Status.
|
step - String!
|
Pipeline Step. |
Example
{
"finishTime": "2007-12-03T10:15:30Z",
"logFileLocation": LogFileLocation,
"message": "xyz789",
"pipelineId": "xyz789",
"runId": "abc123",
"startTime": "2007-12-03T10:15:30Z",
"status": "Error",
"step": "xyz789"
}
CreateRiskRatingInput
CreateRuleActionInput
CreateRuleFlagsInput
Description
Input type of CreateRuleFlagsInput.
Fields
| Input Field | Description |
|---|---|
ruleFlags - [RuleFlagInput!]!
|
List of RuleFlag objects for batch creation. |
Example
{"ruleFlags": [RuleFlagInput]}
CreateRuleInput
Description
Input for creating a Rule.
Fields
| Input Field | Description |
|---|---|
active - Boolean!
|
Indicates whether Rule is active. |
description - String!
|
Description of Rule. |
eventType - String
|
Event type. |
name - String
|
Name of Rule. |
rule - JSONObject!
|
Logic for Rule. |
ruleActionIds - [String!]
|
IDs of RuleAction that are associated to a Rule. |
ruleSetId - String!
|
ID of RuleSet. |
score - Float!
|
Score of Rule. |
type - String
|
Type of Rule. |
Example
{
"active": false,
"description": "xyz789",
"eventType": "abc123",
"name": "xyz789",
"rule": {},
"ruleActionIds": ["xyz789"],
"ruleSetId": "abc123",
"score": 987.65,
"type": "xyz789"
}
CreateRuleSetsInput
Description
Input type of CreateRuleSets.
Example
{
"description": "abc123",
"enabled": true,
"name": "xyz789",
"pipelineId": "xyz789",
"preconditions": "abc123"
}
CreateTrainingModelInput
Description
Input type of CreateTrainingModel.
Fields
| Input Field | Description |
|---|---|
modelData - JSONObject
|
Model data for TrainingModel. |
modelName - String!
|
Model name of TrainingModel. |
Example
{"modelData": {}, "modelName": "abc123"}
CreateUserInput
Description
Input type of CreateUser.
Fields
| Input Field | Description |
|---|---|
email - String!
|
Email of User. |
enabled - Boolean
|
Indicates whether User is enabled. |
first_name - String
|
First name of User. |
fullName - String
|
Full name of User. |
imageId - String
|
ImageId of User. |
language - String
|
Language of User. |
last_name - String
|
Last name of User. |
permissions - JSONObject
|
Permissions of User. |
preferences - CreateUserPreferenceInput
|
Set user's preferences. |
role - String
|
Role of User. |
time_zone - String
|
Time zone of User. |
updatedOn - DateTime
|
Updated on DateTime. |
username - String
|
Username of User. |
weekStartsOn - String
|
The first day of the week User. |
Example
{
"email": "abc123",
"enabled": true,
"first_name": "abc123",
"fullName": "abc123",
"imageId": "xyz789",
"language": "xyz789",
"last_name": "abc123",
"permissions": {},
"preferences": CreateUserPreferenceInput,
"role": "abc123",
"time_zone": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "abc123"
}
CreateUserPreferenceInput
Description
Input fields for CreateUser preferences.
Example
{
"currencyCode": "xyz789",
"language": "abc123",
"timezone": "abc123",
"weekStartsOn": "xyz789"
}
CreateUsersInput
Description
Input type of CreateUsers.
Fields
| Input Field | Description |
|---|---|
records - [AddUserInput!]!
|
List of AddUserInputs. |
Example
{"records": [AddUserInput]}
CurrencyCodePreferenceInput
Description
Custom input type for currency code preference fields.
Example
{"useDefault": false, "value": "xyz789"}
Cursor
Description
Cursor scalar type for pagination
Example
Cursor
CursorPageInfo
Description
Information about pagination in a connection.
Example
{
"endCursor": Cursor,
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": Cursor
}
CursorPaginationForRelationshipNodes
Description
Input type to support Cursor Pagination requests for RelationshipNodes. @deprecated(reason: "Pagination replaced by GetRelationshipsLinks. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
after - RelationshipCursorTypeInput
|
ID of the last Relationship record provided. |
before - ID
|
ID of the first record provided. |
first - Int
|
Limit number of records to this non-negative value. |
last - Int
|
Limit number of records to this non-negative value. |
Example
{
"after": RelationshipCursorTypeInput,
"before": 4,
"first": 987,
"last": 123
}
CursorPaginationInput
Description
Input type to support Cursor Pagination requests. @deprecated(reason: "Replaced by CursorPaginationArgs. Removal on v5.0.0.")
Example
{"after": 4, "before": 4, "first": 987, "last": 123}
DataList
Description
AML rule data list.
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"key": "xyz789",
"value": RuleList,
"version": "abc123"
}
DataListFilter
Description
Input type to filter data lists.
Fields
| Input Field | Description |
|---|---|
key - String!
|
Key of KeyValue. |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
version - String
|
Version of KeyValue as determined by updates on key. Default = "latest" |
Example
{
"key": "abc123",
"page": OffsetPaginationInput,
"version": "xyz789"
}
DataListPayload
Description
Paginated request for AML rules from list.
Fields
| Field Name | Description |
|---|---|
data - [JSONObject!]!
|
Collection of AML rules. |
pageInfo - PageInfo
|
Offset page metadata. |
totalRecords - Int!
|
Total number of records that can be returned. |
Example
{"data": [{}], "pageInfo": PageInfo, "totalRecords": 123}
DataListsPayload
Description
Paginated request for AML data lists.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [DataList!]!
|
List of DataLists. |
totalRecords - Int!
|
Total number of DataList records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [DataList],
"totalRecords": 987
}
DataModelEdge
Description
Edge to connect LinkedNodeData nodes.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
Cursor for current LinkedNodeData node. |
node - LinkedNodeData!
|
LinkedNodeData node details.
|
Example
{
"cursor": "abc123",
"node": LinkedAccount
}
DataSourceFilterRequest
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of File. |
Example
{"id": "abc123"}
Database
Description
Response for Pod of type 'database'.
Fields
| Field Name | Description |
|---|---|
name - String!
|
Database name. |
schema - String!
|
Database schema. |
size - Float!
|
Database size. |
tables - [TableDto!]!
|
Database tables information. |
Example
{
"name": "abc123",
"schema": "abc123",
"size": 123.45,
"tables": [TableDto]
}
Date
Description
An ISO-8601 encoded date string.
Example
"2007-12-03"
DateTime
Description
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
Example
"2007-12-03T10:15:30Z"
DebitCreditSummarizedTransaction
Description
Summarized Transaction DTO.
Fields
| Field Name | Description |
|---|---|
date - DateTime!
|
Date of DebitCreditSummarizedTransaction. |
summary - [SummarizedTransaction!]!
|
Summary of DebitCreditSummarizedTransaction. |
Example
{
"date": "2007-12-03T10:15:30Z",
"summary": [SummarizedTransaction]
}
DeleteActivityInput
Description
Input type for deleting an activity.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Activity. |
Example
{"id": "xyz789"}
DeleteAlertTypeInput
Description
Input type of DeleteAlertType.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of AlertType. |
Example
{"id": "xyz789"}
DeleteFeatureToggleInput
Fields
| Input Field | Description |
|---|---|
key - FeatureToggleKey!
|
Example
{"key": "EntityLinksExplorer"}
DeleteFileMessage
Description
Response for deleting a file.
Fields
| Field Name | Description |
|---|---|
message - String!
|
Delete file message. |
Example
{"message": "xyz789"}
DeleteRuleInput
Description
Input type for DeleteRule.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Rule. |
Example
{"id": "abc123"}
DeleteRuleSetInput
Description
Input type of DeleteRuleSet.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of RuleSet. |
Example
{"id": "abc123"}
DeleteUserInput
Description
Input type of DeleteUser.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of User. |
Example
{"id": "xyz789"}
DetectedEntitiesBreakdown
Description
Response type for GetDetectedEntitiesBreakdown.
Fields
| Field Name | Description |
|---|---|
detectedAtLeastOneRuleAndNoScore - Float!
|
Total rule Detections triggered by Entity without any associated "score" Detections. |
detectedAtLeastOneScoreAndNoRule - Float!
|
Total score Detections triggered by Entity without any associated "rule" Detections. |
detectedAtLeastOneScoreAndRule - Float!
|
Total Detections triggered by Entity that are associated with at least one "rule" and "score" Detection. |
detectedNoScoreAndNoRule - Float!
|
Total Detections triggered by Entity that are neither "rule" or "score". |
Example
{
"detectedAtLeastOneRuleAndNoScore": 123.45,
"detectedAtLeastOneScoreAndNoRule": 987.65,
"detectedAtLeastOneScoreAndRule": 123.45,
"detectedNoScoreAndNoRule": 987.65
}
Detection
Description
Detection.
Fields
| Field Name | Description |
|---|---|
alertDate - Date!
|
System created Detection on DateTime. |
anomalyScore - Float
|
Anomaly score of Detection. |
assignedTo - AssignedTo
|
User assigned to Detection. |
assignedToUserId - String
|
User Id of the user assigned to the detection. |
category - String
|
Category of Detection. |
cibScore - Float
|
CIB score of Detection. |
compositeScore - Float
|
Composite score of Detection. |
decision - RiskRating
|
RiskRating associated with Detection.
|
detectionType - String
|
Type of Detection. |
domainCode - String
|
Classification of Detection. |
entity - Entity!
|
Entity associated with Detection.
|
entityDetectionTypesForMonth - [String!]
|
List of detection types on Entity in given month. This field is no longer supported. Removal on v5.0.0.
|
hotspotScore - Float
|
Hotspot score of Detection. |
id - String!
|
ID of Detection. |
overallScore - Float
|
Overall score of Detection. |
pipelineFamilyName - String
|
Pipeline family name of Detection. |
ruleIds - [String!]
|
List of Rule IDs responsible for Detection creation. |
rules - [Rule!]
|
List of Rules responsible for Detection creation. |
shap - Shap
|
SHAP values for the Detection. |
sourceId - String
|
Source ID of Detection. |
sourceTable - String
|
Source table name of Detection. |
status - String
|
Status of Detection. |
statusUpdatedOn - Date
|
Date of last status change for detection. |
subtype - String!
|
Subtype of Detection. |
supervisedScore - Float
|
Supervised score of Detection. |
supplementaryInformation - DetectionRuleDetailConnection
|
Provides supplementary information about the rules that triggered the detection. |
Arguments
|
|
transactions - DetectionTransactionConnection
|
The connection type for transactions directly associated with the alerted entity. |
Arguments
|
|
Example
{
"alertDate": "2007-12-03",
"anomalyScore": 123.45,
"assignedTo": AssignedTo,
"assignedToUserId": "xyz789",
"category": "xyz789",
"cibScore": 987.65,
"compositeScore": 123.45,
"decision": RiskRating,
"detectionType": "abc123",
"domainCode": "xyz789",
"entity": Entity,
"entityDetectionTypesForMonth": [
"abc123"
],
"hotspotScore": 123.45,
"id": "abc123",
"overallScore": 123.45,
"pipelineFamilyName": "xyz789",
"ruleIds": ["abc123"],
"rules": [Rule],
"shap": Shap,
"sourceId": "xyz789",
"sourceTable": "abc123",
"status": "xyz789",
"statusUpdatedOn": "2007-12-03",
"subtype": "xyz789",
"supervisedScore": 123.45,
"supplementaryInformation": DetectionRuleDetailConnection,
"transactions": DetectionTransactionConnection
}
DetectionByQueueOrderByFields
Description
DetectionByQueue order by allowed fields.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AlertDate"
DetectionConnection
Description
The connection type for Detection.
Fields
| Field Name | Description |
|---|---|
edges - [DetectionEdge!]
|
A list of edges |
pageInfo - LegacyCursorPageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of edges that can be returned. |
Example
{
"edges": [DetectionEdge],
"pageInfo": LegacyCursorPageInfo,
"totalCount": 123
}
DetectionDetailsAdminSettings
Description
Root item visibility for Detection Details Admin Settings with Panels
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
panels - [DetectionDetailsAdminSettingsBase!]
|
|
visibility - Float!
|
Example
{
"id": "xyz789",
"panels": [DetectionDetailsAdminSettingsBase],
"visibility": 123.45
}
DetectionDetailsAdminSettingsBase
DetectionEdge
Description
A Detection edge.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Detection!
|
The item at the end of DetectionEdge. |
Example
{
"cursor": "abc123",
"node": Detection
}
DetectionFeatureList
Description
Feature list item of Detection.
Example
{
"description": "xyz789",
"inputType": "abc123",
"key": "abc123"
}
DetectionFilters
Description
Ways in which to filter lists of detections.
Example
{
"statusUpdatedOn": "2007-12-03T10:15:30Z",
"statuses": ["abc123"]
}
DetectionOrder
Description
Ordering options for Detection connections.
Fields
| Input Field | Description |
|---|---|
field - DetectionByQueueOrderByFields
|
Ordering options for detections. Default = AlertDate |
sort - Sort
|
The ordering direction. Default = DESC |
Example
{"field": "AlertDate", "sort": "ASC"}
DetectionQueueFilter
Description
Input type to support search queries for Detections.
Fields
| Input Field | Description |
|---|---|
accountNumber - String
|
Account number (if this object represents an account; type = account) |
alertDate - Date
|
System created Detection on DateTime. |
anomalyScore - Float
|
Anomaly score of Detection. |
category - String
|
Category of Detection. |
cibScore - Float
|
CIB score of Detection. |
compositeScore - Float
|
Composite score of Detection. |
decision - String
|
Latest RiskRating label for Detection. |
detectionId - String
|
ID of Detection. |
entityId - String
|
ID of Entity. |
externalEntityId - String
|
External entity id of associated Entity. |
fullName - String
|
Full name of Entity. |
hotspotScore - Float
|
Hotspot score of Detection. |
subtype - String
|
Subtype of Detection. |
supervisedScore - Float
|
Supervised score of Detection. |
Example
{
"accountNumber": "xyz789",
"alertDate": "2007-12-03",
"anomalyScore": 987.65,
"category": "abc123",
"cibScore": 987.65,
"compositeScore": 123.45,
"decision": "abc123",
"detectionId": "abc123",
"entityId": "abc123",
"externalEntityId": "abc123",
"fullName": "xyz789",
"hotspotScore": 987.65,
"subtype": "abc123",
"supervisedScore": 123.45
}
DetectionRuleDetailConnection
Description
Connection for detection details.
Fields
| Field Name | Description |
|---|---|
edges - [DetectionRuleDetailsEdge!]
|
A list of edges |
pageInfo - CursorPageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of edges that can be returned. |
Example
{
"edges": [DetectionRuleDetailsEdge],
"pageInfo": CursorPageInfo,
"totalCount": 987
}
DetectionRuleDetails
Description
DetectionRuleDetails.
Fields
| Field Name | Description |
|---|---|
alertId - ID!
|
ID of Detection. |
amlRisk - String
|
AML risk score. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
detail1 - String
|
Supplementary detail |
detail2 - String
|
Supplementary detail |
detail3 - String
|
Supplementary detail |
detail4 - String
|
Supplementary detail |
detail5 - String
|
Supplementary detail |
detail6 - String
|
Supplementary detail |
entityRisk - String
|
Entity risk score. |
id - ID!
|
ID of DetectionRuleDetails. |
name - String!
|
Name of contributing factor for generating a detection. |
ruleId - ID!
|
ID of Rule. |
totalConnections - Int
|
Number of trades/transactions that contributed to the detection. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"alertId": "4",
"amlRisk": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"detail1": "abc123",
"detail2": "xyz789",
"detail3": "abc123",
"detail4": "abc123",
"detail5": "xyz789",
"detail6": "xyz789",
"entityRisk": "xyz789",
"id": 4,
"name": "abc123",
"ruleId": 4,
"totalConnections": 123,
"updatedOn": "2007-12-03T10:15:30Z"
}
DetectionRuleDetailsEdge
Description
A DetectionRuleDetails edge.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - DetectionRuleDetails!
|
The item at the end of DetectionRuleDetailsEdge. |
Example
{
"cursor": "xyz789",
"node": DetectionRuleDetails
}
DetectionStatus
Description
DetectionStatus represents the status of an alert.
Fields
| Field Name | Description |
|---|---|
color - String!
|
Icon's color |
hasRiskRating - Boolean!
|
Flag to indicate if a Detection requires a risk rating |
icon - String!
|
Font Awesome icon |
id - String!
|
ID of DetectionStatus. |
isClosed - Boolean!
|
Flag to indicate if a Detection is considered as closed |
label - String!
|
Alert status label |
type - String!
|
Alert status type |
Example
{
"color": "abc123",
"hasRiskRating": false,
"icon": "abc123",
"id": "xyz789",
"isClosed": true,
"label": "abc123",
"type": "abc123"
}
DetectionTransactionConnection
Description
The connection type for transactions directly associated with the alerted entity.
Fields
| Field Name | Description |
|---|---|
edges - [EventModelEdge!]
|
A list of edges |
pageInfo - LegacyCursorPageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of edges that can be returned. |
Example
{
"edges": [EventModelEdge],
"pageInfo": LegacyCursorPageInfo,
"totalCount": 987
}
DetectionTypesFilter
Description
Represents a unique type of Detection.
Fields
| Field Name | Description |
|---|---|
detectionType - String!
|
Type of Detection. |
Example
{"detectionType": "abc123"}
DetectionWithoutDetails
Description
Response type for GetAllDetections. @deprecated(reason: "Will be replaced with Detection to support supplementaryInformation. Removal on v5.0.0.")
Fields
| Field Name | Description |
|---|---|
alertDate - Date!
|
System created Detection on DateTime. |
anomalyScore - Float
|
Anomaly score of Detection. |
assignedTo - AssignedTo
|
User assigned to Detection. |
assignedToUserId - String
|
User Id of the user assigned to the detection. |
category - String
|
Category of Detection. |
cibScore - Float
|
CIB score of Detection. |
compositeScore - Float
|
Composite score of Detection. |
decision - RiskRating
|
RiskRating associated with Detection.
|
detectionType - String
|
Type of Detection. |
domainCode - String
|
Classification of Detection. |
entity - Entity!
|
Entity associated with Detection.
|
entityDetectionTypesForMonth - [String!]
|
List of detection types on Entity in given month. This field is no longer supported. Removal on v5.0.0.
|
hotspotScore - Float
|
Hotspot score of Detection. |
id - String!
|
ID of Detection. |
overallScore - Float
|
Overall score of Detection. |
pipelineFamilyName - String
|
Pipeline family name of Detection. |
ruleIds - [String!]
|
List of Rule IDs responsible for Detection creation. |
rules - [Rule!]
|
List of Rules responsible for Detection creation. |
shap - Shap
|
SHAP values for the Detection. |
sourceId - String
|
Source ID of Detection. |
sourceTable - String
|
Source table name of Detection. |
status - String
|
Status of Detection. |
statusUpdatedOn - Date
|
Date of last status change for detection. |
subtype - String!
|
Subtype of Detection. |
supervisedScore - Float
|
Supervised score of Detection. |
transactions - DetectionTransactionConnection
|
The connection type for transactions directly associated with the alerted entity. |
Example
{
"alertDate": "2007-12-03",
"anomalyScore": 123.45,
"assignedTo": AssignedTo,
"assignedToUserId": "abc123",
"category": "xyz789",
"cibScore": 123.45,
"compositeScore": 123.45,
"decision": RiskRating,
"detectionType": "xyz789",
"domainCode": "xyz789",
"entity": Entity,
"entityDetectionTypesForMonth": [
"xyz789"
],
"hotspotScore": 123.45,
"id": "abc123",
"overallScore": 987.65,
"pipelineFamilyName": "abc123",
"ruleIds": ["xyz789"],
"rules": [Rule],
"shap": Shap,
"sourceId": "abc123",
"sourceTable": "abc123",
"status": "xyz789",
"statusUpdatedOn": "2007-12-03",
"subtype": "abc123",
"supervisedScore": 987.65,
"transactions": DetectionTransactionConnection
}
DetectionWithoutTransactions
Description
Detection without transaction connection.
Fields
| Field Name | Description |
|---|---|
alertDate - Date!
|
System created Detection on DateTime. |
anomalyScore - Float
|
Anomaly score of Detection. |
assignedTo - AssignedTo
|
User assigned to Detection. |
assignedToUserId - String
|
User Id of the user assigned to the detection. |
category - String
|
Category of Detection. |
cibScore - Float
|
CIB score of Detection. |
compositeScore - Float
|
Composite score of Detection. |
decision - RiskRating
|
RiskRating associated with Detection.
|
detectionType - String
|
Type of Detection. |
domainCode - String
|
Classification of Detection. |
entity - Entity!
|
Entity associated with Detection.
|
entityDetectionTypesForMonth - [String!]
|
List of detection types on Entity in given month. This field is no longer supported. Removal on v5.0.0.
|
hotspotScore - Float
|
Hotspot score of Detection. |
id - String!
|
ID of Detection. |
overallScore - Float
|
Overall score of Detection. |
pipelineFamilyName - String
|
Pipeline family name of Detection. |
ruleIds - [String!]
|
List of Rule IDs responsible for Detection creation. |
rules - [Rule!]
|
List of Rules responsible for Detection creation. |
shap - Shap
|
SHAP values for the Detection. |
sourceId - String
|
Source ID of Detection. |
sourceTable - String
|
Source table name of Detection. |
status - String
|
Status of Detection. |
statusUpdatedOn - Date
|
Date of last status change for detection. |
subtype - String!
|
Subtype of Detection. |
supervisedScore - Float
|
Supervised score of Detection. |
supplementaryInformation - DetectionRuleDetailConnection
|
Provides supplementary information about the rules that triggered the detection. |
Example
{
"alertDate": "2007-12-03",
"anomalyScore": 123.45,
"assignedTo": AssignedTo,
"assignedToUserId": "abc123",
"category": "xyz789",
"cibScore": 123.45,
"compositeScore": 123.45,
"decision": RiskRating,
"detectionType": "abc123",
"domainCode": "abc123",
"entity": Entity,
"entityDetectionTypesForMonth": [
"abc123"
],
"hotspotScore": 123.45,
"id": "xyz789",
"overallScore": 123.45,
"pipelineFamilyName": "abc123",
"ruleIds": ["abc123"],
"rules": [Rule],
"shap": Shap,
"sourceId": "xyz789",
"sourceTable": "abc123",
"status": "abc123",
"statusUpdatedOn": "2007-12-03",
"subtype": "xyz789",
"supervisedScore": 123.45,
"supplementaryInformation": DetectionRuleDetailConnection
}
DetectionWithoutTransactionsEdge
Description
A DetectionWithoutTransactions edge.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - DetectionWithoutTransactions!
|
The item at the end of DetectionWithoutTransactionsEdge. |
Example
{
"cursor": "abc123",
"node": DetectionWithoutTransactions
}
DetectionsByQueueOrderByInput
Description
Input type for order by allowed fields.
Fields
| Input Field | Description |
|---|---|
field - DetectionByQueueOrderByFields
|
DetectionByQueue model's attributes to order by. Default = AlertDate |
sort - Sort
|
The ordering direction. Default = DESC |
Example
{"field": "AlertDate", "sort": "ASC"}
DetectionsInput
Description
Input type of Detections.
Fields
| Input Field | Description |
|---|---|
assignedToUserId - [String!]
|
Specific assigned user/users of Detection. |
detectionTypes - [String!]
|
AlertType of Alert.
|
endDate - DateTime
|
Filter records until end date as DateTime. |
externalEntityId - String
|
External entity id of associated Entity. |
filterBy - DetectionQueueFilter
|
Available filters when fetching detections from queue. Default = {} |
isAssigned - Boolean
|
All assigned/unassigned users of Detection. |
orderBy - DetectionOrder
|
Ordering options for the returned detections. Default = {field: AlertDate, sort: DESC} |
page - CursorPaginationInput
|
Specify first and after for cursor paginated results. |
queueId - ID!
|
ID of AlertQueue.
|
startDate - DateTime
|
Filter records from start date as DateTime. |
statuses - [String!]
|
Status of Alert. |
Example
{
"assignedToUserId": ["xyz789"],
"detectionTypes": ["abc123"],
"endDate": "2007-12-03T10:15:30Z",
"externalEntityId": "xyz789",
"filterBy": DetectionQueueFilter,
"isAssigned": false,
"orderBy": DetectionOrder,
"page": CursorPaginationInput,
"queueId": "4",
"startDate": "2007-12-03T10:15:30Z",
"statuses": ["abc123"]
}
DetectionsPage
Description
Response type for GetAllDetections.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [DetectionWithoutDetails!]!
|
List of DetectionWithoutDetailss. |
totalRecords - Int!
|
Total number of DetectionWithoutDetails records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [DetectionWithoutDetails],
"totalRecords": 987
}
DetectionsResponse
Description
Response type for Detections.
Fields
| Field Name | Description |
|---|---|
edges - [DetectionWithoutTransactionsEdge!]
|
A list of edges |
pageInfo - LegacyCursorPageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Total number of edges that can be returned. |
Example
{
"edges": [DetectionWithoutTransactionsEdge],
"pageInfo": LegacyCursorPageInfo,
"totalCount": 123
}
DisablePipelineInput
Description
Input type of DisablePipeline.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Pipeline. |
Example
{"id": "abc123"}
EleMetadata
EleMetadataInput
EleNotification
Description
Entity Links Explorer notification.
Fields
| Field Name | Description |
|---|---|
batchDate - Date!
|
Batch date associated to root node Detection. |
createdOn - Date!
|
Created on DateTime. |
id - ID!
|
ID of message queue Notification. |
message - JSONObject
|
Payload from message queue. |
meta - EleMetadata!
|
Payload from message queue. |
metaId - ID
|
ID of associated EleMetadata. |
nodeId - ID!
|
Selected node ID for requested relationships. |
status - NotificationStatus!
|
Message queue status. |
Example
{
"batchDate": "2007-12-03",
"createdOn": "2007-12-03",
"id": "4",
"message": {},
"meta": EleMetadata,
"metaId": "4",
"nodeId": 4,
"status": "COMPLETE"
}
EnablePipelineInput
Description
Input type of EnablePipeline.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Pipeline. |
Example
{"id": "xyz789"}
EntitiesPayload
Description
Response type for GetEntities.
Fields
| Field Name | Description |
|---|---|
records - [Entity!]!
|
List of Entitys. |
totalRecords - Int!
|
Total number of Entity records that can be returned. |
Example
{"records": [Entity], "totalRecords": 987}
Entity
Description
Object type for Entity.
Fields
| Field Name | Description |
|---|---|
accounts - AccountConnection
|
List of accounts for entity. |
Arguments
|
|
activeExemption - ExemptionList
|
Retrieve any active exemption list item for this entity |
annualIncome - Float
|
Annual income of Event. |
businessUnit - String
|
Business unit for Entity. |
countryOfResidence - String
|
Country of residence for Entity. |
customerSegment - String
|
Customer segment of Entity. |
email - String
|
Email address of Entity. |
entityType - String
|
Type of Entity. |
externalEntityId - String
|
External entity id of associated Entity. |
file - File
|
File associated with Entity.
|
fullAddress - String
|
Full address of Entity. |
fullName - String
|
Full name of Entity. |
furtherInformation - String
|
Further information of Entity. |
id - String!
|
ID of Entity. |
label - String
|
Label of Entity. |
onboardDate - DateTime
|
Onboard date of Entity. |
orgUnitCode - String
|
Org unit code of Entity. |
overallRiskScore - Float
|
The overall risk score for the entity |
phone - String
|
Phone number of Entity. |
pipelineFamilyName - String
|
pipeline family name of Entity. |
sourceId - String
|
source id of Entity. |
sourceName - String
|
Source name. |
sourceTable - String
|
Source table name of Entity. |
subtype - String!
|
Subtype of Entity. |
Example
{
"accounts": AccountConnection,
"activeExemption": ExemptionList,
"annualIncome": 123.45,
"businessUnit": "xyz789",
"countryOfResidence": "xyz789",
"customerSegment": "xyz789",
"email": "xyz789",
"entityType": "xyz789",
"externalEntityId": "xyz789",
"file": File,
"fullAddress": "xyz789",
"fullName": "xyz789",
"furtherInformation": "abc123",
"id": "abc123",
"label": "xyz789",
"onboardDate": "2007-12-03T10:15:30Z",
"orgUnitCode": "abc123",
"overallRiskScore": 123.45,
"phone": "abc123",
"pipelineFamilyName": "abc123",
"sourceId": "xyz789",
"sourceName": "abc123",
"sourceTable": "abc123",
"subtype": "abc123"
}
EntityLinksMappingResponse
Description
Response type for triggerEntityLinksMapping.
Fields
| Field Name | Description |
|---|---|
errors - [String!]!
|
Shows individual batches errors. |
success - Boolean!
|
Status of bulk insert request. |
totalRecords - Float!
|
Total records inserted. |
Example
{
"errors": ["xyz789"],
"success": false,
"totalRecords": 987.65
}
EntityModel
Description
Object type for Entity.
Fields
| Field Name | Description |
|---|---|
annualIncome - Float
|
Annual income of Event. |
businessUnit - String
|
Business unit for Entity. |
countryOfResidence - String
|
Country of residence for Entity. |
createdOn - DateTime
|
Created on DateTime. |
customerSegment - String
|
Customer segment of Entity. |
deletedOn - DateTime
|
Deleted on DateTime. |
email - String
|
Email address of Entity. |
entityType - String
|
Type of Entity. |
externalEntityId - String
|
External entity id of associated Entity. |
file - File
|
File associated with Entity.
|
fullAddress - String
|
Full address of Entity. |
fullName - String
|
Full name of Entity. |
furtherInformation - String
|
Further information of Entity. |
id - String!
|
ID of Entity. |
label - String
|
Label of Entity. |
onboardDate - DateTime
|
Onboard date of Entity. |
orgUnitCode - String
|
Org unit code of Entity. |
overallRiskScore - Float
|
The overall risk score for the entity |
phone - String
|
Phone number of Entity. |
pipelineFamilyName - String
|
pipeline family name of Entity. |
sourceId - String
|
source id of Entity. |
sourceName - String
|
Source name. |
sourceTable - String
|
Source table name of Entity. |
subtype - String!
|
Subtype of Entity. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"annualIncome": 123.45,
"businessUnit": "abc123",
"countryOfResidence": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"customerSegment": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"entityType": "xyz789",
"externalEntityId": "abc123",
"file": File,
"fullAddress": "xyz789",
"fullName": "abc123",
"furtherInformation": "xyz789",
"id": "xyz789",
"label": "xyz789",
"onboardDate": "2007-12-03T10:15:30Z",
"orgUnitCode": "abc123",
"overallRiskScore": 987.65,
"phone": "xyz789",
"pipelineFamilyName": "xyz789",
"sourceId": "xyz789",
"sourceName": "abc123",
"sourceTable": "abc123",
"subtype": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
EntitySubtypes
Description
Categorizes entities into different subtypes.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Customer"
EtlStatusInput
Description
Retrieve latest status information for an ETL job.
Example
{
"jobType": "Detection",
"processId": "abc123"
}
Event
Types
| Union Types |
|---|
Example
WithCorrespondentBankingAttributes
EventFilter
Description
The filters that are available when fetching events.
Fields
| Input Field | Description |
|---|---|
functionalCurrencies - [String!]
|
Filter events by these functional currency. |
originalCurrencies - [String!]
|
Filter events by these original currency. |
originatorIds - [String!]
|
Filter events by these originator ids. |
transactionTypes - [String!]
|
Filter events by these transaction types. |
txnIds - [String!]
|
Filter events by these transaction ids. |
Example
{
"functionalCurrencies": ["abc123"],
"originalCurrencies": ["abc123"],
"originatorIds": ["xyz789"],
"transactionTypes": ["xyz789"],
"txnIds": ["abc123"]
}
EventModel
Description
Object type for Event.
Fields
| Field Name | Description |
|---|---|
accountWithInstitution - String
|
Account With Institution. |
accountWithInstitutionCountry - String
|
Account With Institution Country. |
baseCurrency - String
|
The base currency of the customers accounts |
beneficiaries - [EntityModel!]
|
Associated beneficiary Entity. Use beneficiariesV2 instead. Removal on v5.0.0.
|
beneficiariesV2 - BeneficiariesV2
|
Associated beneficiaries to an event. |
beneficiaryCustomer - String
|
Beneficiary customer. |
beneficiaryId - String
|
beneficiary id of Event. |
beneficiaryInstitution - String
|
Beneficiary institution. |
beneficiaryInstitutionCountry - String
|
Beneficiary institution country. |
branchId - String
|
Represents the branch id of the transaction |
buyer - String
|
Identifiers the buying party in the transaction |
cardId - String
|
Unique identifier for the card |
createdOn - DateTime
|
Created on DateTime. |
creditDebitFlag - String
|
Credit or Debit for Event. |
deletedOn - DateTime
|
Deleted on DateTime. |
destinationCountry - String
|
Destination country. |
deviceId - String
|
The id of the device |
eventDate - DateTime
|
Date of event. |
file - File
|
File associated with event. |
financialInstrumentCountry - String
|
Financial Instrument Country. |
financialInstrumentDetails - String
|
Financial Instrument Details |
financialInstrumentIsin - String
|
Financial Instrument Is in. |
financialInstrumentQuantity - Float
|
The instrument quantity involved in the transaction |
functionalAmount - Float
|
Functional amount of Event. |
functionalCurrency - String
|
Functional currency of Event. |
id - String!
|
ID of Event. |
intermediary - String
|
Intermediary. |
intermediaryCountry - String
|
Intermediary Country. |
label - String
|
Label of Event. |
orderingCustomer - String
|
Ordering customer. |
orderingInstitution - String
|
Ordering institution. |
orderingInstitutionCountry - String
|
Ordering institution country. |
originCountry - String
|
Origin country. |
originalAmount - Float
|
Original amount of Event. |
originalCurrency - String
|
Original currency of Event. |
originationDate - DateTime
|
Date the Transaction originated or date of Transaction |
originatorId - String
|
originator id of Event. |
originators - [EntityModel!]
|
Associated originator Entity. Use originatorsV2 instead. Make sure to adhere to the new schema for originatorsV2. Removal on v5.0.0.
|
originatorsV2 - OriginatorsV2
|
Associated originators to an event. |
pipelineFamilyName - String
|
pipeline family name of Event. |
postingDate - DateTime
|
Date the Transaction was posted to the account |
receiverBic - String
|
Receiving Bank Identification Code (BIC). |
receiverCorrespondent - String
|
Receiver correspondent. |
receiverCorrespondentCountry - String
|
Receiver correspondent country. |
region - String
|
Indicates whether this type of transaction is DOMESTIC, INTERNATIONAL, or - (i.e., unknown type) |
scope - String
|
The scope of the transaction. Can be EXTERNAL, CLIENT or INTERNAL |
seller - String
|
Identifiers the selling party in the transaction |
senderBic - String
|
Sender Bank Identification Code (BIC). |
senderCorrespondent - String
|
Sender correspondent. |
senderCorrespondentCountry - String
|
Sender correspondent country. |
sendingInstitution - String
|
Sending institution. |
sendingInstitutionCountry - String
|
Sending institution country. |
settlementBic - String
|
Settlement Bank Identification Code (BIC) |
settlementPlaceCountry - String
|
Settlement Place Country. |
sourceId - String
|
source id of Event. |
sourceName - String
|
Source name. |
sourceSystem - String
|
Identifier for the Source system that the Transaction came from |
sourceTable - String
|
source table name of Event. |
subtype - String!
|
Subtype of Event. |
tellerId - String
|
The teller Identification number |
transactionType - String
|
Type of transaction (e.g., wire, card, cash, etc). |
transactionTypeDescription - String
|
Description of transaction type. |
txnId - String
|
txn id of Event. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"accountWithInstitution": "xyz789",
"accountWithInstitutionCountry": "abc123",
"baseCurrency": "abc123",
"beneficiaries": [EntityModel],
"beneficiariesV2": BeneficiariesV2,
"beneficiaryCustomer": "xyz789",
"beneficiaryId": "xyz789",
"beneficiaryInstitution": "abc123",
"beneficiaryInstitutionCountry": "xyz789",
"branchId": "abc123",
"buyer": "xyz789",
"cardId": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"creditDebitFlag": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"destinationCountry": "abc123",
"deviceId": "abc123",
"eventDate": "2007-12-03T10:15:30Z",
"file": File,
"financialInstrumentCountry": "xyz789",
"financialInstrumentDetails": "xyz789",
"financialInstrumentIsin": "xyz789",
"financialInstrumentQuantity": 123.45,
"functionalAmount": 123.45,
"functionalCurrency": "abc123",
"id": "abc123",
"intermediary": "abc123",
"intermediaryCountry": "xyz789",
"label": "abc123",
"orderingCustomer": "xyz789",
"orderingInstitution": "abc123",
"orderingInstitutionCountry": "abc123",
"originCountry": "xyz789",
"originalAmount": 123.45,
"originalCurrency": "xyz789",
"originationDate": "2007-12-03T10:15:30Z",
"originatorId": "xyz789",
"originators": [EntityModel],
"originatorsV2": OriginatorsV2,
"pipelineFamilyName": "abc123",
"postingDate": "2007-12-03T10:15:30Z",
"receiverBic": "abc123",
"receiverCorrespondent": "xyz789",
"receiverCorrespondentCountry": "abc123",
"region": "abc123",
"scope": "abc123",
"seller": "xyz789",
"senderBic": "abc123",
"senderCorrespondent": "xyz789",
"senderCorrespondentCountry": "abc123",
"sendingInstitution": "abc123",
"sendingInstitutionCountry": "abc123",
"settlementBic": "xyz789",
"settlementPlaceCountry": "xyz789",
"sourceId": "abc123",
"sourceName": "xyz789",
"sourceSystem": "xyz789",
"sourceTable": "abc123",
"subtype": "xyz789",
"tellerId": "abc123",
"transactionType": "xyz789",
"transactionTypeDescription": "abc123",
"txnId": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
EventModelEdge
Description
A EventModel edge.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - EventModel!
|
The item at the end of EventModelEdge. |
Example
{
"cursor": "abc123",
"node": EventModel
}
EventSubtypes
Description
Defines the subtypes of events that the system can process or record.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"Transaction"
ExemptionList
Description
ExemptionList object.
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"endsOn": "2007-12-03T10:15:30Z",
"entityId": "xyz789",
"pipelineFamilyName": "xyz789",
"ruleId": "xyz789",
"ruleSetId": "abc123"
}
ExemptionsInput
Description
Input type for exemptions.
Example
{
"activeOn": "2007-12-03T10:15:30Z",
"pipelineFamilyName": "xyz789",
"ruleId": "xyz789",
"ruleSetId": "abc123"
}
Feature
Description
Object type for Feature.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
entity - String
|
Entity. |
features - JSONObject
|
features of Feature. |
id - String!
|
ID of Feature. |
pipeline - String!
|
Pipeline of Feature. |
runDate - DateTime
|
Run date Feature on DateTime. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"entity": "xyz789",
"features": {},
"id": "xyz789",
"pipeline": "xyz789",
"runDate": "2007-12-03T10:15:30Z",
"updatedOn": "2007-12-03T10:15:30Z"
}
FeatureHistory
Description
A FeatureHistory object.
Example
{
"createDate": "2007-12-03T10:15:30Z",
"entityId": "xyz789",
"featureName": "abc123",
"value": 987.65
}
FeatureToggleDto
Description
Feature toggle.
Fields
| Field Name | Description |
|---|---|
key - FeatureToggleKey!
|
|
value - Boolean!
|
Value of Feature toggle. |
Example
{"key": "EntityLinksExplorer", "value": false}
FeatureToggleKey
Description
Features that can be dynamically enabled or disabled in the application.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EntityLinksExplorer"
FieldConfig
Description
Configuration for a single field within the table details.
Fields
| Field Name | Description |
|---|---|
default - Boolean
|
Indicates if the field should be displayed by default. |
fields - [FieldConfig!]
|
A list of configurations for each nested field, if any. |
name - String!
|
The internal name of the field. |
Example
{
"default": true,
"fields": [FieldConfig],
"name": "xyz789"
}
FieldSuggestionResponse
Description
GetFieldSuggestions response object.
Fields
| Field Name | Description |
|---|---|
suggestions - [String!]
|
Suggestions for a field |
Example
{"suggestions": ["abc123"]}
File
Description
Object type for File.
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
Bucket for File. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of File. |
mimetype - String
|
Mimetype of File. |
name - String!
|
Name of File. |
size - Float
|
Size of File. |
type - FileType!
|
Type of File. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"bucket": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"mimetype": "xyz789",
"name": "xyz789",
"size": 987.65,
"type": "DataSource",
"updatedOn": "2007-12-03T10:15:30Z"
}
FileInput
Description
Input type to get a file.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of File |
Example
{"id": "abc123"}
FileStatus
Description
Object type for file status.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime!
|
Created FileStatus on DateTime. |
deletedOn - DateTime
|
Deleted FileStatus on DateTime. |
file - File
|
File for FileStatus. |
id - String
|
ID of FileStatus. |
info - JSONObject
|
Info is a JSON object where more details or log messages can be supplied for a file status`. |
recordCount - Float
|
Record count |
status - String
|
status for file |
updatedOn - DateTime!
|
Updated FileStatus on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"file": File,
"id": "abc123",
"info": {},
"recordCount": 987.65,
"status": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
FileStorage
FileType
Description
Categorizes files by their usage context, distinguishing between data sources and general-purpose files.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DataSource"
FileWithLatestStatus
Description
File With status
Fields
| Field Name | Description |
|---|---|
bucket - String
|
Bucket for File. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
fileStatus - [FileStatus!]
|
Latest status of File. |
id - String
|
ID of File. |
mimetype - String
|
Mimetype of File. |
name - String
|
Name of File. |
size - Float
|
Size of File. |
type - FileType
|
Type of File. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"bucket": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"fileStatus": [FileStatus],
"id": "xyz789",
"mimetype": "xyz789",
"name": "xyz789",
"size": 987.65,
"type": "DataSource",
"updatedOn": "2007-12-03T10:15:30Z"
}
FilterAlertFeaturesInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
Term to search through AlertFeatures |
Example
{"searchTerm": "xyz789"}
FilterAlertsInput
Description
Input type to support Filter requests for Alerts.
Fields
| Input Field | Description |
|---|---|
endDate - DateTime
|
List records before the given date. Default = null |
fields - [String!]
|
List of Model's attributes to filter by. |
searchTerm - String
|
Term to search through Alerts by Entity field. |
startDate - DateTime
|
List records at and after the given date. Default = null |
Example
{
"endDate": "2007-12-03T10:15:30Z",
"fields": ["xyz789"],
"searchTerm": "xyz789",
"startDate": "2007-12-03T10:15:30Z"
}
FilterAndOrderByFields
Description
Properties by which trades can be filtered or ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Amount"
FilterInput
Description
Input type to support Filter requests.
Example
{
"endDate": "2007-12-03T10:15:30Z",
"fields": ["xyz789"],
"startDate": "2007-12-03T10:15:30Z"
}
FilterUsersInput
Description
Input type to support Pagination requests with search queries for Users.
Fields
| Input Field | Description |
|---|---|
isActive - Boolean
|
Indicates if the user is active or not in the system. |
role - String
|
Field to search through Users by role field. |
searchTerm - String
|
Term to search through Users by first and last name field. |
username - String
|
Field to search through Users by username field. |
Example
{
"isActive": false,
"role": "xyz789",
"searchTerm": "xyz789",
"username": "abc123"
}
FilterableValuesResponse
Description
Get Filterable Values Response.
Fields
| Field Name | Description |
|---|---|
filterableValues - [String!]
|
List of all Filterable Values |
pageInfo - CursorPageInfo!
|
Pagination details. |
Example
{
"filterableValues": ["xyz789"],
"pageInfo": CursorPageInfo
}
Filters
Description
An array of filters with all the logic to filter data.
Fields
| Field Name | Description |
|---|---|
logic - [Logic!]
|
Field logic to filter data |
Example
{"logic": [Logic]}
FiltersInput
Description
An array of filters with all the logic to filter data.
Fields
| Input Field | Description |
|---|---|
logic - [LogicInput!]
|
Field logic to filter data |
Example
{"logic": [LogicInput]}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FlowOfFundsFiltersInput
Description
Input filters for Entity Links Explorer queries.
Example
{
"fromAmount": 123.45,
"higherScore": 123.45,
"lowerScore": 987.65,
"toAmount": 987.65
}
FlowOfFundsLinksInput
Description
Input type of flowOfFundsLinks.
Fields
| Input Field | Description |
|---|---|
alertId - String
|
ID of Detection. |
batchDate - DateTime
|
Batch date associated to Detection. |
entityId - String!
|
ID of Entity with Relationships. |
filterBy - FlowOfFundsFiltersInput!
|
Filters for Entity Links Explorer. |
Example
{
"alertId": "xyz789",
"batchDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"filterBy": FlowOfFundsFiltersInput
}
FlushSearchPayload
Description
Response type for FlushSearch.
Example
{
"error": "xyz789",
"message": "abc123",
"success": false
}
GetActiveAlertedEntitiesInput
Description
Input type for GetActiveAlertedEntities.
Example
{
"endDate": "2007-12-03T10:15:30Z",
"pipelineFamilyName": "abc123",
"startDate": "2007-12-03T10:15:30Z"
}
GetActivitiesInput
Description
Input type for getting activities by reference ID.
Fields
| Input Field | Description |
|---|---|
referenceId - String!
|
ID of activity source (i.e., Rule or Alert). |
Example
{"referenceId": "abc123"}
GetAlertFeaturesInput
Description
Input type of GetAlertFeatures.
Fields
| Input Field | Description |
|---|---|
entityId - String
|
ID of Entity. |
featureDate - Date
|
DateTime of Feature. |
filter - FilterAlertFeaturesInput
|
Filter for AlertFeatures. |
orderBy - OrderByInput
|
Order by Model's column/field. Default = {sort: DESC} |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{
"entityId": "xyz789",
"featureDate": "2007-12-03",
"filter": FilterAlertFeaturesInput,
"orderBy": OrderByInput,
"page": OffsetPaginationInput
}
GetAlertFeaturesResponse
Description
Response type for GetAlertFeatures.
Fields
| Field Name | Description |
|---|---|
alerts - [Alert!]
|
Associated alerts. |
entity - Entity
|
Associated entity. |
entityId - String!
|
ID of Entity. |
featureDate - DateTime!
|
DateTime of shap values. |
features - [ShapFeature!]!
|
Relevant feature values and shap values. |
id - String
|
Represents the ID of the AlertFeature record. |
totalRecords - Int!
|
Total number of AlertFeature records that can be returned. |
Example
{
"alerts": [Alert],
"entity": Entity,
"entityId": "xyz789",
"featureDate": "2007-12-03T10:15:30Z",
"features": [ShapFeature],
"id": "xyz789",
"totalRecords": 123
}
GetAlertsByInput
GetAlertsGeneratedSummary
Description
Generated Alerts Summary response.
Fields
| Field Name | Description |
|---|---|
byRiskRating - [ReportSummaryObject!]
|
Alerts generated by risk rating |
bySource - [ReportSummaryObject!]
|
Alerts generated by source |
byStatus - [ReportSummaryObject!]
|
Alerts generated by status |
Example
{
"byRiskRating": [ReportSummaryObject],
"bySource": [ReportSummaryObject],
"byStatus": [ReportSummaryObject]
}
GetAlertsGeneratedSummaryInput
Description
Input type of GetAlertsGeneratedSummary.
Fields
| Input Field | Description |
|---|---|
endDate - DateTime
|
List records before the given date. Default = null |
pipelineFamilyName - String
|
Pipeline's Family name.
|
reportInterval - String!
|
Interval of report. Options are weekly, monthly, daily |
startDate - DateTime
|
List records at and after the given date. Default = null |
Example
{
"endDate": "2007-12-03T10:15:30Z",
"pipelineFamilyName": "abc123",
"reportInterval": "abc123",
"startDate": "2007-12-03T10:15:30Z"
}
GetAllDetectionsInput
Description
Input type of GetAllDetections.
Fields
| Input Field | Description |
|---|---|
accountNumber - String
|
Account number (if this object represents an account; type = account) |
assigned - Boolean
|
All assigned/unassigned users of Detection. |
assignedToUserId - [String!]
|
Specific assigned user/users of Detection. Default = [] |
compositeScoreMax - Float
|
Set maximum composite score value for Detection. Default = 1 |
compositeScoreMin - Float
|
Set minimum composite score value for Detection. Default = 0 |
detectionTypes - [String!]
|
Type of Detection. Default = [] |
entityId - String
|
ID of associated Entity. Default = "" |
externalEntityId - String
|
External entity id of associated Entity. |
filter - FilterAlertsInput
|
Filter for Alerts. |
ids - [String!]
|
List of Detection IDs to filter results. Default = [] |
orderBy - OrderByInput
|
Specify the ordering of records in DetectionsPage response. Default = {field: "alertDate", sort: DESC} |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
status - [String!]
|
Status of Detection. Default = [] |
Example
{
"accountNumber": "abc123",
"assigned": false,
"assignedToUserId": ["xyz789"],
"compositeScoreMax": 987.65,
"compositeScoreMin": 123.45,
"detectionTypes": ["abc123"],
"entityId": "abc123",
"externalEntityId": "abc123",
"filter": FilterAlertsInput,
"ids": ["xyz789"],
"orderBy": OrderByInput,
"page": OffsetPaginationInput,
"status": ["xyz789"]
}
GetAllFilesInput
Description
Input type to get all files from a bucket.
Fields
| Input Field | Description |
|---|---|
bucketName - String!
|
Bucket name. |
Example
{"bucketName": "abc123"}
GetAppVersionResponse
Description
Response type for getting app version.
Fields
| Field Name | Description |
|---|---|
api - AppVersionDetails!
|
API Version details. |
hermes - AppVersionDetails!
|
Hermes Version details. |
ref - String
|
Git Ref. Use api.ref instead. No longer supported and will be removed in the near future. Removal on v5.0.0. |
sha - String
|
Git Ref. Use api.ref instead. No longer supported and will be removed in the near future. Removal on v5.0.0. |
styx - AppVersionDetails!
|
Styx Version details. |
Example
{
"api": AppVersionDetails,
"hermes": AppVersionDetails,
"ref": "abc123",
"sha": "abc123",
"styx": AppVersionDetails
}
GetAuditLogsInput
Description
Input type of GetAuditLogs.
Fields
| Input Field | Description |
|---|---|
endDate - DateTime
|
Latest date from which to return the logs. |
limit - Int
|
Limit number of records. Default = 25 |
orderBy - OrderByInput
|
Specify the ordering of records in GetUserAuditPage response. Default = {field: "createdOn", sort: DESC} |
pageNumber - Int
|
Page number for pagination of Model. Default = 0 |
startDate - DateTime
|
Earliest date from which to return the logs. |
Example
{
"endDate": "2007-12-03T10:15:30Z",
"limit": 123,
"orderBy": OrderByInput,
"pageNumber": 123,
"startDate": "2007-12-03T10:15:30Z"
}
GetCountriesInput
GetDetectedEntitiesBreakdownInput
Description
Input type of GetDetectedEntitiesBreakdown.
Example
{
"endDate": "2007-12-03T10:15:30Z",
"pipelineFamilyName": "abc123",
"startDate": "2007-12-03T10:15:30Z"
}
GetDetectionDetailsAdminSettingsInput
Description
Input type for `GetDetectionDetailsAdminSettings
Fields
| Input Field | Description |
|---|---|
detectionSuffix - String
|
Pipeline Family Detection Suffix |
Example
{"detectionSuffix": "abc123"}
GetDetectionInput
GetDetectionsByQueueFilter
Description
Filters for querying GetDetectionsByQueue.
Fields
| Input Field | Description |
|---|---|
accountNumber - String
|
Account number (if this object represents an account; type = account) |
alertDate - Date
|
System created Detection on DateTime. |
anomalyScore - Float
|
Anomaly score of Detection. |
category - String
|
Category of Detection. |
cibScore - Float
|
CIB score of Detection. |
compositeScore - Float
|
Composite score of Detection. |
decision - String
|
Latest RiskRating label for Detection. |
detectionId - String
|
ID of Detection. |
detectionTypes - [String!]
|
Specifies the alert types to include in the query results. |
endDate - DateTime
|
End of the date range for filtering detections. |
entityId - String
|
ID of Entity. |
externalEntityId - String
|
External entity id of associated Entity. |
fullName - String
|
Full name of Entity. |
hotspotScore - Float
|
Hotspot score of Detection. |
includeUnassigned - Boolean
|
Whether to include detections with unassigned users. |
startDate - DateTime
|
Start of the date range for filtering detections. |
statusUpdatedOn - DateTime
|
Filters detections by date of last status change. |
statuses - [String!]
|
Specifies the alert status values to include in the query results. |
subtype - String
|
Subtype of Detection. |
supervisedScore - Float
|
Supervised score of Detection. |
Example
{
"accountNumber": "abc123",
"alertDate": "2007-12-03",
"anomalyScore": 987.65,
"category": "abc123",
"cibScore": 123.45,
"compositeScore": 123.45,
"decision": "abc123",
"detectionId": "abc123",
"detectionTypes": ["xyz789"],
"endDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"externalEntityId": "xyz789",
"fullName": "xyz789",
"hotspotScore": 987.65,
"includeUnassigned": true,
"startDate": "2007-12-03T10:15:30Z",
"statusUpdatedOn": "2007-12-03T10:15:30Z",
"statuses": ["abc123"],
"subtype": "xyz789",
"supervisedScore": 987.65
}
GetDetectionsByQueueInput
Description
Input type of GetDetectionsByQueue.
Fields
| Input Field | Description |
|---|---|
assigned - Boolean
|
Whether to include detections with assigned users. |
assignedToUserId - [String!]
|
Specific assigned user/users of Detection. |
detectionTypes - [String!]
|
AlertType of Alert.
|
endDate - DateTime
|
Filter records until end date as DateTime. |
filterBy - GetDetectionsByQueueFilter
|
Filters to apply to the detection query. Default = {} |
id - ID!
|
ID of AlertQueue.
|
includeUnassigned - Boolean
|
Whether to include detections with unassigned users. |
orderBy - DetectionsByQueueOrderByInput
|
Specify the ordering of records in DetectionsPage response. Default = {field: AlertDate, sort: DESC} |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
startDate - DateTime
|
Filter records from start date as DateTime. |
statuses - [String!]
|
Status of Alert. |
Example
{
"assigned": true,
"assignedToUserId": ["xyz789"],
"detectionTypes": ["xyz789"],
"endDate": "2007-12-03T10:15:30Z",
"filterBy": GetDetectionsByQueueFilter,
"id": "4",
"includeUnassigned": true,
"orderBy": DetectionsByQueueOrderByInput,
"page": OffsetPaginationInput,
"startDate": "2007-12-03T10:15:30Z",
"statuses": ["xyz789"]
}
GetEntitiesInput
Description
Input type of GetEntities.
Fields
| Input Field | Description |
|---|---|
filter - FilterInput
|
Filter for Model. Default = {endDate: null, fields: [], startDate: null} |
ids - [String!]
|
IDs of Entity. Default = [] |
orderBy - OrderByInput
|
Order by Model's column/field. Default = {sort: DESC} |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
pipelineFamilyName - String
|
Data source of Entity. Default = "" |
subtype - EntitySubtypes
|
Subtype of Entity. |
Example
{
"filter": FilterInput,
"ids": ["xyz789"],
"orderBy": OrderByInput,
"page": OffsetPaginationInput,
"pipelineFamilyName": "xyz789",
"subtype": "Customer"
}
GetEntityInput
Description
Input type of GetEntity.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Entity. |
Example
{"id": "xyz789"}
GetEntityTradesInput
Description
Input type of entityTrades. @deprecated(reason: "This query will be replaced with trades query. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
entityId - String!
|
ID of Entity. |
filter - FilterInput
|
Filter for Model. Default = {endDate: null, fields: [], startDate: null} |
filterBy - TradeTransactionEventsFilter
|
Filter events by this type. Default = {} |
orderBy - [TradesOrderByInput!]
|
Specify the ordering of records. Default = [{field: TransactionDate, sort: ASC}] |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{
"entityId": "abc123",
"filter": FilterInput,
"filterBy": TradeTransactionEventsFilter,
"orderBy": [TradesOrderByInput],
"page": OffsetPaginationInput
}
GetEntityTradesResponse
Description
Entity Trades Response Attributes.
Fields
| Field Name | Description |
|---|---|
amount - Float
|
Original amount of TradeTransactionEvents. |
amountNorm - Float
|
Amount Norm of TradeTransactionEvents. |
beneficiary - TradeOriginatorOrBeneficiary
|
beneficiary of TradeTransactionEvents. |
beneficiaryAccountNumber - StringObject
|
beneficiary account number of TradeTransactionEvents. Use beneficiary instead. Removal on v6.0.0.
|
bookId - StringObject
|
Book ID of TradeTransactionEvents. |
buySell - StringObject
|
Buy/Sell of TradeTransactionEvents. |
cleanNetPrice - Float
|
Clean net price of TradeTransactionEvents. |
cleanPrice - Float
|
Clean price of TradeTransactionEvents. |
countryOfResidence - StringObject
|
Country of Residence of TradeTransactionEvents. |
currencyNorm - StringObject
|
Currency norm of TradeTransactionEvents. |
currencyTwo - StringObject
|
Currency two of TradeTransactionEvents. |
dirtyPrice - Float
|
Dirty price of TradeTransactionEvents. |
entityId - StringObject
|
ID of Entity |
expiryDate - Date
|
Expiry date of TradeTransactionEvents. |
farCashSettlementAmount - Float
|
Far cash settlement amount of TradeTransactionEvents. |
farLegAmountOne - Float
|
Far leg amount one of TradeTransactionEvents. |
farLegAmountTwo - Float
|
Far leg amount two of TradeTransactionEvents. |
farLegCurrencyOne - StringObject
|
Far leg currency one of TradeTransactionEvents. |
farLegCurrencyTwo - StringObject
|
Far leg currency two of TradeTransactionEvents. |
farLegFxRate - Float
|
Far leg fx rate of TradeTransactionEvents. |
farLegValueDate - Date
|
Far leg value date of TradeTransactionEvents. |
fixedRate - Float
|
Fixed rate of TradeTransactionEvents. |
fixedRateTwo - StringObject
|
Fixed rate two of TradeTransactionEvents. |
floatingRate - StringObject
|
Floating rate of TradeTransactionEvents. |
floatingRateTwo - StringObject
|
Floating rate two of TradeTransactionEvents. |
id - StringObject!
|
ID of TradeTransactionEvents. |
indexTicker - StringObject
|
Index ticker of TradeTransactionEvents. |
instrumentDetails - StringObject
|
Details of the instrument used in TradeTransactionEvents. |
internalTrade - StringObject
|
Internal Trade Flag of TradeTransactionEvents. |
isin - StringObject
|
ISIN of TradeTransactionEvents. |
isinInstrument - StringObject
|
Isin instrument of TradeTransactionEvents. |
lastTradeEvent - StringObject
|
Last Trade Event of TradeTransactionEvents. |
nearLegAmountTwo - Float
|
Near leg amount two of TradeTransactionEvents. |
nearLegCurrencyTwo - StringObject
|
Near leg currency two of TradeTransactionEvents. |
nearLegFxRate - Float
|
Near leg fx rate of TradeTransactionEvents. |
nearLegValueDate - Date
|
Near leg value date of TradeTransactionEvents. |
nominalAmount - Float
|
Nominal amount of TradeTransactionEvents. |
notionalTwo - Float
|
Notional two of TradeTransactionEvents. |
numberOfUnits - Float
|
Number of units of TradeTransactionEvents. |
originator - TradeOriginatorOrBeneficiary
|
beneficiary of TradeTransactionEvents. |
originatorAccountNumber - StringObject
|
originator account number of TradeTransactionEvents. Use originator instead. Removal on v6.0.0.
|
paymentDate - Date
|
Payment date of TradeTransactionEvents. |
pipelineFamilyName - StringObject
|
pipeline family name of TradeTransactionEvents. |
quantity - Float
|
Quantity of TradeTransactionEvents. |
quantityAmount - Float
|
Quantity amount of TradeTransactionEvents. |
rulesTriggered - [TradeRule!]
|
List of rules triggered for TradeTransactionEvents. |
settlementAmount - Float
|
Settlement Amount of TradeTransactionEvents. |
settlementCurrency - StringObject
|
Settlement currency of TradeTransactionEvents. |
settlementDate - Date
|
Settlement Date of TradeTransactionEvents. |
strikePrice - Float
|
Strike price of TradeTransactionEvents. |
tenor - StringObject
|
Tenor of TradeTransactionEvents. |
tenorTwo - StringObject
|
Tenor two. of TradeTransactionEvents |
terminationDate - Date
|
Termination Date of TradeTransactionEvents. |
ticker - StringObject
|
Ticker of TradeTransactionEvents. |
tickerInstrument - StringObject
|
Ticker instrument of TradeTransactionEvents. |
tradeStatus - StringObject
|
Trade Status of TradeTransactionEvents. |
tradeType - StringObject
|
Trade Type. |
transactionCurrency - StringObject
|
Transaction currency of TradeTransactionEvents. |
transactionDate - Date
|
Date of TradeTransactionEvents. |
transactionId - StringObject
|
transaction id of TradeTransactionEvents. |
transactionType - StringObject
|
Type of TradeTransactionEvents. |
underlyingSecMarketPrice - Float
|
Underlying sec market price of TradeTransactionEvents. |
unitPrice - Float
|
Unit price of TradeTransactionEvents. |
workerCode - StringObject
|
Trader Code or Dealer Name of TradeTransactionEvents. |
Example
{
"amount": 987.65,
"amountNorm": 987.65,
"beneficiary": TradeOriginatorOrBeneficiary,
"beneficiaryAccountNumber": StringObject,
"bookId": StringObject,
"buySell": StringObject,
"cleanNetPrice": 987.65,
"cleanPrice": 987.65,
"countryOfResidence": StringObject,
"currencyNorm": StringObject,
"currencyTwo": StringObject,
"dirtyPrice": 987.65,
"entityId": StringObject,
"expiryDate": "2007-12-03",
"farCashSettlementAmount": 987.65,
"farLegAmountOne": 123.45,
"farLegAmountTwo": 123.45,
"farLegCurrencyOne": StringObject,
"farLegCurrencyTwo": StringObject,
"farLegFxRate": 987.65,
"farLegValueDate": "2007-12-03",
"fixedRate": 123.45,
"fixedRateTwo": StringObject,
"floatingRate": StringObject,
"floatingRateTwo": StringObject,
"id": StringObject,
"indexTicker": StringObject,
"instrumentDetails": StringObject,
"internalTrade": StringObject,
"isin": StringObject,
"isinInstrument": StringObject,
"lastTradeEvent": StringObject,
"nearLegAmountTwo": 987.65,
"nearLegCurrencyTwo": StringObject,
"nearLegFxRate": 987.65,
"nearLegValueDate": "2007-12-03",
"nominalAmount": 987.65,
"notionalTwo": 123.45,
"numberOfUnits": 123.45,
"originator": TradeOriginatorOrBeneficiary,
"originatorAccountNumber": StringObject,
"paymentDate": "2007-12-03",
"pipelineFamilyName": StringObject,
"quantity": 123.45,
"quantityAmount": 123.45,
"rulesTriggered": [TradeRule],
"settlementAmount": 987.65,
"settlementCurrency": StringObject,
"settlementDate": "2007-12-03",
"strikePrice": 987.65,
"tenor": StringObject,
"tenorTwo": StringObject,
"terminationDate": "2007-12-03",
"ticker": StringObject,
"tickerInstrument": StringObject,
"tradeStatus": StringObject,
"tradeType": StringObject,
"transactionCurrency": StringObject,
"transactionDate": "2007-12-03",
"transactionId": StringObject,
"transactionType": StringObject,
"underlyingSecMarketPrice": 987.65,
"unitPrice": 987.65,
"workerCode": StringObject
}
GetEventInput
Description
Input type of getEventInput.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Event. |
subtype - EventSubtypes
|
Subtype of Event. Default = Transaction |
Example
{"id": "abc123", "subtype": "Transaction"}
GetEventsInput
Description
Input type of GetEventsInput.
Fields
| Input Field | Description |
|---|---|
accountId - String
|
Filter Events by Object. Results will be limited to direct association with Object. Unless entityId is provided too, results will not include counterparties. Default = null |
entityId - String
|
Filter Events by Entity. Results will be limited to direct association with Entity, Unless accountId is provided too, results will not include counterparties. Default = null |
filter - FilterInput
|
Filter for Model. Default = {endDate: null, fields: [], startDate: null} |
filterBy - EventFilter
|
Filter events by this type. Default = {} |
orderBy - OrderByInput
|
Specify the ordering of records in PaginatedEvents response. Default = {field: "eventDate", sort: DESC} |
page - OffsetPaginationInputNoMaxLimit
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
subtype - EventSubtypes
|
Subtype of Event. Default = Transaction |
Example
{
"accountId": "abc123",
"entityId": "xyz789",
"filter": FilterInput,
"filterBy": EventFilter,
"orderBy": OrderByInput,
"page": OffsetPaginationInputNoMaxLimit,
"subtype": "Transaction"
}
GetFeatureHistoryInput
Description
Input type of GetFeatureHistory.
Fields
| Input Field | Description |
|---|---|
entityId - String!
|
ID of Entity associated with FeatureHistory. |
Example
{"entityId": "xyz789"}
GetFeatureToggleInput
Fields
| Input Field | Description |
|---|---|
key - FeatureToggleKey!
|
Example
{"key": "EntityLinksExplorer"}
GetFeaturesInput
Description
Input type of GetFeaturesInput.
Fields
| Input Field | Description |
|---|---|
endDate - DateTime
|
Run date end date. |
entityId - String
|
Entity Id of feature. |
page - OffsetPaginationInput
|
|
startDate - DateTime
|
Run date start date. |
Example
{
"endDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"page": OffsetPaginationInput,
"startDate": "2007-12-03T10:15:30Z"
}
GetFieldsSuggestionsInput
Description
Input type to query Get Field Suggestions
Fields
| Input Field | Description |
|---|---|
field - String!
|
Field to query |
itemType - ItemTypes!
|
Item type to query |
limit - Float
|
Number of results to return, Defaults to 10 |
query - String!
|
Query text |
Example
{
"field": "abc123",
"itemType": "ACCOUNTS",
"limit": 123.45,
"query": "abc123"
}
GetFileStatusesInput
Description
Input type of GetFileStatuses.
Fields
| Input Field | Description |
|---|---|
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{"page": OffsetPaginationInput}
GetFlowOfFundsViewInput
Description
Input type of GetRelationshipsLinksView. @deprecated(reason: "Replaced by RiskScoreTrendsInput. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
filter - WithFlowOfFundsFilter!
|
Required filters for Entity Links Explorer. |
id - String!
|
ID of DataModel with Relationships. |
page - CursorPaginationForRelationshipNodes!
|
Cursor based pagination. Default = {first: 10} |
Example
{
"filter": WithFlowOfFundsFilter,
"id": "xyz789",
"page": CursorPaginationForRelationshipNodes
}
GetKeyValueInput
GetLatestKeyValuesByPrefixInput
Description
Input type of GetLatestKeyValuesByPrefix.
Fields
| Input Field | Description |
|---|---|
prefix - String!
|
Represents the first word or character(s) of key. |
Example
{"prefix": "abc123"}
GetNotesInput
Description
Input type for getting Notes by Alert ID.
Fields
| Input Field | Description |
|---|---|
alertId - String!
|
ID of Alert. |
Example
{"alertId": "xyz789"}
GetObjectInput
Description
Input type of GetObject.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Object. |
Example
{"id": "abc123"}
GetPaginatedUsersInput
Description
Input type to support Pagination requests with search queries for Users.
Fields
| Input Field | Description |
|---|---|
filter - FilterUsersInput
|
Filter for Userss. |
orderBy - OrderByInput
|
Order by Model's column/field. Default = {sort: DESC} |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{
"filter": FilterUsersInput,
"orderBy": OrderByInput,
"page": OffsetPaginationInput
}
GetPipelineFeatureInput
Description
Input type for GetPipelineFeature.
Fields
| Input Field | Description |
|---|---|
activeFlag - Boolean!
|
Indicates whether PipelineFeature is active. |
featureName - String
|
Name of PipelineFeature. |
featureType - PipelineFeatureTypes!
|
Type of PipelineFeature. |
pipelineName - String!
|
Display name of associated Pipeline. |
Example
{
"activeFlag": true,
"featureName": "abc123",
"featureType": "Aggregated",
"pipelineName": "xyz789"
}
GetPipelineFeaturesInput
GetPipelineRunsInput
Description
Input type for GetPipelines.
Fields
| Input Field | Description |
|---|---|
filter - GetPipelineRunsInputFilters
|
Filter Pipeline records. |
limit - Int
|
Limit number of Pipeline records. Default = 25 |
page - Int
|
Page number for pagination of Pipeline. Default = 0 |
Example
{
"filter": GetPipelineRunsInputFilters,
"limit": 123,
"page": 123
}
GetPipelineRunsInputFilters
Description
Input type to support Pagination requests with search queries for Pipelines.
Fields
| Input Field | Description |
|---|---|
pipelineId - String!
|
Filter Pipeline Runs records by a Pipeline id. |
status - [PipelineStatuses!]
|
Filter Pipeline Runs records by an array of PipelineStatus. |
Example
{
"pipelineId": "abc123",
"status": ["Error"]
}
GetPipelineScheduleExceptionsInput
Description
Input type for GetPipelineScheduleExceptions.
Example
{
"limit": 123,
"page": 123,
"pipelineId": "abc123",
"pipelineName": "xyz789"
}
GetPipelineScheduledRunsInput
Description
Input type to support Pagination requests with search queries for Pipelines.
Example
{
"endDate": "2007-12-03T10:15:30Z",
"pipelineId": "abc123",
"startDate": "2007-12-03T10:15:30Z"
}
GetPipelinesInput
Description
Input type for GetPipelines.
Fields
| Input Field | Description |
|---|---|
filter - GetPipelinesInputFilters
|
Filter Pipeline records. |
limit - Float
|
Limit number of Pipeline records. |
orderBy - OrderByInput
|
Sort Pipeline records. Default = {field: "createdOn", sort: ASC} |
page - Float
|
Page number for pagination of Pipeline. |
Example
{
"filter": GetPipelinesInputFilters,
"limit": 987.65,
"orderBy": OrderByInput,
"page": 123.45
}
GetPipelinesInputFilters
Description
Input type to support Pagination requests with search queries for Pipelines.
Fields
| Input Field | Description |
|---|---|
pipelineFamilyName - [String!]
|
Filter Pipeline records by a list of pipelineFamilyName. Default = [] |
Example
{"pipelineFamilyName": ["xyz789"]}
GetRelationshipsLinksViewInput
Description
Input type of GetRelationshipsLinksView. @deprecated(reason: "Replaced by RiskScoreTrendsInput. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
filter - WithRelationshipFilter!
|
Required filters for Entity Links Explorer. |
id - String!
|
ID of DataModel with Relationships. |
page - CursorPaginationForRelationshipNodes!
|
Cursor based pagination. Default = {first: 10} |
Example
{
"filter": WithRelationshipFilter,
"id": "xyz789",
"page": CursorPaginationForRelationshipNodes
}
GetRelationshipsLinksViewResponse
Description
Query response for GetRelationshipsLinksView with cursor based pagination.
Fields
| Field Name | Description |
|---|---|
attributes - JSONObject
|
Attributes of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
children - [RelationshipNode!]!
|
List directly connected Nodes. |
compositeScore - Float
|
Composite score associated with entity. |
customerData - JSONObject
|
Customer data of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
id - String!
|
ID of DataModel. |
label - String
|
Label of DataModel. |
links - [String!]!
|
IDs of bidirectionally connected Nodes. |
sourceName - String
|
Name of data source. |
subtype - String!
|
Subtype of DataModel. |
watchlistFlags - [WatchlistFlag!]!
|
Watchlist Flags. |
Example
{
"attributes": {},
"children": [RelationshipNode],
"compositeScore": 987.65,
"customerData": {},
"id": "abc123",
"label": "xyz789",
"links": ["xyz789"],
"sourceName": "abc123",
"subtype": "xyz789",
"watchlistFlags": [WatchlistFlag]
}
GetRiskRating
Description
Input type for getting a RiskRating.
Fields
| Input Field | Description |
|---|---|
id - String!
|
Label for RiskRating as unique ID. |
Example
{"id": "xyz789"}
GetRiskScoreTrends
Description
Input type of GetRiskScoreTrends. @deprecated(reason: "Replaced by RiskScoreTrendsInput. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
day - Int
|
Optional day to use as a starting point for generating a year of Risk Score Trends. |
entityId - String!
|
ID of Entity. |
month - Int
|
Optional month to use as a starting point for generating a year of Risk Score Trends. |
startDate - DateTime!
|
Specify the beginning of 12-month range to generate trends. |
year - Int!
|
Year to generate Risk Score Trends. |
Example
{
"day": 123,
"entityId": "xyz789",
"month": 123,
"startDate": "2007-12-03T10:15:30Z",
"year": 123
}
GetRoleInput
Description
User Role.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Role name. |
Example
{"name": "abc123"}
GetRule
Description
Input type of GetRule.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of Rule. |
Example
{"id": "abc123"}
GetRuleResponse
Description
Response type for GetRule.
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
Indicates whether Rule is active. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
description - String!
|
Description of Rule. |
eventType - String
|
Event type. |
id - String!
|
ID of Rule. |
name - String!
|
Name of Rule. |
rule - JSONObject!
|
Logic for Rule. |
ruleActionIds - [String!]!
|
Rule action ids associated to a Rule. |
ruleActions - [RuleAction!]
|
RuleActions associated to a Rule.
|
ruleSet - RuleSet
|
RuleSet associated with Rule
|
ruleSetId - String!
|
ID of RuleSet. |
score - Float!
|
Score of Rule. |
type - String
|
Type of Rule. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UserEntity
|
User.
|
userId - String!
|
ID of User. |
versions - [Rule!]
|
List of all Rule versions. |
Example
{
"active": true,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"eventType": "abc123",
"id": "abc123",
"name": "abc123",
"rule": {},
"ruleActionIds": ["xyz789"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "abc123",
"score": 123.45,
"type": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789",
"versions": [Rule]
}
GetRuleSetInput
Description
Input type of GetRuleSet.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of RuleSet. |
Example
{"id": "xyz789"}
GetSummarizedTransactionsByCounterpartyInput
Description
Input type of GetSummarizedTransactionsByCounterparty.
Fields
| Input Field | Description |
|---|---|
accountId - String
|
ID of Account. |
endDate - DateTime!
|
End date for transaction data. |
entityId - String!
|
ID of entity to use for transaction query. |
filterBy - EventFilter
|
Filter events by this type. Default = {} |
startDate - DateTime!
|
Start date for transaction data. |
Example
{
"accountId": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"filterBy": EventFilter,
"startDate": "2007-12-03T10:15:30Z"
}
GetSummarizedTransactionsByTypeInput
Description
Input type of GetSummarizedTransactionsByType.
Example
{
"accountId": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"startDate": "2007-12-03T10:15:30Z"
}
GetSummarizedTransactionsInput
Description
Input type of GetSummarizedTransactionsInput.
Fields
| Input Field | Description |
|---|---|
accountId - String
|
ID of Account. |
endDate - DateTime!
|
End date for transaction data. |
entityId - String!
|
ID of entity to use for transaction query. |
startDate - DateTime!
|
Start date for transaction data. |
summaryType - TransactionSummaryTypes!
|
Transaction Summary Type. |
Example
{
"accountId": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"entityId": "abc123",
"startDate": "2007-12-03T10:15:30Z",
"summaryType": "Daily"
}
GetTotalAlertsBySourceInput
Description
Input type for GetTotalAlertsBySource.
Example
{
"endDate": "2007-12-03T10:15:30Z",
"pipelineFamilyName": "abc123",
"startDate": "2007-12-03T10:15:30Z"
}
GetTrainingModelInput
GetTransactionDetailsBetweenEdgesInput
Description
Input type of GetTransactionDetailsBetweenEdges. @deprecated(reason: "Replaced by GetTransactionSummaryDetailsInput. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
filter - WithFlowOfFundsFilter!
|
Required filters for Entity Links Explorer. |
page - CursorPaginationForRelationshipNodes!
|
Cursor based pagination. Default = {first: 10} |
sourceId - String!
|
ID of first Model object for Relationship record. |
targetId - String!
|
ID of second Model object for Relationship record. |
Example
{
"filter": WithFlowOfFundsFilter,
"page": CursorPaginationForRelationshipNodes,
"sourceId": "abc123",
"targetId": "xyz789"
}
GetTransactionsThroughputInput
Description
Input type for GetTransactionsThroughput.
Example
{
"endDate": "2007-12-03T10:15:30Z",
"pipelineFamilyName": "xyz789",
"startDate": "2007-12-03T10:15:30Z"
}
GetTransactionsWithEntitiesInput
Description
Input type for GetTransactionsWithEntities.
Fields
| Input Field | Description |
|---|---|
filter - FilterInput
|
Filter for Model. Default = {endDate: null, fields: [], startDate: null} |
filterBy - EventFilter
|
Filter events by this type. Default = {} |
orderBy - OrderByInput
|
Order by Model's column/field. Default = {sort: DESC} |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
pipelineFamilyName - String
|
Name of originating Pipeline for Event with subtype transaction. |
Example
{
"filter": FilterInput,
"filterBy": EventFilter,
"orderBy": OrderByInput,
"page": OffsetPaginationInput,
"pipelineFamilyName": "abc123"
}
GetTransactionsWithEntitiesResponse
Description
Response type of GetTransactionsWithEntities.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [IntersectionEventModelWithEntityFullName!]!
|
List of IntersectionEventModelWithEntityFullNames. |
totalRecords - Int!
|
Total number of IntersectionEventModelWithEntityFullName records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [IntersectionEventModelWithEntityFullName],
"totalRecords": 987
}
GetUserInput
Description
Input type of GetUserInput.
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of User. |
Example
{"id": "abc123"}
GetUserLogHistoryInput
Description
Input type of GetUserLogHistory.
Fields
| Input Field | Description |
|---|---|
endDate - DateTime
|
Latest date from which to return the logs. |
limit - Int
|
Limit number of records. Default = 25 |
orderBy - OrderByInput
|
Specify the ordering of records in GetUserAuditPage response. Default = {field: "createdOn", sort: DESC} |
pageNumber - Int
|
Page number for pagination of Model. Default = 0 |
startDate - DateTime
|
Earliest date from which to return the logs. |
userId - String!
|
ID of User.
|
Example
{
"endDate": "2007-12-03T10:15:30Z",
"limit": 123,
"orderBy": OrderByInput,
"pageNumber": 123,
"startDate": "2007-12-03T10:15:30Z",
"userId": "xyz789"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
InitialSetupByEmail
Description
Input type of InitialSetupByEmail.
Fields
| Input Field | Description |
|---|---|
email - String!
|
Email of User. |
Example
{"email": "abc123"}
InitialSetupResponse
InstallationDetails
Description
Installation Details.
Fields
| Field Name | Description |
|---|---|
installValid - Boolean
|
Indicates whether the installation was valid. |
Example
{"installValid": true}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
IntersectionEventModelWithEntityFullName
Fields
| Field Name | Description |
|---|---|
accountWithInstitution - String
|
Account With Institution. |
accountWithInstitutionCountry - String
|
Account With Institution Country. |
baseCurrency - String
|
The base currency of the customers accounts |
beneficiaries - [EntityModel!]
|
Associated beneficiary Entity. Use beneficiariesV2 instead. Removal on v5.0.0.
|
beneficiariesV2 - BeneficiariesV2
|
Associated beneficiaries to an event. |
beneficiaryCustomer - String
|
Beneficiary customer. |
beneficiaryId - String
|
beneficiary id of Event. |
beneficiaryInstitution - String
|
Beneficiary institution. |
beneficiaryInstitutionCountry - String
|
Beneficiary institution country. |
branchId - String
|
Represents the branch id of the transaction |
buyer - String
|
Identifiers the buying party in the transaction |
cardId - String
|
Unique identifier for the card |
createdOn - DateTime
|
Created on DateTime. |
creditDebitFlag - String
|
Credit or Debit for Event. |
deletedOn - DateTime
|
Deleted on DateTime. |
destinationCountry - String
|
Destination country. |
deviceId - String
|
The id of the device |
eventDate - DateTime
|
Date of event. |
file - File
|
File associated with event. |
financialInstrumentCountry - String
|
Financial Instrument Country. |
financialInstrumentDetails - String
|
Financial Instrument Details |
financialInstrumentIsin - String
|
Financial Instrument Is in. |
financialInstrumentQuantity - Float
|
The instrument quantity involved in the transaction |
functionalAmount - Float
|
Functional amount of Event. |
functionalCurrency - String
|
Functional currency of Event. |
id - String!
|
ID of Event. |
intermediary - String
|
Intermediary. |
intermediaryCountry - String
|
Intermediary Country. |
label - String
|
Label of Event. |
orderingCustomer - String
|
Ordering customer. |
orderingInstitution - String
|
Ordering institution. |
orderingInstitutionCountry - String
|
Ordering institution country. |
originCountry - String
|
Origin country. |
originalAmount - Float
|
Original amount of Event. |
originalCurrency - String
|
Original currency of Event. |
originationDate - DateTime
|
Date the Transaction originated or date of Transaction |
originatorId - String
|
originator id of Event. |
originators - [EntityModel!]
|
Associated originator Entity. Use originatorsV2 instead. Make sure to adhere to the new schema for originatorsV2. Removal on v5.0.0.
|
originatorsV2 - OriginatorsV2
|
Associated originators to an event. |
pipelineFamilyName - String
|
pipeline family name of Event. |
postingDate - DateTime
|
Date the Transaction was posted to the account |
receiverBic - String
|
Receiving Bank Identification Code (BIC). |
receiverCorrespondent - String
|
Receiver correspondent. |
receiverCorrespondentCountry - String
|
Receiver correspondent country. |
region - String
|
Indicates whether this type of transaction is DOMESTIC, INTERNATIONAL, or - (i.e., unknown type) |
scope - String
|
The scope of the transaction. Can be EXTERNAL, CLIENT or INTERNAL |
seller - String
|
Identifiers the selling party in the transaction |
senderBic - String
|
Sender Bank Identification Code (BIC). |
senderCorrespondent - String
|
Sender correspondent. |
senderCorrespondentCountry - String
|
Sender correspondent country. |
sendingInstitution - String
|
Sending institution. |
sendingInstitutionCountry - String
|
Sending institution country. |
settlementBic - String
|
Settlement Bank Identification Code (BIC) |
settlementPlaceCountry - String
|
Settlement Place Country. |
sourceId - String
|
source id of Event. |
sourceName - String
|
Source name. |
sourceSystem - String
|
Identifier for the Source system that the Transaction came from |
sourceTable - String
|
source table name of Event. |
subtype - String!
|
Subtype of Event. |
tellerId - String
|
The teller Identification number |
transactionType - String
|
Type of transaction (e.g., wire, card, cash, etc). |
transactionTypeDescription - String
|
Description of transaction type. |
txnId - String
|
txn id of Event. |
ultimateBeneficiary - String
|
Beneficiary name of Entity for subtype 'legalEntity'. |
ultimateOriginator - String
|
Originator name of Entity for subtype 'legalEntity'. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"accountWithInstitution": "abc123",
"accountWithInstitutionCountry": "abc123",
"baseCurrency": "abc123",
"beneficiaries": [EntityModel],
"beneficiariesV2": BeneficiariesV2,
"beneficiaryCustomer": "xyz789",
"beneficiaryId": "xyz789",
"beneficiaryInstitution": "abc123",
"beneficiaryInstitutionCountry": "xyz789",
"branchId": "xyz789",
"buyer": "xyz789",
"cardId": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"creditDebitFlag": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"destinationCountry": "xyz789",
"deviceId": "abc123",
"eventDate": "2007-12-03T10:15:30Z",
"file": File,
"financialInstrumentCountry": "xyz789",
"financialInstrumentDetails": "abc123",
"financialInstrumentIsin": "xyz789",
"financialInstrumentQuantity": 987.65,
"functionalAmount": 987.65,
"functionalCurrency": "xyz789",
"id": "abc123",
"intermediary": "abc123",
"intermediaryCountry": "abc123",
"label": "xyz789",
"orderingCustomer": "abc123",
"orderingInstitution": "abc123",
"orderingInstitutionCountry": "abc123",
"originCountry": "abc123",
"originalAmount": 123.45,
"originalCurrency": "abc123",
"originationDate": "2007-12-03T10:15:30Z",
"originatorId": "xyz789",
"originators": [EntityModel],
"originatorsV2": OriginatorsV2,
"pipelineFamilyName": "xyz789",
"postingDate": "2007-12-03T10:15:30Z",
"receiverBic": "xyz789",
"receiverCorrespondent": "abc123",
"receiverCorrespondentCountry": "abc123",
"region": "abc123",
"scope": "abc123",
"seller": "xyz789",
"senderBic": "abc123",
"senderCorrespondent": "xyz789",
"senderCorrespondentCountry": "xyz789",
"sendingInstitution": "abc123",
"sendingInstitutionCountry": "xyz789",
"settlementBic": "xyz789",
"settlementPlaceCountry": "abc123",
"sourceId": "xyz789",
"sourceName": "abc123",
"sourceSystem": "abc123",
"sourceTable": "xyz789",
"subtype": "abc123",
"tellerId": "xyz789",
"transactionType": "abc123",
"transactionTypeDescription": "abc123",
"txnId": "xyz789",
"ultimateBeneficiary": "abc123",
"ultimateOriginator": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
InvalidateCache
Description
InvalidateCache.
Fields
| Field Name | Description |
|---|---|
deletedCacheObjects - Float!
|
Number of deleted cache objects. |
Example
{"deletedCacheObjects": 123.45}
InvalidateCacheInput
Description
Input type of invalidateCache
Fields
| Input Field | Description |
|---|---|
pattern - String
|
Regex to search on keys. |
Example
{"pattern": "abc123"}
ItemMetadata
Description
ItemMetadata model.
Fields
| Field Name | Description |
|---|---|
attributes - JSONObject
|
Attributes of ItemMetadata. |
createdOn - DateTime
|
Created ItemMetadata on DateTime. |
deletedOn - DateTime
|
Deleted ItemMetadata on DateTime. |
fields - JSONObject
|
Fields of ItemMetadata. |
id - String!
|
ID of ItemMetadata. |
pipelineFamilyName - String!
|
Pipeline Family of ItemMetadata. |
table - String!
|
Table for item |
type - String!
|
Type of ItemMetadata. |
updatedOn - DateTime
|
Updated ItemMetadata on DateTime. |
Example
{
"attributes": {},
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"fields": {},
"id": "xyz789",
"pipelineFamilyName": "abc123",
"table": "xyz789",
"type": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
ItemMetadataFilterRequest
Description
Input type for GetItemMetadata.
Example
{
"pipelineFamilyName": "xyz789",
"table": "abc123",
"type": "xyz789"
}
ItemTypes
Description
Enumerates the types of items indexed in Meilisearch.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCOUNTS"
ItemsMetadataFilterRequest
Description
Input type for GetItemsMetadata.
Fields
| Input Field | Description |
|---|---|
pipelineFamilyName - String
|
Filter results by pipeline family name. |
Example
{"pipelineFamilyName": "xyz789"}
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
JSONObject
Description
The JSONObject scalar type represents JSON objects as specified by ECMA-404.
Example
{}
JobStatusPayload
JobType
Description
Represents the type of job.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Detection"
K8sNodeOperatingSystem
Description
Describes the operating system of a Kubernetes node.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"linux"
KeyValueType
Description
Data transfer object of KeyValue (i.e., kvs).
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created KeyValue on DateTime. |
editPermissions - JSONObject
|
Permissions that have access to update a KeyValue. |
isEncrypted - Boolean!
|
Indiciates whether value of KeyValue is encrypted. |
isEnv - Boolean
|
Indiciates whether value of KeyValue is an environment variable. |
key - String!
|
Key of KeyValue. |
readPermissions - JSONObject
|
Permissions that have access to update a KeyValue. |
value - JSON
|
Value of KeyValue. |
version - String
|
Version of KeyValue as determined by updates on key. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"editPermissions": {},
"isEncrypted": true,
"isEnv": false,
"key": "abc123",
"readPermissions": {},
"value": {},
"version": "abc123"
}
KeyValuesInput
Description
Input type to support pagination requests with search queries for KeyValues.
Fields
| Input Field | Description |
|---|---|
key - String!
|
Key of KeyValue. |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
version - String
|
Version of KeyValue record as determined by updates on key. |
Example
{
"key": "xyz789",
"page": OffsetPaginationInput,
"version": "abc123"
}
LanguagePreferenceInput
LatestRiskScoreFromDataLakeFilter
Description
Filter latest risk scores from DataLake
Fields
| Input Field | Description |
|---|---|
anomalyScoreMax - Float
|
Set maximum anomaly score value for the RiskScore. |
anomalyScoreMin - Float
|
Set minimum anomaly score value for the RiskScore. |
cibScoreMax - Float
|
Set maximum CIB score value for the RiskScore. |
cibScoreMin - Float
|
Set minimum CIB score value for the RiskScore. |
compositeScoreMax - Float
|
Set maximum composite score value for the RiskScore. |
compositeScoreMin - Float
|
Set minimum composite score value for the RiskScore. |
hotspotScoreMax - Float
|
Set maximum hotspot score value for the RiskScore. |
hotspotScoreMin - Float
|
Set minimum hotspot score value for the RiskScore. |
riskScoreSource - String
|
Risk Score Source of the RiskScore. |
scoreDateEnd - DateTime
|
ScoreDate end date. |
scoreDateStart - DateTime
|
ScoreDate start date. |
similarityScoreMax - Float
|
Set maximum similarity score value for the RiskScore. |
similarityScoreMin - Float
|
Set minimum similarity score value for the RiskScore. |
Example
{
"anomalyScoreMax": 123.45,
"anomalyScoreMin": 123.45,
"cibScoreMax": 987.65,
"cibScoreMin": 123.45,
"compositeScoreMax": 987.65,
"compositeScoreMin": 987.65,
"hotspotScoreMax": 987.65,
"hotspotScoreMin": 987.65,
"riskScoreSource": "xyz789",
"scoreDateEnd": "2007-12-03T10:15:30Z",
"scoreDateStart": "2007-12-03T10:15:30Z",
"similarityScoreMax": 123.45,
"similarityScoreMin": 987.65
}
LatestRiskScoresFilter
Description
Filter LatestRiskScores.
Fields
| Input Field | Description |
|---|---|
anomalyScoreMax - Float
|
Set maximum anomaly score value for the RiskScore. |
anomalyScoreMin - Float
|
Set minimum anomaly score value for the RiskScore. |
cibScoreMax - Float
|
Set maximum CIB score value for the RiskScore. |
cibScoreMin - Float
|
Set minimum CIB score value for the RiskScore. |
compositeScoreMax - Float
|
Set maximum composite score value for the RiskScore. |
compositeScoreMin - Float
|
Set minimum composite score value for the RiskScore. |
hotspotScoreMax - Float
|
Set maximum hotspot score value for the RiskScore. |
hotspotScoreMin - Float
|
Set minimum hotspot score value for the RiskScore. |
riskScoreSource - String
|
Risk Score Source of the RiskScore. |
scoreDateEnd - DateTime
|
ScoreDate end date. |
scoreDateStart - DateTime
|
ScoreDate start date. |
similarityScoreMax - Float
|
Set maximum similarity score value for the RiskScore. |
similarityScoreMin - Float
|
Set minimum similarity score value for the RiskScore. |
Example
{
"anomalyScoreMax": 123.45,
"anomalyScoreMin": 987.65,
"cibScoreMax": 123.45,
"cibScoreMin": 987.65,
"compositeScoreMax": 987.65,
"compositeScoreMin": 123.45,
"hotspotScoreMax": 123.45,
"hotspotScoreMin": 123.45,
"riskScoreSource": "xyz789",
"scoreDateEnd": "2007-12-03T10:15:30Z",
"scoreDateStart": "2007-12-03T10:15:30Z",
"similarityScoreMax": 123.45,
"similarityScoreMin": 123.45
}
LatestRiskScoresFromDataLakeInput
Description
Input type of latestRiskScoresFromDataLake.
Fields
| Input Field | Description |
|---|---|
entityId - String
|
ID of the Entity. |
filterBy - LatestRiskScoreFromDataLakeFilter
|
Filter Latest Risk Scores. Default = {} |
limit - Int
|
Limit number of records. Default = 25 |
orderBy - OrderByInput
|
Specify the ordering of records in latestRiskScores response. Default = {field: "entityId", sort: ASC} |
pageNumber - Int
|
Page number for pagination of Model. Default = 0 |
Example
{
"entityId": "xyz789",
"filterBy": LatestRiskScoreFromDataLakeFilter,
"limit": 123,
"orderBy": OrderByInput,
"pageNumber": 987
}
LatestRiskScoresInput
Description
Input type of latestRiskScores.
Fields
| Input Field | Description |
|---|---|
entityId - String
|
ID of the Entity. |
filterBy - LatestRiskScoresFilter
|
Filter Latest Risk Scores. Default = {} |
limit - Int
|
Limit number of records. Default = 25 |
orderBy - OrderByInput
|
Specify the ordering of records in latestRiskScores response. Default = {field: "entityId", sort: ASC} |
pageNumber - Int
|
Page number for pagination of Model. Default = 0 |
Example
{
"entityId": "xyz789",
"filterBy": LatestRiskScoresFilter,
"limit": 123,
"orderBy": OrderByInput,
"pageNumber": 123
}
LegacyCursorPageInfo
Description
Information about pagination in a connection.
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
LibraryAttributesColumnType
Description
Defines the data types for library attribute columns.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE"
LinkedAccount
Description
LinkedNode for Account data.
Fields
| Field Name | Description |
|---|---|
accountBalance - Float
|
Account balance. |
accountBalanceUpdatedOn - DateTime
|
It is the date in which Account balance was last updated |
accountCurrency - String
|
Account currency |
accountNumber - String
|
Account number (if this object represents an account; type = account) |
accountType - String
|
Account type |
id - String!
|
ID of Node. |
isExpandable - Boolean!
|
Expandable status of LinkedNode. |
links - [String!]!
|
IDs of bi-directionally connected LinkedNode. |
rootId - String!
|
Root Id (Entity Id) of LinkedNode. |
subtype - String!
|
Subtype of LinkedNode. |
Example
{
"accountBalance": 123.45,
"accountBalanceUpdatedOn": "2007-12-03T10:15:30Z",
"accountCurrency": "xyz789",
"accountNumber": "xyz789",
"accountType": "abc123",
"id": "abc123",
"isExpandable": true,
"links": ["abc123"],
"rootId": "xyz789",
"subtype": "xyz789"
}
LinkedEntity
Description
LinkedNode for Entity data.
Fields
| Field Name | Description |
|---|---|
annualIncome - Float
|
Annual income of Event. |
businessUnit - String
|
Business unit for Entity. |
countryOfResidence - String
|
Country of residence for Entity. |
createdOn - DateTime
|
Created on DateTime. |
customerSegment - String
|
Customer segment of Entity. |
deletedOn - DateTime
|
Deleted on DateTime. |
email - String
|
Email address of Entity. |
entityType - String
|
Type of Entity. |
externalEntityId - String
|
External entity id of associated Entity. |
file - File
|
File associated with Entity.
|
fullAddress - String
|
Full address of Entity. |
fullName - String
|
Full name of Entity. |
furtherInformation - String
|
Further information of Entity. |
id - String!
|
ID of Node. |
isExpandable - Boolean!
|
Expandable status of LinkedNode. |
label - String
|
Label of Entity. |
links - [String!]!
|
IDs of bi-directionally connected LinkedNode. |
onboardDate - DateTime
|
Onboard date of Entity. |
orgUnitCode - String
|
Org unit code of Entity. |
overallRiskScore - Float
|
Overall risk score for Entity. |
phone - String
|
Phone number of Entity. |
pipelineFamilyName - String
|
pipeline family name of Entity. |
rootId - String!
|
Root Id (Entity Id) of LinkedNode. |
sourceId - String
|
source id of Entity. |
sourceName - String
|
Source name. |
sourceTable - String
|
Source table name of Entity. |
subtype - String!
|
Subtype of LinkedNode. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"annualIncome": 987.65,
"businessUnit": "xyz789",
"countryOfResidence": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"customerSegment": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "abc123",
"entityType": "xyz789",
"externalEntityId": "abc123",
"file": File,
"fullAddress": "xyz789",
"fullName": "abc123",
"furtherInformation": "xyz789",
"id": "abc123",
"isExpandable": true,
"label": "abc123",
"links": ["abc123"],
"onboardDate": "2007-12-03T10:15:30Z",
"orgUnitCode": "abc123",
"overallRiskScore": 987.65,
"phone": "abc123",
"pipelineFamilyName": "abc123",
"rootId": "abc123",
"sourceId": "xyz789",
"sourceName": "abc123",
"sourceTable": "abc123",
"subtype": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
LinkedMatch
Description
LinkedNode for matched data between Entities.
Fields
| Field Name | Description |
|---|---|
id - String!
|
ID of Node. |
isExpandable - Boolean!
|
Expandable status of LinkedNode. |
links - [String!]!
|
IDs of bi-directionally connected LinkedNode. |
matches - [String!]!
|
Matched Entity fields. |
rootId - String!
|
Root Id (Entity Id) of LinkedNode. |
subtype - String!
|
Subtype of LinkedNode. |
Example
{
"id": "xyz789",
"isExpandable": false,
"links": ["abc123"],
"matches": ["xyz789"],
"rootId": "abc123",
"subtype": "xyz789"
}
LinkedNodeData
Types
| Union Types |
|---|
Example
LinkedAccount
LinkedTransactionSummary
Description
LinkedNode for TransactionSummary data.
Fields
| Field Name | Description |
|---|---|
id - String!
|
ID of Node. |
isExpandable - Boolean!
|
Expandable status of LinkedNode. |
links - [String!]!
|
IDs of bi-directionally connected LinkedNode. |
rootId - String!
|
Root Id (Entity Id) of LinkedNode. |
subtype - String!
|
Subtype of LinkedNode. |
totalAmount - Float!
|
Total transaction amount between Nodes. |
Example
{
"id": "abc123",
"isExpandable": true,
"links": ["xyz789"],
"rootId": "abc123",
"subtype": "xyz789",
"totalAmount": 987.65
}
LogFileLocation
Logic
Fields
| Field Name | Description |
|---|---|
field - String!
|
Field name to apply the filter. |
id - String!
|
Field id of the filter`. |
operator - String!
|
Which operator is going to be used: >, <, >=, <=, ==, != . |
type - String!
|
Field type to apply filter for type of condition. |
value - JSON!
|
Field value to apply the filter. |
Example
{
"field": "xyz789",
"id": "xyz789",
"operator": "xyz789",
"type": "abc123",
"value": {}
}
LogicInput
Fields
| Input Field | Description |
|---|---|
field - String!
|
Field name to apply the filter. |
id - String!
|
Field id of the filter`. |
operator - String!
|
Which operator is going to be used: >, <, >=, <=, ==, != . |
type - String!
|
Field type to apply filter for type of condition. |
value - JSON!
|
Field value to apply the filter. |
Example
{
"field": "xyz789",
"id": "abc123",
"operator": "xyz789",
"type": "xyz789",
"value": {}
}
LoginCode
Description
Login code model.
Fields
| Field Name | Description |
|---|---|
code - Float!
|
LoginCode to authenticate User.
|
createDate - DateTime!
|
Created LoginCode on DateTime. |
email - String!
|
Email address associated with LoginCode. |
user - UserEntity
|
User associated with LoginCode.
|
Example
{
"code": 123.45,
"createDate": "2007-12-03T10:15:30Z",
"email": "xyz789",
"user": UserEntity
}
LoginCodeResponseObject
Description
Response type for GenerateLoginCode.
Example
{
"appMode": "xyz789",
"refreshToken": "abc123",
"samlCallbackUrl": "xyz789",
"success": true,
"token": "abc123"
}
LoginInput
MockRuleSet
Example
{
"entity_name": "abc123",
"id": "xyz789",
"label": "abc123",
"pipelines": ["abc123"],
"rule_name": "abc123",
"rule_performance": 123.45,
"score": 987.65
}
MonthHighlights
Description
Monthly highlights for Alert.
Example
{
"label": "xyz789",
"lastMonth": 123.45,
"thisMonth": 987.65,
"type": "xyz789"
}
NatureType
Description
Indicates the severity of system alerts.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Error"
NodeStatus
Description
Describes the current status of nodes in the system, indicating whether any action is required or if the node is running normally.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ActionRequired"
NodeTypes
Description
Defines the different types of nodes.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALERT"
NotificationStatus
Description
Tracks the processing state of notifications.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
ObjectModel
Description
Object type for Object.
Fields
| Field Name | Description |
|---|---|
accountBalance - Float
|
Account balance. |
accountBalanceUpdatedOn - DateTime
|
It is the date in which Account balance was last updated |
accountCurrency - String
|
Account currency |
accountNumber - String
|
Account number (if this object represents an account; type = account) |
accountSegment - String
|
Account segment |
accountType - String
|
Account type |
attributes - String
|
Account number of this object of subtype 'account'. Use account number stored in the attributes field. Removal on v5.0.0. |
createdOn - DateTime
|
Created on DateTime. |
customerData - JSONObject
|
Customer data of Object. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
deletedOn - DateTime
|
Deleted on DateTime. |
file - File
|
File associated with object. |
id - String!
|
ID of Object. |
label - String
|
Label of Object. |
pipelineFamilyName - String
|
pipeline family name of Object. |
sourceId - String
|
source id of Object. |
sourceName - String
|
Source name. |
sourceTable - String
|
source table name of Object. |
subtype - String!
|
Subtype of Object. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"accountBalance": 123.45,
"accountBalanceUpdatedOn": "2007-12-03T10:15:30Z",
"accountCurrency": "xyz789",
"accountNumber": "xyz789",
"accountSegment": "xyz789",
"accountType": "xyz789",
"attributes": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"customerData": {},
"deletedOn": "2007-12-03T10:15:30Z",
"file": File,
"id": "abc123",
"label": "xyz789",
"pipelineFamilyName": "xyz789",
"sourceId": "xyz789",
"sourceName": "xyz789",
"sourceTable": "xyz789",
"subtype": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
OffsetPaginationInput
OffsetPaginationInputNoMaxLimit
OidcLoginInput
Description
Input type of OIDC Login.
Fields
| Input Field | Description |
|---|---|
code - String!
|
Code from OIDC provider. |
Example
{"code": "abc123"}
OidcUrl
Description
Login to authenticate a User.
Fields
| Field Name | Description |
|---|---|
loginUrl - String!
|
Login URL to ask user credentials and grant access. |
Example
{"loginUrl": "abc123"}
OrderByInput
OriginatorOrBeneficiaryAccount
Description
Account data associated with the originator or beneficiary.
Fields
| Field Name | Description |
|---|---|
id - StringObject
|
ID of Account. |
sourceId - StringObject
|
source id of Account. |
Example
{
"id": StringObject,
"sourceId": StringObject
}
OriginatorsV2
Description
Represents associated originators with event data.
Fields
| Field Name | Description |
|---|---|
account - Account
|
Account data associated with the originator. |
entities - [EntityModel!]
|
Details of entities related to the originator. |
Example
{
"account": Account,
"entities": [EntityModel]
}
PageInfo
Fields
| Field Name | Description |
|---|---|
endCursor - Float
|
End cursor. New object type will be created to support cursor based pagination. Removal on v5.0.0. |
hasNextPage - Boolean!
|
|
hasPreviousPage - Boolean!
|
|
startCursor - Float
|
Start cursor. New object type will be created to support cursor based pagination. Removal on v5.0.0. |
Example
{
"endCursor": 123.45,
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": 123.45
}
PaginatedEntityTrades
Description
Paginated query response from GetEntityTrades.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [GetEntityTradesResponse!]!
|
List of GetEntityTradesResponses. |
totalRecords - Int!
|
Total number of GetEntityTradesResponse records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [GetEntityTradesResponse],
"totalRecords": 987
}
PaginatedEvents
Description
Query response from GetEvents.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [EventModel!]!
|
List of EventModels. |
totalRecords - Int!
|
Total number of EventModel records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [EventModel],
"totalRecords": 123
}
PaginatedFileStatuses
Description
Query response from GetFileStatuses.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [FileStatus!]!
|
List of FileStatuss. |
totalRecords - Int!
|
Total number of FileStatus records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [FileStatus],
"totalRecords": 123
}
PaginatedPipelineRuns
Description
Query response from GetPipelines.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [PipelineRun!]!
|
List of PipelineRuns. |
totalRecords - Int!
|
Total number of PipelineRun records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [PipelineRun],
"totalRecords": 123
}
PaginatedPipelineScheduleExceptions
Description
Query response from GetPipelineScheduleExceptions.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [PipelineScheduleException!]!
|
List of PipelineScheduleExceptions. |
totalRecords - Int!
|
Total number of PipelineScheduleException records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [PipelineScheduleException],
"totalRecords": 987
}
PaginatedPipelines
Description
Query response from GetPipelines.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [PipelineDetailDto!]!
|
List of PipelineDetailDtos. |
totalRecords - Int!
|
Total number of PipelineDetailDto records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [PipelineDetailDto],
"totalRecords": 123
}
PaginatedRelationshipsLinksView
Description
Base Query response for Entity Links Explorer with cursor based pagination. @deprecated(reason: "Replaced by GetRelationshipsLinks. Removal on v5.0.0.")
Fields
| Field Name | Description |
|---|---|
attributes - JSONObject
|
Attributes of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
children - [RelationshipNode!]!
|
List directly connected Nodes. |
compositeScore - Float
|
Composite score associated with entity. |
customerData - JSONObject
|
Customer data of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
id - String!
|
ID of DataModel. |
label - String
|
Label of DataModel. |
pageInfo - RelationshipPageInfo!
|
Cursor page metadata. |
sourceName - String
|
Name of data source. |
subtype - String!
|
Subtype of DataModel. |
watchlistFlags - [WatchlistFlag!]!
|
Watchlist Flags. |
Example
{
"attributes": {},
"children": [RelationshipNode],
"compositeScore": 123.45,
"customerData": {},
"id": "xyz789",
"label": "xyz789",
"pageInfo": RelationshipPageInfo,
"sourceName": "xyz789",
"subtype": "xyz789",
"watchlistFlags": [WatchlistFlag]
}
PaginatedTrades
Description
Paginated query response from GetTrades.
Fields
| Field Name | Description |
|---|---|
pageInfo - CursorPageInfo!
|
Cursor page metadata. |
records - [TradesResponse!]!
|
List of TradesResponses. |
totalCount - Int!
|
Total number of TradesResponse records that can be returned. |
Example
{
"pageInfo": CursorPageInfo,
"records": [TradesResponse],
"totalCount": 123
}
PaginatedTransactionDetails
Description
Query response for GetTransactionDetailsBetweenEdges. @deprecated(reason: "Replaced by DataModelEdge pagination. Removal on v5.0.0.")
Fields
| Field Name | Description |
|---|---|
pageInfo - RelationshipPageInfo!
|
Cursor page metadata. |
records - [RelationshipNodeWithoutLinks!]!
|
Events of subtype 'transaction' associated by adjacent Object`s of subtype 'account'. |
Example
{
"pageInfo": RelationshipPageInfo,
"records": [RelationshipNodeWithoutLinks]
}
PaginatedUsers
PaginationWithSystemIssuesInput
Description
Input type of SystemIssues.
Fields
| Input Field | Description |
|---|---|
filter - SystemIssuesFilter
|
Custom filter for System Issues. |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{
"filter": SystemIssuesFilter,
"page": OffsetPaginationInput
}
Pipeline
Description
Pipeline DTO.
Fields
| Field Name | Description |
|---|---|
config - JSONObject
|
Config of Pipeline. |
createdOn - DateTime
|
Created on DateTime. |
creator - UserEntity
|
User that created this Pipeline record.`
|
deletedOn - DateTime
|
Deleted on DateTime. |
dependencies - String
|
Dependencies of Pipeline as comma-delimited string. |
description - String
|
Description of Pipeline. |
displayName - String
|
Display name of Pipeline. Replaced by pipelineId. Removal on v5.0.0.
|
featureSchedule - String
|
Feature Schedule of Pipeline. |
id - String!
|
ID of Pipeline. |
label - String!
|
User friendly label name for Pipeline. |
pipelineStatus - [PipelineStatusModel!]
|
Pipeline run statuses |
ruleSets - [RuleSet!]
|
All RuleSets associated with Pipeline.` |
systemName - String
|
System name of Pipeline. Replaced by id. Removal on v5.0.0.
|
triggeringFrequency - String
|
Trigger frequency (Daily, Weekly, Monthly) calculated from cron expression present on featureSchedule field. |
type - PipelineType
|
Type of Pipeline. |
updatedOn - DateTime
|
Updated on DateTime. |
updater - UserEntity
|
User that updated this Pipeline record.
|
Example
{
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": "xyz789",
"description": "abc123",
"displayName": "abc123",
"featureSchedule": "xyz789",
"id": "abc123",
"label": "xyz789",
"pipelineStatus": [PipelineStatusModel],
"ruleSets": [RuleSet],
"systemName": "abc123",
"triggeringFrequency": "xyz789",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updater": UserEntity
}
PipelineConfigStatus
Description
Pipeline Config status.
Example
{"dataSource": true, "featureSets": true, "mlModels": false, "ruleSets": true}
PipelineDependencyDto
Description
Pipeline Dependency DTO.
Example
{
"displayName": "xyz789",
"id": "xyz789",
"label": "abc123"
}
PipelineDetailDto
Description
Pipeline DTO.
Fields
| Field Name | Description |
|---|---|
config - JSONObject
|
Config of Pipeline. |
createdOn - DateTime
|
Created on DateTime. |
creator - UserEntity
|
User that created this Pipeline record.`
|
deletedOn - DateTime
|
Deleted on DateTime. |
dependencies - [PipelineDependencyDto!]
|
Array of Pipeline dependencies. |
description - String
|
Description of Pipeline. |
displayName - String
|
Display name of Pipeline. Replaced by pipelineId. Removal on v5.0.0.
|
featureSchedule - String
|
Feature Schedule of Pipeline. |
id - String!
|
ID of Pipeline. |
label - String!
|
User friendly label name for Pipeline. |
pipelineConfigStatus - PipelineConfigStatus
|
Status of pipeline configuration |
pipelineFamilyName - String!
|
Family name of Pipeline. |
pipelineStatus - PipelineStatus
|
Latest pipeline status record |
ruleSets - [RuleSet!]
|
Rule Sets connected to pipeline |
systemName - String
|
System name of Pipeline. Replaced by id. Removal on v5.0.0.
|
triggeringFrequency - String!
|
Triggering frequency of Pipeline (e.g. Daily, Weekly, Monthly). |
type - PipelineType
|
Type of Pipeline. |
updatedOn - DateTime
|
Updated on DateTime. |
updater - UserEntity
|
User that updated this Pipeline record.
|
Example
{
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creator": UserEntity,
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": [PipelineDependencyDto],
"description": "xyz789",
"displayName": "abc123",
"featureSchedule": "abc123",
"id": "xyz789",
"label": "abc123",
"pipelineConfigStatus": PipelineConfigStatus,
"pipelineFamilyName": "xyz789",
"pipelineStatus": PipelineStatus,
"ruleSets": [RuleSet],
"systemName": "xyz789",
"triggeringFrequency": "abc123",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updater": UserEntity
}
PipelineFamilyNames
Description
Query response from getPipelineFamilyNames.
Fields
| Field Name | Description |
|---|---|
names - [String!]!
|
Names of Pipeline Families. |
Example
{"names": ["abc123"]}
PipelineFamilyNamesOrderByFields
Description
Fields by which pipeline family names can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"Name"
PipelineFamilyNamesOrderByInput
Description
Input type to support ordering for getting pipeline family names.
Fields
| Input Field | Description |
|---|---|
field - PipelineFamilyNamesOrderByFields
|
Ordering options for pipeline family names. Default = Name |
sort - Sort
|
The ordering direction. Default = DESC |
Example
{"field": "Name", "sort": "ASC"}
PipelineFeatureModel
Description
Representation of PipelineFeature.
Fields
| Field Name | Description |
|---|---|
activeFlag - Boolean!
|
Indicates whether PipelineFeature is active. |
config - JSONObject
|
Config of PipelineFeature. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
featureName - String
|
Name of PipelineFeature. |
featureType - String!
|
Type of PipelineFeature. |
id - String!
|
ID of PipelineFeature. |
pipelineName - String!
|
Display name of associated Pipeline. Will be replaced by pipelineId. Removal on v5.0.0.
|
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"activeFlag": false,
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"featureName": "abc123",
"featureType": "abc123",
"id": "abc123",
"pipelineName": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
PipelineFeatureResponse
Description
Input type for GetPipelineFeature.
Fields
| Field Name | Description |
|---|---|
activeFlag - Boolean!
|
Indicates whether PipelineFeature is active. |
config - JSONObject
|
Config of PipelineFeature. |
featureName - String
|
Name of PipelineFeature. |
featureType - String!
|
Type of PipelineFeature. |
pipelineName - String!
|
Display name of associated Pipeline. Will be replaced by pipelineId. Removal on v5.0.0.
|
Example
{
"activeFlag": true,
"config": {},
"featureName": "abc123",
"featureType": "xyz789",
"pipelineName": "abc123"
}
PipelineFeatureTypes
Description
Identifies the types of features that can be processed within a pipeline.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Aggregated"
PipelineInput
Description
Input type of CreatePipeline.
Fields
| Input Field | Description |
|---|---|
config - JSONObject
|
Config of Pipeline. |
dependencies - String
|
Dependencies of Pipeline as comma-delimited string. |
description - String
|
Description of Pipeline. |
displayName - String
|
Display name of Pipeline. |
featureSchedule - String
|
Feature Schedule of Pipeline. |
id - String
|
ID of Pipeline. |
label - String
|
User friendly label name for Pipeline. |
ruleSetId - String
|
ID of RuleSet associated with Pipeline. |
systemName - String
|
System name of Pipeline. |
triggeringFrequency - String
|
Trigger frequency (Daily, Weekly, Monthly) calculated from cron expression present on featureSchedule field. |
type - PipelineType
|
Type of Pipeline. Default = Generic |
Example
{
"config": {},
"dependencies": "xyz789",
"description": "abc123",
"displayName": "xyz789",
"featureSchedule": "xyz789",
"id": "xyz789",
"label": "abc123",
"ruleSetId": "abc123",
"systemName": "xyz789",
"triggeringFrequency": "xyz789",
"type": "Data"
}
PipelineModel
Description
Representation of Pipeline.
Fields
| Field Name | Description |
|---|---|
config - JSONObject
|
Config of Pipeline. |
createdOn - DateTime
|
Created on DateTime. |
creatorId - String
|
ID of User that created this Pipeline record. |
deletedOn - DateTime
|
Deleted on DateTime. |
dependencies - String
|
Dependencies of Pipeline as comma-delimited string. |
description - String
|
Description of Pipeline. |
displayName - String
|
Display name of Pipeline. Replaced by pipelineId. Removal on v5.0.0.
|
featureSchedule - String
|
Feature Schedule of Pipeline. |
id - String!
|
ID of Pipeline. |
isDisabled - Boolean!
|
Indicates whether Pipeline is no longer in use. |
label - String!
|
User friendly label name for Pipeline. |
pipelineStatus - [PipelineStatusModel!]
|
Pipeline run statuses |
systemName - String
|
System name of Pipeline. Replaced by id. Removal on v5.0.0.
|
triggeringFrequency - String
|
Trigger frequency (Daily, Weekly, Monthly) calculated from cron expression present on featureSchedule field. |
type - PipelineType
|
Type of Pipeline. |
updatedOn - DateTime
|
Updated on DateTime. |
updaterId - String
|
ID of User that updated this Pipeline record. |
Example
{
"config": {},
"createdOn": "2007-12-03T10:15:30Z",
"creatorId": "abc123",
"deletedOn": "2007-12-03T10:15:30Z",
"dependencies": "abc123",
"description": "abc123",
"displayName": "xyz789",
"featureSchedule": "xyz789",
"id": "abc123",
"isDisabled": false,
"label": "abc123",
"pipelineStatus": [PipelineStatusModel],
"systemName": "xyz789",
"triggeringFrequency": "abc123",
"type": "Data",
"updatedOn": "2007-12-03T10:15:30Z",
"updaterId": "xyz789"
}
PipelineRun
Description
PipelineRun DTO.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
duration - String
|
Pipeline duration formatted as ISO Time (i.e. HH:MM:SS). |
finishTime - DateTime
|
Pipeline end execution time. |
hasLogsFile - Boolean!
|
Task run has Logs file (MinIO). |
logPath - String
|
Location of the pipeline run log files in MinIO. |
message - String
|
PipelineRun message. |
pipelineId - String!
|
ID of Pipeline. |
pipelineStatus - [PipelineStatuses!]
|
PipelineRun statuses. |
runId - ID!
|
Run ID of Pipeline. |
startTime - DateTime
|
Pipeline start execution time. |
status - PipelineStatuses!
|
`PipelineRun Status. |
statuses - [PipelineStatusModel!]!
|
Statuses of Pipeline Run. |
step - String!
|
PipelineRun Step. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"duration": "abc123",
"finishTime": "2007-12-03T10:15:30Z",
"hasLogsFile": false,
"logPath": "xyz789",
"message": "abc123",
"pipelineId": "xyz789",
"pipelineStatus": ["Error"],
"runId": "4",
"startTime": "2007-12-03T10:15:30Z",
"status": "Error",
"statuses": [PipelineStatusModel],
"step": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
PipelineScheduleException
Description
Representation of PipelineScheduleExceptionModel.
Fields
| Field Name | Description |
|---|---|
action - String!
|
Action of PipelineScheduleException. |
batchId - String!
|
Batch ID of PipelineScheduleException. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of Pipeline. |
newDateTime - DateTime!
|
New Date Time of PipelineScheduleException. |
oldDateTime - DateTime!
|
Old Date Time of PipelineScheduleException. |
pipelineId - String!
|
Pipeline ID of PipelineScheduleException. |
pipelineName - String
|
Name of Pipeline. Replaced by pipelineId. Removal on v5.0.0.
|
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"action": "xyz789",
"batchId": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"newDateTime": "2007-12-03T10:15:30Z",
"oldDateTime": "2007-12-03T10:15:30Z",
"pipelineId": "abc123",
"pipelineName": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
PipelineScheduleExceptionInput
Description
Input type of PipelineScheduleExceptionInput.
Fields
| Input Field | Description |
|---|---|
action - PipelineScheduleExceptions!
|
Action of PipelineScheduleException. |
batchId - String!
|
Batch ID of PipelineScheduleException. |
id - String
|
ID of PipelineScheduleException. |
newDateTime - DateTime!
|
New Date Time of PipelineScheduleException. |
oldDateTime - DateTime!
|
Old Date Time of PipelineScheduleException. |
pipelineId - String!
|
Pipeline ID of PipelineScheduleException. |
pipelineName - String
|
Name of Pipeline. |
Example
{
"action": "Add",
"batchId": "xyz789",
"id": "abc123",
"newDateTime": "2007-12-03T10:15:30Z",
"oldDateTime": "2007-12-03T10:15:30Z",
"pipelineId": "abc123",
"pipelineName": "xyz789"
}
PipelineScheduleExceptions
Description
Defines the types of exceptions that can be applied to pipeline schedules.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Add"
PipelineScheduledRun
Description
PipelineScheduledRun DTO.
Fields
| Field Name | Description |
|---|---|
date - DateTime!
|
Pipeline Run execution date and time.
|
id - String!
|
ID can be a Pipeline Status ID for existing runs, or an UUID for CRON Auto Generated Schedule and Manual Exception runs. |
status - PipelineStatuses!
|
Pipeline Run status.
|
type - PipelineScheduledRunType!
|
Pipeline Run type (Manual for Pipeline Schedule Exceptions or Auto for auto-generated).
|
Example
{
"date": "2007-12-03T10:15:30Z",
"id": "abc123",
"status": "Error",
"type": "Auto"
}
PipelineScheduledRunType
Description
Specifies how a pipeline run is initiated, either automatically or manually.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Auto"
PipelineStatus
Description
PipelineStatus DTO.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
duration - String
|
Pipeline duration formatted as ISO Time (i.e. HH:MM:SS). |
finishTime - DateTime
|
Pipeline end execution time. |
id - ID!
|
ID of PipelineStatus. |
logPath - String
|
Location of the pipeline run log files in MinIO. |
message - String
|
Status message of Pipeline run. |
pipelineId - String!
|
Pipeline Id. |
runId - String!
|
Pipeline Run Id. |
startTime - DateTime
|
Pipeline start execution time. |
status - PipelineStatuses
|
Pipeline Status.
|
step - String!
|
Pipeline Step. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"duration": "abc123",
"finishTime": "2007-12-03T10:15:30Z",
"id": "4",
"logPath": "xyz789",
"message": "xyz789",
"pipelineId": "abc123",
"runId": "xyz789",
"startTime": "2007-12-03T10:15:30Z",
"status": "Error",
"step": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
PipelineStatusModel
Description
Representation of PipelineStatus.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
duration - String
|
Pipeline duration formatted as ISO Time (i.e. HH:MM:SS). |
finishTime - DateTime
|
Pipeline end execution time. |
id - ID!
|
ID of PipelineStatus. |
message - String
|
Status message of Pipeline run. |
pipelineId - String!
|
Pipeline Id. |
runId - String!
|
Pipeline Run Id. |
startTime - DateTime
|
Pipeline start execution time. |
status - PipelineStatuses
|
Pipeline Status.
|
step - String!
|
Pipeline Step. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"duration": "xyz789",
"finishTime": "2007-12-03T10:15:30Z",
"id": "4",
"message": "xyz789",
"pipelineId": "abc123",
"runId": "xyz789",
"startTime": "2007-12-03T10:15:30Z",
"status": "Error",
"step": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
PipelineStatuses
Description
Represents the current status of a pipeline run.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Error"
PipelineType
Description
Defines the different types of pipelines.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Data"
Pod
Description
Represents a Kubernetes Pod.
Fields
| Field Name | Description |
|---|---|
name - String!
|
Unique name of Pod. |
status - PodStatus!
|
Current status of Pod (e.g., Running, Pending, or Failed). |
type - PodType!
|
Describes the functional role of the Pod within the system. |
version - String!
|
Version of Pod. |
Example
{
"name": "abc123",
"status": "Failed",
"type": "Analytics",
"version": "xyz789"
}
PodInput
Description
Input type of pod.
Fields
| Input Field | Description |
|---|---|
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
podName - String!
|
Unique name of Pod. |
Example
{
"page": OffsetPaginationInput,
"podName": "xyz789"
}
PodResponse
Description
Response type for Query.pod.
Fields
| Field Name | Description |
|---|---|
databases - [Database!]
|
Kubernetes Databases info (for type='database' Pods) |
folders - [FileStorage!]
|
Kubernetes File Storage info (for type='fileStorage' Pods) |
name - String!
|
Unique name of Pod. |
status - PodStatus!
|
Current status of Pod (e.g., Running, Pending, or Failed). |
topics - [Topic!]
|
Kubernetes Analytics info (for type='analytics' Pods) |
totalRecords - Float
|
Field to track pagination for databases, folders and topics. |
type - PodType!
|
Describes the functional role of the Pod within the system. |
version - String!
|
Version of Pod. |
Example
{
"databases": [Database],
"folders": [FileStorage],
"name": "abc123",
"status": "Failed",
"topics": [Topic],
"totalRecords": 123.45,
"type": "Analytics",
"version": "xyz789"
}
PodStatus
Description
Describes the current lifecycle phase of pods in the system.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Failed"
PodType
Description
Classifies pods by their functional role within the infrastructure.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Analytics"
PodsInput
Description
Input type for system node.
Fields
| Input Field | Description |
|---|---|
nodeName - String
|
Node name. |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{
"nodeName": "xyz789",
"page": OffsetPaginationInput
}
PodsResponse
Description
List of pods, can be filtered by node name.
Example
{
"pageInfo": PageInfo,
"records": [Pod],
"totalRecords": 123
}
ReindexNodesInput
Description
Input type of ReindexNodes.
Fields
| Input Field | Description |
|---|---|
nodeTypes - [NodeTypes!]
|
Provide list of NodeTypes for Meilisearch to trigger reindexing (defaults to all). Default = [] |
Example
{"nodeTypes": ["ALERT"]}
ReindexNodesResponse
RelationshipCursorType
Description
Cursor of Relationship. @deprecated(reason: "Replaced by LinkedNode. Removal on v5.0.0.")
Example
{
"sourceId": "xyz789",
"targetId": "xyz789"
}
RelationshipCursorTypeInput
Description
Input type of Relationship cursor for pagination. @deprecated(reason: "Pagination replaced by GetRelationshipsLinks. Removal on v5.0.0.")
Example
{
"sourceId": "xyz789",
"targetId": "xyz789"
}
RelationshipFiltersInput
Description
Input Filters of relationshipsLinks.
Fields
| Input Field | Description |
|---|---|
fields - [RelationshipsFields!]
|
List of Entity attributes to filter by. Default = [] |
Example
{"fields": ["EMAIL"]}
RelationshipNode
Description
Object type of "DataModel" for GetRelationshipsLinksView. @deprecated(reason: "Replaced by LinkedNode. Removal on v5.0.0.")
Fields
| Field Name | Description |
|---|---|
attributes - JSONObject
|
Attributes of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
compositeScore - Float
|
Composite score associated with entity. |
customerData - JSONObject
|
Customer data of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
id - String!
|
ID of DataModel. |
label - String
|
Label of DataModel. |
links - [String!]!
|
IDs of bidirectionally connected Nodes. |
sourceName - String
|
Name of data source. |
subtype - String!
|
Subtype of DataModel. |
watchlistFlags - [WatchlistFlag!]!
|
Watchlist Flags. |
Example
{
"attributes": {},
"compositeScore": 987.65,
"customerData": {},
"id": "xyz789",
"label": "xyz789",
"links": ["abc123"],
"sourceName": "abc123",
"subtype": "abc123",
"watchlistFlags": [WatchlistFlag]
}
RelationshipNodeWithoutLinks
Description
Object type of "DataModel" for GetTransactionDetailsBetweenEdges. @deprecated(reason: "Replaced by LinkedNode connections. Removal on v5.0.0.")
Fields
| Field Name | Description |
|---|---|
attributes - JSONObject
|
Attributes of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
compositeScore - Float
|
Composite score associated with entity. |
customerData - JSONObject
|
Customer data of DataModel. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
id - String!
|
ID of DataModel. |
label - String
|
Label of DataModel. |
sourceName - String
|
Name of data source. |
subtype - String!
|
Subtype of DataModel. |
watchlistFlags - [WatchlistFlag!]!
|
Watchlist Flags. |
Example
{
"attributes": {},
"compositeScore": 123.45,
"customerData": {},
"id": "abc123",
"label": "xyz789",
"sourceName": "xyz789",
"subtype": "abc123",
"watchlistFlags": [WatchlistFlag]
}
RelationshipPageInfo
Description
Cursor page metadata for Entity Links Explorer queries. @deprecated(reason: "Pagination replaced by GetRelationshipsLinks. Removal on v5.0.0.")
Fields
| Field Name | Description |
|---|---|
endCursor - RelationshipCursorType!
|
ID of last Relationship record provided. |
hasNextPage - Boolean!
|
Indicates whether more records exist. |
hasPreviousPage - Boolean!
|
Indicates whether previous records exist. |
startCursor - RelationshipCursorType!
|
ID of first Relationship record provided. |
totalConnections - Int
|
The total number of connections. |
Example
{
"endCursor": RelationshipCursorType,
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": RelationshipCursorType,
"totalConnections": 123
}
RelationshipsFields
Description
Defines the fields used to establish or describe relationships.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EMAIL"
RelationshipsLinks
Description
Response type for Relationship Links.
Fields
| Field Name | Description |
|---|---|
edges - [DataModelEdge!]!
|
Edges pointing to LinkedNode. |
isQueued - Boolean!
|
Message to indicate the status of Entity Links Explorer. |
pageInfo - PageInfo!
|
Pagination details. |
Example
{
"edges": [DataModelEdge],
"isQueued": false,
"pageInfo": PageInfo
}
RelationshipsLinksInput
Description
Input type of relationshipsLinks.
Fields
| Input Field | Description |
|---|---|
alertId - String
|
ID of Detection. |
batchDate - DateTime
|
Batch date associated to Detection. This must be provided only if alertId is NOT provided. |
entityId - String!
|
ID of Entity with Relationships. |
filterBy - RelationshipFiltersInput!
|
Filters for Entity Links Explorer. |
Example
{
"alertId": "abc123",
"batchDate": "2007-12-03T10:15:30Z",
"entityId": "xyz789",
"filterBy": RelationshipFiltersInput
}
ReportSummaryObject
Description
Report Summary Objecte.
Fields
| Field Name | Description |
|---|---|
date - String
|
Date of report row |
summary - [ReportSummaryRow!]
|
Summary of report metrics |
Example
{
"date": "abc123",
"summary": [ReportSummaryRow]
}
ReportSummaryRow
RestartPodInput
Description
Input type of restartPod.
Fields
| Input Field | Description |
|---|---|
podName - String!
|
Kubernetes Pod Name (unique identifier). |
Example
{"podName": "abc123"}
RetailBankingAttributes
Description
Attributes of Event with subtype transaction (retail banking).
Fields
| Field Name | Description |
|---|---|
counterpartyAccountNumber - String
|
Account number of Counterparty. |
counterpartyId - String
|
ID of Counterparty. |
creditDebitFlag - String!
|
Indicates whether transaction was a credit or debit. |
eventDate - String!
|
Date of subtype event. |
functionalTransactionAmount - Float
|
Amount of functional transaction. |
functionalTransactionCurrency - String
|
Currency of functional transaction. |
ledgerAccountNumber - String
|
Account number of Ledger. |
originalTransactionAmount - Float
|
Amount of original transaction. |
originalTransactionCurrency - String
|
Currency of original transaction. |
primaryPartyId - String
|
ID of primary party. |
referenceNumber - String!
|
Unique identifier of transaction. |
transactionType - String
|
Type of transaction (e.g., wire, card, cash, etc). |
Example
{
"counterpartyAccountNumber": "xyz789",
"counterpartyId": "xyz789",
"creditDebitFlag": "xyz789",
"eventDate": "abc123",
"functionalTransactionAmount": 987.65,
"functionalTransactionCurrency": "xyz789",
"ledgerAccountNumber": "xyz789",
"originalTransactionAmount": 987.65,
"originalTransactionCurrency": "xyz789",
"primaryPartyId": "abc123",
"referenceNumber": "xyz789",
"transactionType": "xyz789"
}
RiskRating
Description
RiskRating model.
Example
{
"color": "xyz789",
"deletedOn": "2007-12-03",
"displayOrder": 987.65,
"id": "xyz789",
"label": "abc123"
}
RiskRatingFieldInput
Description
Input type of riskRatings for UpdateRiskRatingsInput.
Example
{
"color": "abc123",
"displayOrder": 123.45,
"id": "abc123",
"label": "xyz789"
}
RiskScore
Description
RiskScore.
Fields
| Field Name | Description |
|---|---|
alertingFeatures - [ShapFeature!]
|
List of ShapFeatures for RiskScore. |
anomalyScore - Float
|
Anomaly score of RiskScore. |
cibScore - Float
|
CIB score of RiskScore. |
compositeScore - Float
|
Composite score of RiskScore. |
createdOn - DateTime
|
Created on DateTime. |
customerData - JSONObject
|
Customer data of RiskScore. |
deletedOn - DateTime
|
Deleted on DateTime. |
entityId - String!
|
ID of LegalEntity associated with RiskScore. |
hotspotScore - Float
|
Hotspot score of RiskScore. |
id - String!
|
ID of RiskScore. |
pipelineFamilyName - String
|
pipeline family name of RiskScore. |
riskScoreDate - Date!
|
Date of RiskScore. |
riskScoreSource - String
|
Source of RiskScore. |
similarityScore - Float
|
Similarity score of RiskScore. |
sourceId - String
|
source id of RiskScore. |
sourceTable - String
|
source table name of RiskScore. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"alertingFeatures": [ShapFeature],
"anomalyScore": 123.45,
"cibScore": 987.65,
"compositeScore": 123.45,
"createdOn": "2007-12-03T10:15:30Z",
"customerData": {},
"deletedOn": "2007-12-03T10:15:30Z",
"entityId": "xyz789",
"hotspotScore": 987.65,
"id": "abc123",
"pipelineFamilyName": "abc123",
"riskScoreDate": "2007-12-03",
"riskScoreSource": "abc123",
"similarityScore": 123.45,
"sourceId": "abc123",
"sourceTable": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
RiskScoreFromDataLakeFilter
Description
Filter risk scores from DataLake
Fields
| Input Field | Description |
|---|---|
anomalyScoreMax - Float
|
Set maximum anomaly score value for the RiskScore. |
anomalyScoreMin - Float
|
Set minimum anomaly score value for the RiskScore. |
cibScoreMax - Float
|
Set maximum CIB score value for the RiskScore. |
cibScoreMin - Float
|
Set minimum CIB score value for the RiskScore. |
compositeScoreMax - Float
|
Set maximum composite score value for the RiskScore. |
compositeScoreMin - Float
|
Set minimum composite score value for the RiskScore. |
hotspotScoreMax - Float
|
Set maximum hotspot score value for the RiskScore. |
hotspotScoreMin - Float
|
Set minimum hotspot score value for the RiskScore. |
riskScoreSource - String
|
Risk Score Source of the RiskScore. |
scoreDate - DateTime
|
Date when the score occurred. |
similarityScoreMax - Float
|
Set maximum similarity score value for the RiskScore. |
similarityScoreMin - Float
|
Set minimum similarity score value for the RiskScore. |
Example
{
"anomalyScoreMax": 987.65,
"anomalyScoreMin": 123.45,
"cibScoreMax": 123.45,
"cibScoreMin": 987.65,
"compositeScoreMax": 987.65,
"compositeScoreMin": 987.65,
"hotspotScoreMax": 123.45,
"hotspotScoreMin": 987.65,
"riskScoreSource": "xyz789",
"scoreDate": "2007-12-03T10:15:30Z",
"similarityScoreMax": 987.65,
"similarityScoreMin": 123.45
}
RiskScorePayload
Description
Represents Risk Score Trends for month in provided year.
Example
{
"count": 123,
"month": 123,
"riskScore": "abc123",
"year": 987
}
RiskScoreTrend
Description
Represents Risk Score Trends for month in provided year. @deprecated(reason: "Replaced by RiskScoreTrendPayload. Removal on v5.0.0.")
Example
{
"count": 987,
"month": 987,
"riskScore": "xyz789",
"year": 987
}
RiskScoreTrendsInput
RiskScoresFilter
Description
Filter RiskScores.
Fields
| Input Field | Description |
|---|---|
anomalyScoreMax - Float
|
Set maximum anomaly score value for the RiskScore. |
anomalyScoreMin - Float
|
Set minimum anomaly score value for the RiskScore. |
cibScoreMax - Float
|
Set maximum CIB score value for the RiskScore. |
cibScoreMin - Float
|
Set minimum CIB score value for the RiskScore. |
compositeScoreMax - Float
|
Set maximum composite score value for the RiskScore. |
compositeScoreMin - Float
|
Set minimum composite score value for the RiskScore. |
hotspotScoreMax - Float
|
Set maximum hotspot score value for the RiskScore. |
hotspotScoreMin - Float
|
Set minimum hotspot score value for the RiskScore. |
riskScoreSource - String
|
Risk Score Source of the RiskScore. |
scoreDate - DateTime
|
Date when the score occurred. |
similarityScoreMax - Float
|
Set maximum similarity score value for the RiskScore. |
similarityScoreMin - Float
|
Set minimum similarity score value for the RiskScore. |
Example
{
"anomalyScoreMax": 987.65,
"anomalyScoreMin": 987.65,
"cibScoreMax": 987.65,
"cibScoreMin": 987.65,
"compositeScoreMax": 987.65,
"compositeScoreMin": 123.45,
"hotspotScoreMax": 987.65,
"hotspotScoreMin": 987.65,
"riskScoreSource": "abc123",
"scoreDate": "2007-12-03T10:15:30Z",
"similarityScoreMax": 987.65,
"similarityScoreMin": 987.65
}
RiskScoresFromDataLakeInput
Description
Input type of RiskScoresFromDataLake.
Fields
| Input Field | Description |
|---|---|
entityId - String
|
ID of the Entity. |
filterBy - RiskScoreFromDataLakeFilter
|
Filter Risk Scores. Default = {} |
limit - Int
|
Limit number of records. Default = 25 |
orderBy - OrderByInput
|
Specify the ordering of records in riskScores response. Default = {field: "entityId", sort: ASC} |
pageNumber - Int
|
Page number for pagination of Model. Default = 0 |
Example
{
"entityId": "abc123",
"filterBy": RiskScoreFromDataLakeFilter,
"limit": 123,
"orderBy": OrderByInput,
"pageNumber": 123
}
RiskScoresInput
Description
Input type of riskScores.
Fields
| Input Field | Description |
|---|---|
entityId - String
|
ID of the Entity. |
filterBy - RiskScoresFilter
|
Filter Risk Scores. Default = {} |
limit - Int
|
Limit number of records. Default = 25 |
orderBy - OrderByInput
|
Specify the ordering of records in riskScores response. Default = {field: "entityId", sort: ASC} |
pageNumber - Int
|
Page number for pagination of Model. Default = 0 |
Example
{
"entityId": "abc123",
"filterBy": RiskScoresFilter,
"limit": 123,
"orderBy": OrderByInput,
"pageNumber": 987
}
RiskScoresPage
Description
Response type for GetAllRiskScores.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [RiskScore!]!
|
List of RiskScores. |
totalRecords - Int!
|
Total number of RiskScore records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [RiskScore],
"totalRecords": 987
}
Role
RoleOptions
Description
Specifies user roles within the system, defining access levels and permissions.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"admin"
Rule
Description
Rule DTO.
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
Indicates whether Rule is active. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
description - String!
|
Description of Rule. |
eventType - String
|
Event type. |
id - String!
|
ID of Rule. |
name - String!
|
Name of Rule. |
rule - JSONObject!
|
Logic for Rule. |
ruleActionIds - [String!]!
|
Rule action ids associated to a Rule. |
ruleActions - [RuleAction!]
|
RuleActions associated to a Rule.
|
ruleSet - RuleSet
|
RuleSet associated with Rule
|
ruleSetId - String!
|
ID of RuleSet. |
score - Float!
|
Score of Rule. |
type - String
|
Type of Rule. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UserEntity
|
User.
|
userId - String!
|
ID of User. |
Example
{
"active": true,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"eventType": "xyz789",
"id": "abc123",
"name": "abc123",
"rule": {},
"ruleActionIds": ["xyz789"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "xyz789",
"score": 123.45,
"type": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "abc123"
}
RuleAction
RuleActionModel
Description
RuleAction.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
Unique record ID for RuleAction. |
rule - Rule
|
Rule associated with RuleAction.
|
ruleActionIds - [String!]!
|
ID of RuleAction as KeyValue. |
ruleId - String!
|
ID of associated Rule with RuleAction. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"rule": Rule,
"ruleActionIds": ["abc123"],
"ruleId": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
RuleEngineEvaluateInput
Description
Input type of RuleEngineEvaluateInput.
Example
{
"end": "xyz789",
"pipelineId": "abc123",
"ruleSets": ["abc123"],
"start": "abc123"
}
RuleEngineEvaluateResponse
RuleEngineStatusResponse
Description
Response from ruleEngineEvaluate.
Fields
| Field Name | Description |
|---|---|
createdTime - String
|
Created time for rule engine evaluation. |
date - String
|
Date for rule engine evaluation. |
endDate - String
|
End date for rule engine evaluation. |
endedTime - String
|
Ended time for rule engine evaluation. |
errorMessage - String
|
Message for rule engine evaluation. |
errorType - String
|
Error type for rule engine evaluation |
errors - [String!]
|
Errors for rule engine evaluation |
generatedAlerts - JSONObject
|
Generated alerts for rule engine evaluation |
pipelineId - String
|
Pipeline id for rule engine evaluation |
redisJobId - String
|
Redis job id for rule engine evaluation |
rulesetIds - [String!]
|
Rule set ids for rule engine evaluation. |
runId - String!
|
ID for rule engine evaluation request. |
startDate - String
|
Start date for engine evaluation |
startedTime - String
|
Started time for engine evaluation |
status - String!
|
Status for rule engine evaluation. |
Example
{
"createdTime": "xyz789",
"date": "abc123",
"endDate": "abc123",
"endedTime": "xyz789",
"errorMessage": "abc123",
"errorType": "xyz789",
"errors": ["xyz789"],
"generatedAlerts": {},
"pipelineId": "abc123",
"redisJobId": "abc123",
"rulesetIds": ["xyz789"],
"runId": "abc123",
"startDate": "abc123",
"startedTime": "abc123",
"status": "abc123"
}
RuleEntity
Description
Object type representing Rule schema.
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
Indicates whether Rule is active. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
description - String!
|
Description of Rule. |
eventType - String
|
Event type. |
id - String!
|
ID of Rule. |
name - String
|
Name of Rule. |
rule - JSONObject!
|
Logic for Rule. |
ruleActionIds - [String!]!
|
Rule action ids associated to a Rule. |
ruleActions - [RuleAction!]
|
RuleActions associated to a Rule. Use ruleActionIds instead. Removal on v5.0.0.
|
ruleSet - RuleSet
|
RuleSet associated with Rule
|
ruleSetId - String
|
ID of RuleSet. |
score - Int
|
Score of Rule. |
type - String!
|
Type of Rule. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UserEntity
|
User.
|
userId - String
|
ID of User. |
Example
{
"active": true,
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"eventType": "xyz789",
"id": "abc123",
"name": "xyz789",
"rule": {},
"ruleActionIds": ["xyz789"],
"ruleActions": [RuleAction],
"ruleSet": RuleSet,
"ruleSetId": "abc123",
"score": 123,
"type": "abc123",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
RuleFlagInput
RuleLibraryAttribute
Description
Response from getRuleLibraryAttributes.
Fields
| Field Name | Description |
|---|---|
columns - [RuleLibraryAttributeColumn!]!
|
Columns for library attribute |
tableDescription - String!
|
Description for library attribute column. |
tableName - String!
|
Name for library attribute column |
Example
{
"columns": [RuleLibraryAttributeColumn],
"tableDescription": "xyz789",
"tableName": "abc123"
}
RuleLibraryAttributeColumn
Description
Response from getRuleLibraryAttributes.
Fields
| Field Name | Description |
|---|---|
description - String!
|
Description for library attribute column. |
name - String!
|
Name for library attribute column |
type - LibraryAttributesColumnType!
|
Column data type |
Example
{
"description": "abc123",
"name": "abc123",
"type": "DATE"
}
RuleLibraryAttributesResponse
Description
Response from getLibraryAttributes.
Fields
| Field Name | Description |
|---|---|
attributes - [RuleLibraryAttribute!]!
|
Library attributes. |
Example
{"attributes": [RuleLibraryAttribute]}
RuleList
Description
List of AML collection.
Fields
| Field Name | Description |
|---|---|
data - [JSONObject!]!
|
Collection of AML rules. |
displayName - String!
|
Name of the list as it appears in List Management. |
name - String!
|
Name of list as it appears from source. |
pipelineFamilyName - String!
|
Name of pipeline family associated with list. |
Example
{
"data": [{}],
"displayName": "abc123",
"name": "abc123",
"pipelineFamilyName": "xyz789"
}
RuleSet
Description
RuleSet DTO.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
description - String
|
Description of RuleSet. |
enabled - Boolean
|
Indicates whether RuleSet is enabled. |
id - String!
|
ID of RuleSet. |
name - String!
|
Name of RuleSet. |
pipeline - PipelineModel
|
Pipeline associated to a RuleSet. |
pipelineId - String
|
ID of associated Pipeline. |
preconditions - JSONObject
|
Precondition of Rule. |
rules - [RuleEntity!]
|
Array of rules associated with a RuleSet. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UserEntity
|
User.
|
userId - String
|
ID of User. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"enabled": true,
"id": "abc123",
"name": "xyz789",
"pipeline": PipelineModel,
"pipelineId": "xyz789",
"preconditions": {},
"rules": [RuleEntity],
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789"
}
RuleSetResponse
Description
Response object for RuleSet.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
description - String
|
Description of RuleSet. |
enabled - Boolean
|
Indicates whether RuleSet is enabled. |
id - String
|
ID of RuleSet. |
name - String!
|
Name of RuleSet. |
pipeline - PipelineModel
|
Pipeline associated to a RuleSet. |
pipelineId - String
|
ID of associated Pipeline. |
preconditions - JSONObject
|
Precondition of Rule. |
rules - [RuleEntity!]
|
Array of rules associated with a RuleSet. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UserEntity
|
User.
|
userId - String
|
ID of User. |
versions - [RuleSet!]!
|
Versions of RuleSet. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"enabled": true,
"id": "xyz789",
"name": "xyz789",
"pipeline": PipelineModel,
"pipelineId": "xyz789",
"preconditions": {},
"rules": [RuleEntity],
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity,
"userId": "xyz789",
"versions": [RuleSet]
}
S3ConfigurationResponse
Description
Get S3 Configuration response
Fields
| Field Name | Description |
|---|---|
s3 - String
|
s3 configuration |
Example
{"s3": "abc123"}
SamlRoleMappingInput
Fields
| Input Field | Description |
|---|---|
groupId - String!
|
|
groupName - String!
|
|
role - RoleOptions!
|
Example
{
"groupId": "abc123",
"groupName": "xyz789",
"role": "admin"
}
SamlRoleMappingResponse
Fields
| Field Name | Description |
|---|---|
groupId - String!
|
|
groupName - String!
|
|
role - RoleOptions!
|
Example
{
"groupId": "xyz789",
"groupName": "abc123",
"role": "admin"
}
SamlSettings
Description
SAML settings
Fields
| Field Name | Description |
|---|---|
entityId - String!
|
|
fieldMappingEmail - String!
|
|
fieldMappingFirstName - String!
|
|
fieldMappingGroup - String!
|
|
fieldMappingLastName - String!
|
|
fileName - String
|
|
redirectUrl - String!
|
|
roleMappings - [SamlRoleMappingResponse!]!
|
|
status - SamlSettingsStatus!
|
|
url - String
|
Example
{
"entityId": "xyz789",
"fieldMappingEmail": "abc123",
"fieldMappingFirstName": "abc123",
"fieldMappingGroup": "abc123",
"fieldMappingLastName": "xyz789",
"fileName": "xyz789",
"redirectUrl": "xyz789",
"roleMappings": [SamlRoleMappingResponse],
"status": "Empty",
"url": "abc123"
}
SamlSettingsInput
Example
{
"fieldMappingEmail": "abc123",
"fieldMappingFirstName": "abc123",
"fieldMappingGroup": "xyz789",
"fieldMappingLastName": "xyz789",
"idpSsoUrl": "abc123",
"roleMappings": [SamlRoleMappingInput],
"samlMetaDataUrl": "xyz789"
}
SamlSettingsStatus
Description
Represents the configuration status of SAML settings.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Empty"
SearchParameters
Fields
| Input Field | Description |
|---|---|
attribute - FilterAndOrderByFields!
|
Specifies the trade attribute that will be searched using the query. |
query - String!
|
The query used for searching within the specified trade attribute. |
Example
{"attribute": "Amount", "query": "abc123"}
SetFeatureToggleInput
Fields
| Input Field | Description |
|---|---|
key - FeatureToggleKey!
|
|
value - Boolean!
|
Example
{"key": "EntityLinksExplorer", "value": false}
Shap
Description
Shap values of Entity generated on DateTime.
Fields
| Field Name | Description |
|---|---|
entityId - String!
|
ID of Entity. |
featureDate - DateTime!
|
DateTime of shap values. |
features - [ShapFeature!]!
|
Relevant feature values and shap values. |
id - ID!
|
Composite key of shap.entity and shap.feature_date. |
Example
{
"entityId": "abc123",
"featureDate": "2007-12-03T10:15:30Z",
"features": [ShapFeature],
"id": "4"
}
ShapFeature
Description
Relevant feature values and shap values.
Example
{
"averageFeatureValue": 123.45,
"averagePeerGroupValue": 123.45,
"featureName": "xyz789",
"featureValue": 987.65,
"shapValue": 123.45
}
Sort
Description
Defines the sorting order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringObject
Description
Custom scalar type for handling string values with additional metadata
Example
StringObject
SummarizedTransaction
SummarizedTransactionsByTypeResponse
Description
Summarized Transactions by Type Response.
Fields
| Field Name | Description |
|---|---|
credit - [SummarizedTransaction!]
|
Total Credits of Transactions. |
debit - [SummarizedTransaction!]
|
Total Debits of Transactions. |
totalCredit - Float
|
Total Credits of Transactions. |
totalDebit - Float
|
Total Credits of Transactions. |
Example
{
"credit": [SummarizedTransaction],
"debit": [SummarizedTransaction],
"totalCredit": 123.45,
"totalDebit": 123.45
}
SummarizedTransactionsResponse
Description
Summarized Transactions Response.
Fields
| Field Name | Description |
|---|---|
credit - [DebitCreditSummarizedTransaction!]
|
Total Credits of Transactions. |
debit - [DebitCreditSummarizedTransaction!]
|
Total Debits of Transactions. |
totalCredit - Float
|
Total Credits of Transactions. |
totalDebit - Float
|
Total Credits of Transactions. |
Example
{
"credit": [DebitCreditSummarizedTransaction],
"debit": [DebitCreditSummarizedTransaction],
"totalCredit": 123.45,
"totalDebit": 123.45
}
SystemIssue
Description
SystemIssue.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
description - String!
|
Description of System issue |
id - ID!
|
Id of System issue |
isOpen - Boolean!
|
Indicates whether SystemIssue status is open. |
nature - String!
|
Nature of System issue |
natureType - NatureType!
|
Nature type of System issue |
nodeId - String!
|
Node ID of System issue |
nodeLabel - String!
|
Node label of System issue |
operatingSystem - K8sNodeOperatingSystem!
|
Operating system of the System Issue source. |
privateIPv4 - String
|
PrivateIPv4 of the System Issue source. |
privateIPv6 - String
|
PrivateIPv6 of the System Issue source. |
publicIPv4 - String
|
PublicIPv4 of the System Issue source. |
publicIPv6 - String
|
PublicIPv6 of the System Issue source. |
serviceId - String!
|
Service ID of System issue |
serviceLabel - String!
|
Service label of System issue |
status - NodeStatus!
|
Status of System issue |
timestamp - DateTime!
|
Timestamp of System issue |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": "4",
"isOpen": false,
"nature": "xyz789",
"natureType": "Error",
"nodeId": "xyz789",
"nodeLabel": "xyz789",
"operatingSystem": "linux",
"privateIPv4": "xyz789",
"privateIPv6": "xyz789",
"publicIPv4": "abc123",
"publicIPv6": "xyz789",
"serviceId": "abc123",
"serviceLabel": "xyz789",
"status": "ActionRequired",
"timestamp": "2007-12-03T10:15:30Z",
"updatedOn": "2007-12-03T10:15:30Z"
}
SystemIssuesFilter
Description
Input type for system issues input filters.
Example
{
"endDate": "2007-12-03T10:15:30Z",
"isOpen": true,
"nodeName": "xyz789",
"podName": "abc123",
"startDate": "2007-12-03T10:15:30Z"
}
SystemIssuesResponse
Description
Response type for GetAllDetections.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [SystemIssue!]!
|
List of SystemIssues. |
totalRecords - Int!
|
Total number of SystemIssue records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [SystemIssue],
"totalRecords": 987
}
SystemNode
Description
Represents a system node in the cluster.
Fields
| Field Name | Description |
|---|---|
cpuUsage - [ActivityUsage!]!
|
CPU usage, value, and timestamp of record. |
diskUsage - [ActivityUsage!]!
|
Disk usage, value, and timestamp of record. |
hostname - String
|
Hostname of node. |
id - ID!
|
ID of node. |
memoryUsage - [ActivityUsage!]!
|
Memory usage, value, and timestamp of record. |
name - String!
|
Name of node. |
openIssues - Float!
|
Number of open issues on the node. |
operatingSystem - K8sNodeOperatingSystem!
|
Operating system of Kubernetes node. |
privateIPv4 - String
|
Private IPv4 address of node. |
privateIPv6 - String
|
Private IPv6 address of node. |
publicIPv4 - String
|
Public IPv4 address of node. |
publicIPv6 - String
|
Public IPv6 address of node. |
status - NodeStatus!
|
Status of node. e.g. Running, PayAttention, NotResponding. |
timestamp - DateTime!
|
Timestamp when node was created. |
Example
{
"cpuUsage": [ActivityUsage],
"diskUsage": [ActivityUsage],
"hostname": "xyz789",
"id": "4",
"memoryUsage": [ActivityUsage],
"name": "abc123",
"openIssues": 987.65,
"operatingSystem": "linux",
"privateIPv4": "xyz789",
"privateIPv6": "abc123",
"publicIPv4": "xyz789",
"publicIPv6": "abc123",
"status": "ActionRequired",
"timestamp": "2007-12-03T10:15:30Z"
}
SystemNodeResponse
Description
List of System nodes running in the cluster.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo
|
Offset page metadata. |
records - [SystemNode!]!
|
List of SystemNodes. |
totalRecords - Int!
|
Total number of SystemNode records that can be returned. |
Example
{
"pageInfo": PageInfo,
"records": [SystemNode],
"totalRecords": 987
}
SystemNodesFilter
Description
Input type for system node input filters.
Fields
| Input Field | Description |
|---|---|
endDate - DateTime
|
List records before the given date. Default = null |
nodeName - String
|
Node Name (unique identifier). Default = null |
startDate - DateTime
|
List records at and after the given date. Default = null |
stepDuration - String
|
Retrieve usage data by specifying resolution step width as duration (e.g. 1h, 5m). See Prometheus documentation for time durations. Default to 1h. Default = "1h" |
Example
{
"endDate": "2007-12-03T10:15:30Z",
"nodeName": "abc123",
"startDate": "2007-12-03T10:15:30Z",
"stepDuration": "xyz789"
}
SystemNodesInput
Description
Input type for system node.
Fields
| Input Field | Description |
|---|---|
filter - SystemNodesFilter
|
Custom filter for System Nodes. |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
Example
{
"filter": SystemNodesFilter,
"page": OffsetPaginationInput
}
SystemPreference
Description
Configurations for system preferences. These values are used as defaults for user preferences.
Example
{
"currencyCode": "abc123",
"language": "abc123",
"timezone": "xyz789",
"weekStartsOn": "abc123"
}
TableDto
Description
Table info for Pod with type = 'Database'.
Fields
| Field Name | Description |
|---|---|
label - String!
|
Table name. |
size - Float!
|
Table size. |
status - PodStatus!
|
Table status. |
Example
{
"label": "xyz789",
"size": 123.45,
"status": "Failed"
}
Target
Description
Target.
Example
{
"health": "xyz789",
"instanceLabel": "abc123",
"jobLabel": "abc123",
"lastScrape": "xyz789"
}
TestSMTPSettingsInput
Description
Input type of TestSMTPSettings.
Fields
| Input Field | Description |
|---|---|
fromEmail - String!
|
Sender email for SMTP. |
fromName - String!
|
Name for SMTP. |
hostName - String!
|
Hostname for SMTP. |
options - JSON
|
Options for SMTP. |
password - String
|
Password for SMTP. |
port - Float!
|
Port for SMTP. |
toEmail - String
|
Provide email address to validate SMTP settings. |
userName - String!
|
Username for SMTP. |
Example
{
"fromEmail": "xyz789",
"fromName": "abc123",
"hostName": "abc123",
"options": {},
"password": "abc123",
"port": 987.65,
"toEmail": "abc123",
"userName": "xyz789"
}
TestSMTPSettingsResponse
Description
Response for TestSMTPSettings.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
Indicates whether SMTP settings successfully sent a test email. |
Example
{"success": false}
TimeZonePreferenceInput
ToggleIssueStatusInput
Description
Input type of ToggleIssueStatus.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of System Issue. |
Example
{"id": 4}
Token
Description
Token.
Fields
| Field Name | Description |
|---|---|
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
id - String!
|
ID of Token. |
ip - String!
|
IP Address of User that requested the Token. |
token - String!
|
Value of Token. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UserEntity!
|
User that requested the Token.
|
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "abc123",
"ip": "xyz789",
"token": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UserEntity
}
Topic
Description
Response type for Pod with type = 'analytics'.
Fields
| Field Name | Description |
|---|---|
analytics - [Analytics!]!
|
Topic Analytics. |
label - String!
|
Topic name. |
Example
{
"analytics": [Analytics],
"label": "xyz789"
}
TotalAlertsBySourceResponse
Description
Query response from GetTotalAlertsBySource.
Fields
| Field Name | Description |
|---|---|
totalAlertsByRiskRating - [CategoryTotalAlertsByRiskRating!]!
|
Represents the category total for Alerts by RiskRating. |
totalAlertsByStatus - [CategoryTotalAlertsByStatus!]!
|
Represents the category total for Alerts by status. |
Example
{
"totalAlertsByRiskRating": [
CategoryTotalAlertsByRiskRating
],
"totalAlertsByStatus": [CategoryTotalAlertsByStatus]
}
TradeFilterableValuesInput
Description
Input type for fetching filterable values with FilterableValues based on trade attributes.
Fields
| Input Field | Description |
|---|---|
alertId - String
|
ID of Detection. |
alertedEntityId - String
|
ID of alerted Entity. |
filterBy - TradeTransactionEventsFilter
|
Filter events by this type. Default = {} |
first - Int
|
Returns the first n items, starting after the cursor specified in the after field. This field is mutually exclusive with last. |
search - SearchParameters!
|
The search parameters for querying trade attributes. |
Example
{
"alertId": "xyz789",
"alertedEntityId": "abc123",
"filterBy": TradeTransactionEventsFilter,
"first": 987,
"search": SearchParameters
}
TradeOriginatorOrBeneficiary
Description
Represents an Originator or Beneficiary involved in a trade.
Fields
| Field Name | Description |
|---|---|
account - OriginatorOrBeneficiaryAccount
|
Account data associated with the originator or beneficiary. |
Example
{"account": OriginatorOrBeneficiaryAccount}
TradeRule
TradeTransactionEventsFilter
Description
The filters that are available when fetching trade transaction events.
Fields
| Input Field | Description |
|---|---|
amount - Float
|
Original amount of TradeTransactionEvents. |
amountNorm - Float
|
Amount Norm of TradeTransactionEvents. |
beneficiaryAccountNumber - [String!]
|
beneficiary account number of TradeTransactionEvents. |
bookId - StringObject
|
Book ID of TradeTransactionEvents. |
buySell - [String!]
|
Buy/Sell of TradeTransactionEvents. |
cleanNetPrice - Float
|
Clean net price of TradeTransactionEvents. |
cleanPrice - Float
|
Clean price of TradeTransactionEvents. |
clearerId - StringObject
|
Clearing Broker ID of TradeTransactionEvents. |
countryOfResidence - StringObject
|
Country of Residence of TradeTransactionEvents. |
currencyNorm - StringObject
|
Currency norm of TradeTransactionEvents. |
currencyTwo - StringObject
|
Currency two of TradeTransactionEvents. |
dirtyPrice - Float
|
Dirty price of TradeTransactionEvents. |
endDate - DateTime
|
End of the date range for filtering trades. |
entityId - [ID!]
|
ID of Entity |
expiryDate - Date
|
Expiry date of TradeTransactionEvents. |
farCashSettlementAmount - Float
|
Far cash settlement amount of TradeTransactionEvents. |
farLegAmountOne - Float
|
Far leg amount one of TradeTransactionEvents. |
farLegAmountTwo - Float
|
Far leg amount two of TradeTransactionEvents. |
farLegCurrencyOne - StringObject
|
Far leg currency one of TradeTransactionEvents. |
farLegCurrencyTwo - StringObject
|
Far leg currency two of TradeTransactionEvents. |
farLegFxRate - Float
|
Far leg fx rate of TradeTransactionEvents. |
farLegValueDate - Date
|
Far leg value date of TradeTransactionEvents. |
fixedRate - Float
|
Fixed rate of TradeTransactionEvents. |
fixedRateTwo - StringObject
|
Fixed rate two of TradeTransactionEvents. |
floatingRate - StringObject
|
Floating rate of TradeTransactionEvents. |
floatingRateTwo - StringObject
|
Floating rate two of TradeTransactionEvents. |
id - String
|
Filter ID of TradeTransactionEvents. |
indexTicker - StringObject
|
Index ticker of TradeTransactionEvents. |
instrumentDetails - StringObject
|
Details of the instrument used in TradeTransactionEvents. |
internalTrade - StringObject
|
Internal Trade Flag of TradeTransactionEvents. |
isin - [String!]
|
ISIN of TradeTransactionEvents. |
isinInstrument - [String!]
|
Isin instrument of TradeTransactionEvents. |
lastTradeEvent - StringObject
|
Last Trade Event of TradeTransactionEvents. |
maturityDate - Date
|
Maturity Date of TradeTransactionEvents. |
nearLegAmountTwo - Float
|
Near leg amount two of TradeTransactionEvents. |
nearLegCurrencyTwo - StringObject
|
Near leg currency two of TradeTransactionEvents. |
nearLegFxRate - Float
|
Near leg fx rate of TradeTransactionEvents. |
nearLegValueDate - Date
|
Near leg value date of TradeTransactionEvents. |
netPresentValue - Float
|
Net Present Value of TradeTransactionEvents. |
nominalAmount - Float
|
Nominal amount of TradeTransactionEvents. |
notionalTwo - Float
|
Notional two of TradeTransactionEvents. |
numberOfUnits - Float
|
Number of units of TradeTransactionEvents. |
originatorAccountNumber - [String!]
|
originator account number of TradeTransactionEvents. |
originatorOrBeneficiaryAccountNumber - String
|
Filter trade transaction events by this originator or beneficiary account number. |
paymentDate - Date
|
Payment date of TradeTransactionEvents. |
pipelineFamilyName - StringObject
|
pipeline family name of TradeTransactionEvents. |
productType - StringObject
|
Product Type of TradeTransactionEvents. |
quantity - Float
|
Quantity of TradeTransactionEvents. |
quantityAmount - Float
|
Quantity amount of TradeTransactionEvents. |
rulesTriggered - [String!]
|
Filter trade transaction events by rules Triggered. |
settlementAmount - Float
|
Settlement Amount of TradeTransactionEvents. |
settlementCurrency - StringObject
|
Settlement currency of TradeTransactionEvents. |
settlementDate - Date
|
Settlement Date of TradeTransactionEvents. |
startDate - DateTime
|
Start of the transaction date range for filtering trades. |
stockExchange - StringObject
|
Stock Exchange of TradeTransactionEvents. |
stockQuantity - Float
|
Stock Quantity of TradeTransactionEvents. |
strikePrice - Float
|
Strike price of TradeTransactionEvents. |
tenor - StringObject
|
Tenor of TradeTransactionEvents. |
tenorTwo - StringObject
|
Tenor two. of TradeTransactionEvents |
terminationDate - Date
|
Termination Date of TradeTransactionEvents. |
ticker - StringObject
|
Ticker of TradeTransactionEvents. |
tickerInstrument - StringObject
|
Ticker instrument of TradeTransactionEvents. |
tradeId - StringObject
|
Trade ID. |
tradeStatus - StringObject
|
Trade Status of TradeTransactionEvents. |
tradeType - [String!]
|
Trade Type. |
transactionCurrency - StringObject
|
Transaction currency of TradeTransactionEvents. |
transactionDate - Date
|
Date of TradeTransactionEvents. |
transactionId - [String!]
|
transaction id of TradeTransactionEvents. |
transactionTime - StringObject
|
Transaction Time. |
transactionType - [String!]
|
Filter trade transaction events by these transaction types. |
underlyingSecMarketPrice - Float
|
Underlying sec market price of TradeTransactionEvents. |
unitPrice - Float
|
Unit price of TradeTransactionEvents. |
workerCode - StringObject
|
Trader Code or Dealer Name of TradeTransactionEvents. |
Example
{
"amount": 123.45,
"amountNorm": 123.45,
"beneficiaryAccountNumber": ["xyz789"],
"bookId": StringObject,
"buySell": ["xyz789"],
"cleanNetPrice": 123.45,
"cleanPrice": 987.65,
"clearerId": StringObject,
"countryOfResidence": StringObject,
"currencyNorm": StringObject,
"currencyTwo": StringObject,
"dirtyPrice": 123.45,
"endDate": "2007-12-03T10:15:30Z",
"entityId": ["4"],
"expiryDate": "2007-12-03",
"farCashSettlementAmount": 987.65,
"farLegAmountOne": 987.65,
"farLegAmountTwo": 123.45,
"farLegCurrencyOne": StringObject,
"farLegCurrencyTwo": StringObject,
"farLegFxRate": 987.65,
"farLegValueDate": "2007-12-03",
"fixedRate": 123.45,
"fixedRateTwo": StringObject,
"floatingRate": StringObject,
"floatingRateTwo": StringObject,
"id": "xyz789",
"indexTicker": StringObject,
"instrumentDetails": StringObject,
"internalTrade": StringObject,
"isin": ["abc123"],
"isinInstrument": ["xyz789"],
"lastTradeEvent": StringObject,
"maturityDate": "2007-12-03",
"nearLegAmountTwo": 123.45,
"nearLegCurrencyTwo": StringObject,
"nearLegFxRate": 987.65,
"nearLegValueDate": "2007-12-03",
"netPresentValue": 123.45,
"nominalAmount": 123.45,
"notionalTwo": 987.65,
"numberOfUnits": 987.65,
"originatorAccountNumber": ["abc123"],
"originatorOrBeneficiaryAccountNumber": "xyz789",
"paymentDate": "2007-12-03",
"pipelineFamilyName": StringObject,
"productType": StringObject,
"quantity": 123.45,
"quantityAmount": 987.65,
"rulesTriggered": ["abc123"],
"settlementAmount": 123.45,
"settlementCurrency": StringObject,
"settlementDate": "2007-12-03",
"startDate": "2007-12-03T10:15:30Z",
"stockExchange": StringObject,
"stockQuantity": 987.65,
"strikePrice": 123.45,
"tenor": StringObject,
"tenorTwo": StringObject,
"terminationDate": "2007-12-03",
"ticker": StringObject,
"tickerInstrument": StringObject,
"tradeId": StringObject,
"tradeStatus": StringObject,
"tradeType": ["abc123"],
"transactionCurrency": StringObject,
"transactionDate": "2007-12-03",
"transactionId": ["abc123"],
"transactionTime": StringObject,
"transactionType": ["xyz789"],
"underlyingSecMarketPrice": 123.45,
"unitPrice": 987.65,
"workerCode": StringObject
}
TradesOrderByInput
Description
Input type for order by allowed fields.
Fields
| Input Field | Description |
|---|---|
field - FilterAndOrderByFields!
|
Ordering options for trades. Default = TransactionDate |
sort - Sort
|
The ordering direction. Default = DESC |
Example
{"field": "Amount", "sort": "ASC"}
TradesResponse
Description
Trades Response Attributes.
Fields
| Field Name | Description |
|---|---|
amount - Float
|
Original amount of TradeTransactionEvents. |
amountNorm - Float
|
Amount Norm of TradeTransactionEvents. |
beneficiary - TradeOriginatorOrBeneficiary
|
beneficiary of TradeTransactionEvents. |
beneficiaryAccountNumber - StringObject
|
beneficiary account number of TradeTransactionEvents. Use beneficiary instead. Removal on v6.0.0.
|
bookId - StringObject
|
Book ID of TradeTransactionEvents. |
buySell - StringObject
|
Buy/Sell of TradeTransactionEvents. |
cleanNetPrice - Float
|
Clean net price of TradeTransactionEvents. |
cleanPrice - Float
|
Clean price of TradeTransactionEvents. |
countryOfResidence - StringObject
|
Country of Residence of TradeTransactionEvents. |
currencyNorm - StringObject
|
Currency norm of TradeTransactionEvents. |
currencyTwo - StringObject
|
Currency two of TradeTransactionEvents. |
dirtyPrice - Float
|
Dirty price of TradeTransactionEvents. |
entityId - StringObject
|
ID of Entity |
expiryDate - Date
|
Expiry date of TradeTransactionEvents. |
farCashSettlementAmount - Float
|
Far cash settlement amount of TradeTransactionEvents. |
farLegAmountOne - Float
|
Far leg amount one of TradeTransactionEvents. |
farLegAmountTwo - Float
|
Far leg amount two of TradeTransactionEvents. |
farLegCurrencyOne - StringObject
|
Far leg currency one of TradeTransactionEvents. |
farLegCurrencyTwo - StringObject
|
Far leg currency two of TradeTransactionEvents. |
farLegFxRate - Float
|
Far leg fx rate of TradeTransactionEvents. |
farLegValueDate - Date
|
Far leg value date of TradeTransactionEvents. |
fixedRate - Float
|
Fixed rate of TradeTransactionEvents. |
fixedRateTwo - StringObject
|
Fixed rate two of TradeTransactionEvents. |
floatingRate - StringObject
|
Floating rate of TradeTransactionEvents. |
floatingRateTwo - StringObject
|
Floating rate two of TradeTransactionEvents. |
id - StringObject!
|
ID of TradeTransactionEvents. |
indexTicker - StringObject
|
Index ticker of TradeTransactionEvents. |
instrumentDetails - StringObject
|
Details of the instrument used in TradeTransactionEvents. |
internalTrade - StringObject
|
Internal Trade Flag of TradeTransactionEvents. |
isin - StringObject
|
ISIN of TradeTransactionEvents. |
isinInstrument - StringObject
|
Isin instrument of TradeTransactionEvents. |
lastTradeEvent - StringObject
|
Last Trade Event of TradeTransactionEvents. |
nearLegAmountTwo - Float
|
Near leg amount two of TradeTransactionEvents. |
nearLegCurrencyTwo - StringObject
|
Near leg currency two of TradeTransactionEvents. |
nearLegFxRate - Float
|
Near leg fx rate of TradeTransactionEvents. |
nearLegValueDate - Date
|
Near leg value date of TradeTransactionEvents. |
nominalAmount - Float
|
Nominal amount of TradeTransactionEvents. |
notionalTwo - Float
|
Notional two of TradeTransactionEvents. |
numberOfUnits - Float
|
Number of units of TradeTransactionEvents. |
originator - TradeOriginatorOrBeneficiary
|
beneficiary of TradeTransactionEvents. |
originatorAccountNumber - StringObject
|
originator account number of TradeTransactionEvents. Use originator instead. Removal on v6.0.0.
|
paymentDate - Date
|
Payment date of TradeTransactionEvents. |
pipelineFamilyName - StringObject
|
pipeline family name of TradeTransactionEvents. |
quantity - Float
|
Quantity of TradeTransactionEvents. |
quantityAmount - Float
|
Quantity amount of TradeTransactionEvents. |
rulesTriggered - [TradeRule!]
|
List of rules triggered for TradeTransactionEvents. |
settlementAmount - Float
|
Settlement Amount of TradeTransactionEvents. |
settlementCurrency - StringObject
|
Settlement currency of TradeTransactionEvents. |
settlementDate - Date
|
Settlement Date of TradeTransactionEvents. |
strikePrice - Float
|
Strike price of TradeTransactionEvents. |
tenor - StringObject
|
Tenor of TradeTransactionEvents. |
tenorTwo - StringObject
|
Tenor two. of TradeTransactionEvents |
terminationDate - Date
|
Termination Date of TradeTransactionEvents. |
ticker - StringObject
|
Ticker of TradeTransactionEvents. |
tickerInstrument - StringObject
|
Ticker instrument of TradeTransactionEvents. |
tradeStatus - StringObject
|
Trade Status of TradeTransactionEvents. |
tradeType - StringObject
|
Trade Type. |
transactionCurrency - StringObject
|
Transaction currency of TradeTransactionEvents. |
transactionDate - Date
|
Date of TradeTransactionEvents. |
transactionId - StringObject
|
transaction id of TradeTransactionEvents. |
transactionType - StringObject
|
Type of TradeTransactionEvents. |
underlyingSecMarketPrice - Float
|
Underlying sec market price of TradeTransactionEvents. |
unitPrice - Float
|
Unit price of TradeTransactionEvents. |
workerCode - StringObject
|
Trader Code or Dealer Name of TradeTransactionEvents. |
Example
{
"amount": 987.65,
"amountNorm": 123.45,
"beneficiary": TradeOriginatorOrBeneficiary,
"beneficiaryAccountNumber": StringObject,
"bookId": StringObject,
"buySell": StringObject,
"cleanNetPrice": 123.45,
"cleanPrice": 123.45,
"countryOfResidence": StringObject,
"currencyNorm": StringObject,
"currencyTwo": StringObject,
"dirtyPrice": 123.45,
"entityId": StringObject,
"expiryDate": "2007-12-03",
"farCashSettlementAmount": 123.45,
"farLegAmountOne": 123.45,
"farLegAmountTwo": 123.45,
"farLegCurrencyOne": StringObject,
"farLegCurrencyTwo": StringObject,
"farLegFxRate": 987.65,
"farLegValueDate": "2007-12-03",
"fixedRate": 123.45,
"fixedRateTwo": StringObject,
"floatingRate": StringObject,
"floatingRateTwo": StringObject,
"id": StringObject,
"indexTicker": StringObject,
"instrumentDetails": StringObject,
"internalTrade": StringObject,
"isin": StringObject,
"isinInstrument": StringObject,
"lastTradeEvent": StringObject,
"nearLegAmountTwo": 123.45,
"nearLegCurrencyTwo": StringObject,
"nearLegFxRate": 987.65,
"nearLegValueDate": "2007-12-03",
"nominalAmount": 987.65,
"notionalTwo": 123.45,
"numberOfUnits": 123.45,
"originator": TradeOriginatorOrBeneficiary,
"originatorAccountNumber": StringObject,
"paymentDate": "2007-12-03",
"pipelineFamilyName": StringObject,
"quantity": 987.65,
"quantityAmount": 987.65,
"rulesTriggered": [TradeRule],
"settlementAmount": 987.65,
"settlementCurrency": StringObject,
"settlementDate": "2007-12-03",
"strikePrice": 123.45,
"tenor": StringObject,
"tenorTwo": StringObject,
"terminationDate": "2007-12-03",
"ticker": StringObject,
"tickerInstrument": StringObject,
"tradeStatus": StringObject,
"tradeType": StringObject,
"transactionCurrency": StringObject,
"transactionDate": "2007-12-03",
"transactionId": StringObject,
"transactionType": StringObject,
"underlyingSecMarketPrice": 123.45,
"unitPrice": 123.45,
"workerCode": StringObject
}
TrainingModel
Description
Oject type for Training model
Example
{
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"id": "xyz789",
"modelData": {},
"modelName": "abc123",
"updatedOn": "2007-12-03T10:15:30Z"
}
TransactionEdge
Description
Edge to connect Transaction nodes.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
Cursor for current Transaction node. |
node - EventModel!
|
Transaction object details.
|
Example
{
"cursor": "abc123",
"node": EventModel
}
TransactionFilters
Description
The filters that are available when fetching transactions.
Fields
| Input Field | Description |
|---|---|
since - DateTime
|
Filter transactions to those that occurred on or after this time. |
Example
{"since": "2007-12-03T10:15:30Z"}
TransactionSummaryDetails
Description
Response type for transactionSummaryDetails.
Fields
| Field Name | Description |
|---|---|
edges - [TransactionEdge!]!
|
Edges pointing to Transaction objects. |
pageInfo - PageInfo!
|
Pagination details. |
totalRecords - Int!
|
Total number of Transaction records that can be returned. |
Example
{
"edges": [TransactionEdge],
"pageInfo": PageInfo,
"totalRecords": 987
}
TransactionSummaryDetailsInput
Description
Input type of transactionSummaryDetails.
Fields
| Input Field | Description |
|---|---|
alertId - String
|
ID of Alert related to TransactionSummary. |
entityId - String!
|
ID of Entity related to TransactionSummary. |
filterBy - FlowOfFundsFiltersInput!
|
Filters for Entity Links Explorer. |
orderBy - OrderByInput
|
Specify the ordering of TransactionSummary records. |
page - OffsetPaginationInput
|
Specify page and limit for paginated results. Default = {limit: 25, pageNumber: 0} |
transactionSummaryId - String!
|
Composite ID for TransactionSummary formed by originatorId and beneficiaryId. |
Example
{
"alertId": "xyz789",
"entityId": "abc123",
"filterBy": FlowOfFundsFiltersInput,
"orderBy": OrderByInput,
"page": OffsetPaginationInput,
"transactionSummaryId": "xyz789"
}
TransactionSummaryTypes
Description
Specifies the aggregation intervals for transaction summaries.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Daily"
TransactionType
Description
Mapped type of transaction for UI configuration.
Example
{
"icon": "xyz789",
"label": "xyz789",
"value": "xyz789"
}
TransactionsByCreditOrDebitType
Description
Aggregated Transactions amounts grouped by either Credit or Debit type and transaction type.
Example
{
"totalTransactionAmount": 123.45,
"transactionType": "abc123"
}
TransactionsEntitiesDataByMonth
Description
Month data map for GetTransactionsThroughput.
Example
{
"month": 987.65,
"numberOfActiveEntities": 123.45,
"numberOfTransactions": 123.45,
"year": 987.65
}
TransactionsThroughputDto
Description
Query response from GetTransactionsThroughput.
Fields
| Field Name | Description |
|---|---|
avgEntitiesPerMonth - Float
|
Average Entities Per Month. |
avgTransactionsPerMonth - Float
|
Average Transactions Per Month. |
dataByMonth - [TransactionsEntitiesDataByMonth!]
|
Data by month for GetTransactionsThroughput. |
isEmpty - Boolean
|
Flag to notify if there is no data for the period. |
totalEntities - Float
|
Total Entities all time. |
totalTransactions - Float
|
Total Transactions all time. |
Example
{
"avgEntitiesPerMonth": 987.65,
"avgTransactionsPerMonth": 123.45,
"dataByMonth": [TransactionsEntitiesDataByMonth],
"isEmpty": false,
"totalEntities": 123.45,
"totalTransactions": 123.45
}
TriggerEtlJobInput
Description
Input type for triggerEtlJob.
Fields
| Input Field | Description |
|---|---|
batchDate - String
|
Specify batch date, if relationship type depends on it. |
jobType - JobType
|
Specify relationship type (e.g., Detection or Ingestion) to load. Note: currently supports Detection only. Default = Detection |
pipelineFamilyName - String!
|
Specify pipeline family name for ETL process. |
Example
{
"batchDate": "abc123",
"jobType": "Detection",
"pipelineFamilyName": "xyz789"
}
UiColumnVisibilityConfig
Description
A list of configurations for managing the visibility and configuration of fields within Sensa UI tables.
Fields
| Field Name | Description |
|---|---|
fields - [FieldConfig!]!
|
A list of configurations for each field related to a table column. |
Example
{"fields": [FieldConfig]}
UiColumnVisibilityConfigInput
Description
Input type of uiColumnVisibilityConfiguration.
Fields
| Input Field | Description |
|---|---|
uiTableName - String!
|
Sensa UI table component name. |
Example
{"uiTableName": "abc123"}
UpdateAdminSettingsKeyValuesInput
Description
Input type of UpdateAdminSettings.
Fields
| Input Field | Description |
|---|---|
batch - [UpdateKeyValueInput!]!
|
List of ADMIN_SETTINGS KeyValues to update. |
Example
{"batch": [UpdateKeyValueInput]}
UpdateAlertDecisionInput
Description
Input type of UpdateAlertDecision.
Example
{
"alertId": "abc123",
"comment": "abc123",
"decision": "abc123",
"status": "abc123",
"suppressEntity": false
}
UpdateAlertQueueInput
Description
Input type of UpdateAlertQueue.
Example
{
"currency": "xyz789",
"filters": FiltersInput,
"id": "abc123",
"label": "xyz789",
"name": "abc123",
"queueUsers": ["xyz789"]
}
UpdateAlertStatusInput
Description
Input type of UpdateAlertStatus.
Fields
| Input Field | Description |
|---|---|
color - String
|
Icon's color |
hasRiskRating - Boolean
|
Flag to indicate if a Detection requires a risk rating |
icon - String
|
Font Awesome icon |
id - String!
|
ID of AlertStatus. |
isClosed - Boolean
|
Flag to indicate if a Detection is considered as closed |
label - String
|
Alert status label |
type - String
|
Alert status type |
Example
{
"color": "xyz789",
"hasRiskRating": true,
"icon": "abc123",
"id": "xyz789",
"isClosed": false,
"label": "abc123",
"type": "xyz789"
}
UpdateAlertTypeInput
UpdateKeyValueInput
Description
Input type of UpdateKeyValue.
Fields
| Input Field | Description |
|---|---|
editPermissions - JSONObject
|
Permissions that have access to update a KeyValue. |
encryptedValues - JSON
|
Values to encrypt. |
isEnv - Boolean
|
Indiciates whether value of KeyValue is an environment variable. |
key - String!
|
Key of KeyValue. |
readPermissions - JSONObject
|
Permissions that have access to update a KeyValue. |
value - JSON
|
Value of KeyValue. |
Example
{
"editPermissions": {},
"encryptedValues": {},
"isEnv": false,
"key": "xyz789",
"readPermissions": {},
"value": {}
}
UpdateKeyValuesInput
Description
Input type of UpdateKeyValues.
Fields
| Input Field | Description |
|---|---|
batch - [UpdateKeyValueInput!]!
|
List of KeyValues to update. |
Example
{"batch": [UpdateKeyValueInput]}
UpdatePipelineInput
Description
Input type of UpdatePipelineInput.
Fields
| Input Field | Description |
|---|---|
config - JSONObject
|
Config of Pipeline. |
dependencies - String
|
Dependencies of Pipeline as comma-delimited string. |
description - String
|
Description of Pipeline. |
displayName - String
|
Display name of Pipeline. |
featureSchedule - String
|
Feature Schedule of Pipeline. |
id - String
|
ID of Pipeline. |
label - String
|
User friendly label name for Pipeline. |
systemName - String
|
System name of Pipeline. |
triggeringFrequency - String
|
Trigger frequency (Daily, Weekly, Monthly) calculated from cron expression present on featureSchedule field. |
type - PipelineType
|
Type of Pipeline. Default = Generic |
Example
{
"config": {},
"dependencies": "xyz789",
"description": "xyz789",
"displayName": "abc123",
"featureSchedule": "xyz789",
"id": "xyz789",
"label": "abc123",
"systemName": "abc123",
"triggeringFrequency": "abc123",
"type": "Data"
}
UpdateProfileInput
Description
Input type of UpdateProfile.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the user to update. |
imageId - String
|
ImageId of User. |
preferences - UpdateUserPreferenceInput
|
Configurable preference settings for user. |
Example
{
"id": "4",
"imageId": "abc123",
"preferences": UpdateUserPreferenceInput
}
UpdateRiskRatingInput
Description
Input type of UpdateRiskRating.
Example
{
"color": "xyz789",
"displayOrder": 123.45,
"id": "abc123",
"label": "xyz789"
}
UpdateRiskRatingsInput
Description
Input type of UpdateRiskRatings.
Fields
| Input Field | Description |
|---|---|
riskRatings - [RiskRatingFieldInput!]
|
List of RiskRatings. |
Example
{"riskRatings": [RiskRatingFieldInput]}
UpdateRuleActiveInput
UpdateRuleInput
Description
Input type to update a rule record.
Fields
| Input Field | Description |
|---|---|
active - Boolean!
|
Indicates whether Rule is active. |
description - String!
|
Description of Rule. |
eventType - String
|
Event type. |
id - String!
|
ID of Rule. |
name - String
|
Name of Rule. |
rule - JSONObject!
|
Logic for Rule. |
ruleActionIds - [String!]
|
Rule Action ids associated to the Rule. |
ruleSetId - String!
|
ID of RuleSet. |
score - Float!
|
Score of Rule. |
type - String
|
Type of Rule. |
Example
{
"active": false,
"description": "abc123",
"eventType": "xyz789",
"id": "xyz789",
"name": "abc123",
"rule": {},
"ruleActionIds": ["xyz789"],
"ruleSetId": "xyz789",
"score": 987.65,
"type": "xyz789"
}
UpdateRuleSetsInput
Description
Input type of UpdateRuleSet.
Example
{
"id": "xyz789",
"name": "abc123",
"pipelineId": "xyz789",
"preconditions": "abc123"
}
UpdateSystemPreferenceInput
Description
Input fields for UpdateSystemPreference.
Example
{
"currencyCode": "abc123",
"language": "abc123",
"timezone": "abc123",
"weekStartsOn": "abc123"
}
UpdateTransactionTypesInput
Description
Input type of UpdateTransactionTypes.
Fields
| Input Field | Description |
|---|---|
transactionTypes - [BulkTransactionType!]!
|
The list of icons and labels to use for known transaction types. |
Example
{"transactionTypes": [BulkTransactionType]}
UpdateUser
Description
Input type of user field in UpdateUserInput.
Fields
| Input Field | Description |
|---|---|
email - String
|
Email of User. |
enabled - Boolean
|
Indicates whether the user is enabled. |
first_name - String
|
First name of User. |
fullName - String
|
Full name of User. |
imageId - String
|
ImageId of User. |
language - String
|
Language of User. |
last_name - String
|
Last name of User. |
permissions - JSONObject
|
Permissions of User. |
preferences - UpdateUserPreferenceInput
|
Update user's preferences. |
role - String
|
Role of User. |
time_zone - String
|
Time zone of User. |
updatedOn - DateTime
|
Updated on DateTime. |
username - String
|
Username of User. |
weekStartsOn - String
|
The first day of the week User. |
Example
{
"email": "xyz789",
"enabled": false,
"first_name": "abc123",
"fullName": "abc123",
"imageId": "abc123",
"language": "abc123",
"last_name": "abc123",
"permissions": {},
"preferences": UpdateUserPreferenceInput,
"role": "abc123",
"time_zone": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"username": "abc123",
"weekStartsOn": "abc123"
}
UpdateUserInput
Description
Input type of UpdateUser. @deprecated(reason: "Moved to root level of input object. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
active - Boolean
|
Sets the active status of the user. Setting to true activates the user, while false deactivates them. |
email - String
|
Email of User. |
first_name - String
|
First name of User. |
fullName - String
|
Full name of User. |
id - ID!
|
ID of the user to update. |
imageId - String
|
ImageId of User. |
language - String
|
Language of User. |
last_name - String
|
Last name of User. |
permissions - JSONObject
|
Specifies custom permissions for the user's system access. |
preferences - UpdateUserPreferenceInput
|
Update user's preferences. |
role - String
|
Role of User. |
time_zone - String
|
Time zone of User. |
updatedOn - DateTime
|
Updated on DateTime. |
user - UpdateUser
|
User object.
|
username - String
|
Username of User. |
weekStartsOn - String
|
The first day of the week User. |
Example
{
"active": true,
"email": "abc123",
"first_name": "abc123",
"fullName": "abc123",
"id": "4",
"imageId": "xyz789",
"language": "xyz789",
"last_name": "abc123",
"permissions": {},
"preferences": UpdateUserPreferenceInput,
"role": "abc123",
"time_zone": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z",
"user": UpdateUser,
"username": "abc123",
"weekStartsOn": "abc123"
}
UpdateUserPreferenceInput
Description
Input fields for UpdateUser preferences.
Fields
| Input Field | Description |
|---|---|
currencyCode - CurrencyCodePreferenceInput
|
Preferred currency for the user. |
language - LanguagePreferenceInput
|
Preferred language for the user. |
timezone - TimeZonePreferenceInput
|
Preferred timezone for the user. |
weekStartsOn - WeekStartDayPreferenceInput
|
Preferred day to start the week for user. |
Example
{
"currencyCode": CurrencyCodePreferenceInput,
"language": LanguagePreferenceInput,
"timezone": TimeZonePreferenceInput,
"weekStartsOn": WeekStartDayPreferenceInput
}
UpsertLandingDataSourceInput
Description
Input type of UpdateDataSourceStatsInput.
Fields
| Input Field | Description |
|---|---|
bucket - String
|
Bucket for File. |
id - String
|
ID of File. |
landingFolderPath - String!
|
Folder path of the landing folder`. |
mimetype - String
|
Mimetype of File. |
name - String
|
Name of File. |
pipelineFamilyName - String!
|
Pipeline family name of Data Source. |
size - Int!
|
Size of the landing folder for a Data Source. |
Example
{
"bucket": "xyz789",
"id": "xyz789",
"landingFolderPath": "xyz789",
"mimetype": "abc123",
"name": "abc123",
"pipelineFamilyName": "abc123",
"size": 987
}
UpsertLandingDataSourceResponseDto
Description
Mutation response from upsertLandingDataSource.
Fields
| Field Name | Description |
|---|---|
id - String!
|
ID of File. |
Example
{"id": "xyz789"}
User
Description
User.
Fields
| Field Name | Description |
|---|---|
alert_queues_assigned - [AlertQueueAssigned!]
|
Alert queues assigned by User. |
alert_queues_owned - [AlertQueue!]
|
Alert queues owned by User. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
email - String!
|
Email of User. |
enabled - Boolean!
|
Indicates whether User is enabled. |
first_name - String
|
First name of User. |
fullName - String
|
Full name of User. |
id - String!
|
ID of User. |
imageId - String
|
ImageId of User. |
language - String
|
Language of User. Use preferences field in User instead.
|
last_name - String
|
Last name of User. |
login_codes - LoginCode
|
Login code of User. |
permissions - JSONObject
|
Permission of User. |
preferences - UserPreference!
|
List of user preferences. |
role - String
|
Role of User. |
time_zone - String
|
Time zone of User. Use preferences field in User instead.
|
tokens - [Token!]
|
Tokens of User. |
updatedOn - DateTime
|
Updated on DateTime. |
username - String
|
Username of User. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
weekStartsOn - String
|
Preferred first day of the week for User Use preferences field in User instead.
|
Example
{
"alert_queues_assigned": [AlertQueueAssigned],
"alert_queues_owned": [AlertQueue],
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "abc123",
"enabled": true,
"first_name": "abc123",
"fullName": "abc123",
"id": "abc123",
"imageId": "xyz789",
"language": "xyz789",
"last_name": "abc123",
"login_codes": LoginCode,
"permissions": {},
"preferences": UserPreference,
"role": "xyz789",
"time_zone": "abc123",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789",
"weekStartsOn": "xyz789"
}
UserEntity
Description
User.
Fields
| Field Name | Description |
|---|---|
alertTypes - [AlertType!]
|
AlertTypes of User.
|
alert_queues - [AlertQueue!]
|
AlertQueues of User.
|
alert_queues_users_users - [AlertQueueAssignedUsers!]
|
AlertQueue joiner table on User.
|
apiKey - String
|
API key of User. |
createdOn - DateTime
|
Created on DateTime. |
deletedOn - DateTime
|
Deleted on DateTime. |
email - String!
|
Email of User. |
first_name - String
|
First name of User. |
fullName - String
|
Full name of User. |
id - String!
|
ID of User. |
imageId - String
|
ImageId of User. |
last_name - String
|
Last name of User. |
loginCodes - [LoginCode!]
|
Login codes of User. |
permissions - JSONObject
|
Permission of User. |
role - String
|
Role of User. |
tokens - [Token!]
|
Tokens of User. |
updatedOn - DateTime
|
Updated on DateTime. |
username - String!
|
Username of User. No longer supported and will be removed in the near future. Removal on v5.0.0.
|
Example
{
"alertTypes": [AlertType],
"alert_queues": [AlertQueue],
"alert_queues_users_users": [AlertQueueAssignedUsers],
"apiKey": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"deletedOn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"first_name": "abc123",
"fullName": "xyz789",
"id": "abc123",
"imageId": "abc123",
"last_name": "abc123",
"loginCodes": [LoginCode],
"permissions": {},
"role": "xyz789",
"tokens": [Token],
"updatedOn": "2007-12-03T10:15:30Z",
"username": "xyz789"
}
UserPreference
Description
Configurations for user preferences.
Example
{
"currencyCode": "xyz789",
"language": "xyz789",
"timezone": "abc123",
"weekStartsOn": "abc123"
}
ValidateCache
ValidateCacheInput
WatchlistFlag
WeekStartDayPreferenceInput
Description
Custom input type for week start day preference fields.
Example
{"useDefault": true, "value": "abc123"}
WithCorrespondentBankingAttributes
Description
Represents an Event of subtype transaction (correspondent banking).
Fields
| Field Name | Description |
|---|---|
accountWithInstitution - String
|
Account With Institution. |
accountWithInstitutionCountry - String
|
Account With Institution Country. |
attributes - CorrespondentBankingAttributes
|
Attributes for subtype transaction. |
baseCurrency - String
|
The base currency of the customers accounts |
beneficiaries - [EntityModel!]
|
Associated beneficiary Entity. Use beneficiariesV2 instead. Removal on v5.0.0.
|
beneficiariesV2 - BeneficiariesV2
|
Associated beneficiaries to an event. |
beneficiaryCustomer - String
|
Beneficiary customer. |
beneficiaryId - String
|
beneficiary id of Event. |
beneficiaryInstitution - String
|
Beneficiary institution. |
beneficiaryInstitutionCountry - String
|
Beneficiary institution country. |
branchId - String
|
Represents the branch id of the transaction |
buyer - String
|
Identifiers the buying party in the transaction |
cardId - String
|
Unique identifier for the card |
createdOn - DateTime
|
Created on DateTime. |
creditDebitFlag - String
|
Credit or Debit for Event. |
deletedOn - DateTime
|
Deleted on DateTime. |
destinationCountry - String
|
Destination country. |
deviceId - String
|
The id of the device |
eventDate - DateTime
|
Date of event. |
file - File
|
File associated with event. |
financialInstrumentCountry - String
|
Financial Instrument Country. |
financialInstrumentDetails - String
|
Financial Instrument Details |
financialInstrumentIsin - String
|
Financial Instrument Is in. |
financialInstrumentQuantity - Float
|
The instrument quantity involved in the transaction |
functionalAmount - Float
|
Functional amount of Event. |
functionalCurrency - String
|
Functional currency of Event. |
id - String!
|
ID of Event. |
intermediary - String
|
Intermediary. |
intermediaryCountry - String
|
Intermediary Country. |
label - String
|
Label of Event. |
orderingCustomer - String
|
Ordering customer. |
orderingInstitution - String
|
Ordering institution. |
orderingInstitutionCountry - String
|
Ordering institution country. |
originCountry - String
|
Origin country. |
originalAmount - Float
|
Original amount of Event. |
originalCurrency - String
|
Original currency of Event. |
originationDate - DateTime
|
Date the Transaction originated or date of Transaction |
originatorId - String
|
originator id of Event. |
originators - [EntityModel!]
|
Associated originator Entity. Use originatorsV2 instead. Make sure to adhere to the new schema for originatorsV2. Removal on v5.0.0.
|
originatorsV2 - OriginatorsV2
|
Associated originators to an event. |
pipelineFamilyName - String
|
pipeline family name of Event. |
postingDate - DateTime
|
Date the Transaction was posted to the account |
receiverBic - String
|
Receiving Bank Identification Code (BIC). |
receiverCorrespondent - String
|
Receiver correspondent. |
receiverCorrespondentCountry - String
|
Receiver correspondent country. |
region - String
|
Indicates whether this type of transaction is DOMESTIC, INTERNATIONAL, or - (i.e., unknown type) |
scope - String
|
The scope of the transaction. Can be EXTERNAL, CLIENT or INTERNAL |
seller - String
|
Identifiers the selling party in the transaction |
senderBic - String
|
Sender Bank Identification Code (BIC). |
senderCorrespondent - String
|
Sender correspondent. |
senderCorrespondentCountry - String
|
Sender correspondent country. |
sendingInstitution - String
|
Sending institution. |
sendingInstitutionCountry - String
|
Sending institution country. |
settlementBic - String
|
Settlement Bank Identification Code (BIC) |
settlementPlaceCountry - String
|
Settlement Place Country. |
sourceId - String
|
source id of Event. |
sourceName - String
|
Source name. |
sourceSystem - String
|
Identifier for the Source system that the Transaction came from |
sourceTable - String
|
source table name of Event. |
subtype - String!
|
Subtype of Event. |
tellerId - String
|
The teller Identification number |
transactionType - String
|
Type of transaction (e.g., wire, card, cash, etc). |
transactionTypeDescription - String
|
Description of transaction type. |
txnId - String
|
txn id of Event. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"accountWithInstitution": "abc123",
"accountWithInstitutionCountry": "abc123",
"attributes": CorrespondentBankingAttributes,
"baseCurrency": "abc123",
"beneficiaries": [EntityModel],
"beneficiariesV2": BeneficiariesV2,
"beneficiaryCustomer": "xyz789",
"beneficiaryId": "abc123",
"beneficiaryInstitution": "abc123",
"beneficiaryInstitutionCountry": "xyz789",
"branchId": "abc123",
"buyer": "xyz789",
"cardId": "xyz789",
"createdOn": "2007-12-03T10:15:30Z",
"creditDebitFlag": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"destinationCountry": "abc123",
"deviceId": "abc123",
"eventDate": "2007-12-03T10:15:30Z",
"file": File,
"financialInstrumentCountry": "abc123",
"financialInstrumentDetails": "abc123",
"financialInstrumentIsin": "xyz789",
"financialInstrumentQuantity": 987.65,
"functionalAmount": 123.45,
"functionalCurrency": "xyz789",
"id": "abc123",
"intermediary": "xyz789",
"intermediaryCountry": "xyz789",
"label": "xyz789",
"orderingCustomer": "abc123",
"orderingInstitution": "xyz789",
"orderingInstitutionCountry": "abc123",
"originCountry": "xyz789",
"originalAmount": 123.45,
"originalCurrency": "xyz789",
"originationDate": "2007-12-03T10:15:30Z",
"originatorId": "abc123",
"originators": [EntityModel],
"originatorsV2": OriginatorsV2,
"pipelineFamilyName": "xyz789",
"postingDate": "2007-12-03T10:15:30Z",
"receiverBic": "abc123",
"receiverCorrespondent": "xyz789",
"receiverCorrespondentCountry": "abc123",
"region": "abc123",
"scope": "xyz789",
"seller": "abc123",
"senderBic": "abc123",
"senderCorrespondent": "xyz789",
"senderCorrespondentCountry": "xyz789",
"sendingInstitution": "abc123",
"sendingInstitutionCountry": "xyz789",
"settlementBic": "xyz789",
"settlementPlaceCountry": "abc123",
"sourceId": "xyz789",
"sourceName": "abc123",
"sourceSystem": "xyz789",
"sourceTable": "abc123",
"subtype": "abc123",
"tellerId": "abc123",
"transactionType": "abc123",
"transactionTypeDescription": "xyz789",
"txnId": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}
WithFlowOfFundsFilter
Description
Input type to support Filter requests for Entity Links Explorer. @deprecated(reason: "Replaced by GetRelationshipsLinksInput. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
endDate - DateTime!
|
Filter records until end date as DateTime. |
fromAmount - Float
|
Filter records from fromAmount as number. |
higherScore - Float
|
Filter records to higherScore as number. |
lowerScore - Float
|
Filter records from lowerScore as number. |
startDate - DateTime!
|
Filter records from start date as DateTime. |
toAmount - Float
|
Filter records to toAmount as number. |
Example
{
"endDate": "2007-12-03T10:15:30Z",
"fromAmount": 987.65,
"higherScore": 987.65,
"lowerScore": 987.65,
"startDate": "2007-12-03T10:15:30Z",
"toAmount": 987.65
}
WithRelationshipFilter
Description
Input type to support Filter requests for Entity Links Explorer. @deprecated(reason: "Replaced by RiskScoreTrendsInput. Removal on v5.0.0.")
Fields
| Input Field | Description |
|---|---|
fields - [String!]!
|
List of DataModel attributes to filter by. Default = [] |
isFieldsCombined - Boolean
|
Indicates whether all specified attributes in fields must be present. Default = false |
Example
{
"fields": ["xyz789"],
"isFieldsCombined": true
}
WithRetailBankingAttributes
Description
Represents an Event of subtype transaction (correspondent banking).
Fields
| Field Name | Description |
|---|---|
accountWithInstitution - String
|
Account With Institution. |
accountWithInstitutionCountry - String
|
Account With Institution Country. |
attributes - RetailBankingAttributes
|
Attributes for subtype transaction. |
baseCurrency - String
|
The base currency of the customers accounts |
beneficiaries - [EntityModel!]
|
Associated beneficiary Entity. Use beneficiariesV2 instead. Removal on v5.0.0.
|
beneficiariesV2 - BeneficiariesV2
|
Associated beneficiaries to an event. |
beneficiaryCustomer - String
|
Beneficiary customer. |
beneficiaryId - String
|
beneficiary id of Event. |
beneficiaryInstitution - String
|
Beneficiary institution. |
beneficiaryInstitutionCountry - String
|
Beneficiary institution country. |
branchId - String
|
Represents the branch id of the transaction |
buyer - String
|
Identifiers the buying party in the transaction |
cardId - String
|
Unique identifier for the card |
createdOn - DateTime
|
Created on DateTime. |
creditDebitFlag - String
|
Credit or Debit for Event. |
deletedOn - DateTime
|
Deleted on DateTime. |
destinationCountry - String
|
Destination country. |
deviceId - String
|
The id of the device |
eventDate - DateTime
|
Date of event. |
file - File
|
File associated with event. |
financialInstrumentCountry - String
|
Financial Instrument Country. |
financialInstrumentDetails - String
|
Financial Instrument Details |
financialInstrumentIsin - String
|
Financial Instrument Is in. |
financialInstrumentQuantity - Float
|
The instrument quantity involved in the transaction |
functionalAmount - Float
|
Functional amount of Event. |
functionalCurrency - String
|
Functional currency of Event. |
id - String!
|
ID of Event. |
intermediary - String
|
Intermediary. |
intermediaryCountry - String
|
Intermediary Country. |
label - String
|
Label of Event. |
orderingCustomer - String
|
Ordering customer. |
orderingInstitution - String
|
Ordering institution. |
orderingInstitutionCountry - String
|
Ordering institution country. |
originCountry - String
|
Origin country. |
originalAmount - Float
|
Original amount of Event. |
originalCurrency - String
|
Original currency of Event. |
originationDate - DateTime
|
Date the Transaction originated or date of Transaction |
originatorId - String
|
originator id of Event. |
originators - [EntityModel!]
|
Associated originator Entity. Use originatorsV2 instead. Make sure to adhere to the new schema for originatorsV2. Removal on v5.0.0.
|
originatorsV2 - OriginatorsV2
|
Associated originators to an event. |
pipelineFamilyName - String
|
pipeline family name of Event. |
postingDate - DateTime
|
Date the Transaction was posted to the account |
receiverBic - String
|
Receiving Bank Identification Code (BIC). |
receiverCorrespondent - String
|
Receiver correspondent. |
receiverCorrespondentCountry - String
|
Receiver correspondent country. |
region - String
|
Indicates whether this type of transaction is DOMESTIC, INTERNATIONAL, or - (i.e., unknown type) |
scope - String
|
The scope of the transaction. Can be EXTERNAL, CLIENT or INTERNAL |
seller - String
|
Identifiers the selling party in the transaction |
senderBic - String
|
Sender Bank Identification Code (BIC). |
senderCorrespondent - String
|
Sender correspondent. |
senderCorrespondentCountry - String
|
Sender correspondent country. |
sendingInstitution - String
|
Sending institution. |
sendingInstitutionCountry - String
|
Sending institution country. |
settlementBic - String
|
Settlement Bank Identification Code (BIC) |
settlementPlaceCountry - String
|
Settlement Place Country. |
sourceId - String
|
source id of Event. |
sourceName - String
|
Source name. |
sourceSystem - String
|
Identifier for the Source system that the Transaction came from |
sourceTable - String
|
source table name of Event. |
subtype - String!
|
Subtype of Event. |
tellerId - String
|
The teller Identification number |
transactionType - String
|
Type of transaction (e.g., wire, card, cash, etc). |
transactionTypeDescription - String
|
Description of transaction type. |
txnId - String
|
txn id of Event. |
updatedOn - DateTime
|
Updated on DateTime. |
Example
{
"accountWithInstitution": "xyz789",
"accountWithInstitutionCountry": "abc123",
"attributes": RetailBankingAttributes,
"baseCurrency": "abc123",
"beneficiaries": [EntityModel],
"beneficiariesV2": BeneficiariesV2,
"beneficiaryCustomer": "xyz789",
"beneficiaryId": "abc123",
"beneficiaryInstitution": "xyz789",
"beneficiaryInstitutionCountry": "xyz789",
"branchId": "abc123",
"buyer": "xyz789",
"cardId": "abc123",
"createdOn": "2007-12-03T10:15:30Z",
"creditDebitFlag": "xyz789",
"deletedOn": "2007-12-03T10:15:30Z",
"destinationCountry": "xyz789",
"deviceId": "abc123",
"eventDate": "2007-12-03T10:15:30Z",
"file": File,
"financialInstrumentCountry": "xyz789",
"financialInstrumentDetails": "abc123",
"financialInstrumentIsin": "xyz789",
"financialInstrumentQuantity": 123.45,
"functionalAmount": 987.65,
"functionalCurrency": "abc123",
"id": "xyz789",
"intermediary": "xyz789",
"intermediaryCountry": "xyz789",
"label": "abc123",
"orderingCustomer": "abc123",
"orderingInstitution": "xyz789",
"orderingInstitutionCountry": "abc123",
"originCountry": "abc123",
"originalAmount": 987.65,
"originalCurrency": "xyz789",
"originationDate": "2007-12-03T10:15:30Z",
"originatorId": "xyz789",
"originators": [EntityModel],
"originatorsV2": OriginatorsV2,
"pipelineFamilyName": "xyz789",
"postingDate": "2007-12-03T10:15:30Z",
"receiverBic": "xyz789",
"receiverCorrespondent": "abc123",
"receiverCorrespondentCountry": "xyz789",
"region": "xyz789",
"scope": "xyz789",
"seller": "abc123",
"senderBic": "xyz789",
"senderCorrespondent": "xyz789",
"senderCorrespondentCountry": "abc123",
"sendingInstitution": "abc123",
"sendingInstitutionCountry": "abc123",
"settlementBic": "abc123",
"settlementPlaceCountry": "xyz789",
"sourceId": "abc123",
"sourceName": "abc123",
"sourceSystem": "abc123",
"sourceTable": "abc123",
"subtype": "xyz789",
"tellerId": "abc123",
"transactionType": "xyz789",
"transactionTypeDescription": "abc123",
"txnId": "xyz789",
"updatedOn": "2007-12-03T10:15:30Z"
}