Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New endpoint to retrieve a transaction evaluation result #2

Closed
12 tasks done
cshezi opened this issue Jun 26, 2024 · 0 comments · Fixed by #6
Closed
12 tasks done

New endpoint to retrieve a transaction evaluation result #2

cshezi opened this issue Jun 26, 2024 · 0 comments · Fixed by #6
Assignees
@cshezi
Labels
enhancement New feature or request

Comments

@cshezi
Copy link
Contributor

cshezi commented Jun 26, 2024

Story statement

As a Fraud analyst,
I want retrieve a transaction evaluation result from ArangoDB via the Admin API
So that I can view the result of a transaction evaluation

Sequence diagram

sequenceDiagram
    participant Client as Client<br>System
    participant ADMIN as ADMIN API    
    participant DB as ArangoDB

Client ->> ADMIN: 1. Fetch evaluationResult
ADMIN->> DB: 2. Fetch evaluationResult 
DB->> ADMIN: 3. {evaluationResult} data
ADMIN->> Client: 4. {evaluationResult} data
Loading

1. Request data

Must be able to submit a request for Evaluation result data to the Admin API by specifying the MsgId

Request body:

Path: /v1/admin/reports/getreportbymsgid/{msgId}
Operation: GET
Description: List evaluationResult associated with a MsgId

Functionality:

  1. Fetch the evaluation results from the evaluationResults collection = MsgId provided
  2. If the MsgId is not provided in the path, return an error
  3. If the record identified by the MsgId does not exist in the evaluation results collection, return a error: 204 No content status

1. Response data

Anticipated sample result (NOTE: pre-channel removal) 
"transactionID": "8fc0d8e16dae455197fc86a690891897",
"transaction": {
  "TxTp": "pacs.002.001.12",
  "FIToFIPmtSts": {
    "GrpHdr": {
      "MsgId": "8fc0d8e16dae455197fc86a690891897",
      "CreDtTm": "2024-05-27T06:45:01.190Z"
    },
    "TxInfAndSts": {
      "OrgnlInstrId": "5ab4fc7355de4ef8a75b78b00a681ed2",
      "OrgnlEndToEndId": "3eb875626db14f858ef1e43ad1fef848",
      "TxSts": "ACCC",
      "ChrgsInf": [
        {
          "Amt": {
            "Amt": 0,
            "Ccy": "USD"
          },
          "Agt": {
            "FinInstnId": {
              "ClrSysMmbId": {
                "MmbId": "dfsp001"
              }
            }
          }
        },
        {
          "Amt": {
            "Amt": 0,
            "Ccy": "USD"
          },
          "Agt": {
            "FinInstnId": {
              "ClrSysMmbId": {
                "MmbId": "dfsp001"
              }
            }
          }
        },
        {
          "Amt": {
            "Amt": 0,
            "Ccy": "USD"
          },
          "Agt": {
            "FinInstnId": {
              "ClrSysMmbId": {
                "MmbId": "dfsp002"
              }
            }
          }
        }
      ],
      "AccptncDtTm": "2023-06-02T07:52:31.000Z",
      "InstgAgt": {
        "FinInstnId": {
          "ClrSysMmbId": {
            "MmbId": "dfsp001"
          }
        }
      },
      "InstdAgt": {
        "FinInstnId": {
          "ClrSysMmbId": {
            "MmbId": "dfsp002"
          }
        }
      }
    }
  }
},
"networkMap": {
  "active": true,
  "cfg": "1.0.0",
  "messages": [
    {
      "id": "004@1.0.0",
      "cfg": "1.0.0",
      "txTp": "pacs.002.001.12",
      "channels": [
        {
          "id": "001@1.0.0",
          "cfg": "1.0.0",
          "typologies": [
            {
              "id": "typology-processor@1.0.0",
              "cfg": "002@1.0.0",
              "rules": [
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "010@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "048@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "076@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "005@1.0.0",
              "rules": [
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "017@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "018@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "020@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "021@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "024@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "025@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "048@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "054@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "090@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "010@1.0.0",
              "rules": [
                {
                  "id": "006@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "017@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "048@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "091@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "024@1.0.0",
              "rules": [
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "008@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "017@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "021@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "024@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "025@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "026@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "027@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "054@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "083@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "084@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "090@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "028@1.0.0",
              "rules": [
                {
                  "id": "003@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "008@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "010@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "011@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "021@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "024@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "026@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "030@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "045@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "048@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "084@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "095@1.0.0",
              "rules": [
                {
                  "id": "006@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "007@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "008@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "024@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "026@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "076@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "098@1.0.0",
              "rules": [
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "011@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "021@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "024@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "025@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "026@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "027@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "044@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "054@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "090@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "107@1.0.0",
              "rules": [
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "017@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "021@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "054@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "083@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "084@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "090@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "129@1.0.0",
              "rules": [
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "010@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "011@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "018@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "024@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "025@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "054@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "090@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "185@1.0.0",
              "rules": [
                {
                  "id": "010@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "011@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "018@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "020@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "048@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "195@1.0.0",
              "rules": [
                {
                  "id": "003@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "011@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "045@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "214@1.0.0",
              "rules": [
                {
                  "id": "001@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "003@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "004@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "010@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "011@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "017@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "018@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "020@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "024@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "025@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "026@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "027@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "030@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "044@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "045@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "048@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "054@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "090@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "091@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            },
            {
              "id": "typology-processor@1.0.0",
              "cfg": "216@1.0.0",
              "rules": [
                {
                  "id": "002@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "010@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "011@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "016@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "017@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "054@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "063@1.0.0",
                  "cfg": "1.0.0"
                },
                {
                  "id": "090@1.0.0",
                  "cfg": "1.0.0"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
},
"report": {
  "evaluationID": "8e505eb7-db0d-4ea3-875e-51782b72b6c6",
  "metaData": {
    "prcgTmDP": 24406195,
    "traceParent": "00-ad9644e363aa6cd6de1a1bb3f4b9250b-214390c69fbd567e-01",
    "prcgTmCRSP": 4091220
  },
  "status": "NALT",
  "timestamp": "2024-05-27T06:45:57.390Z",
  "tadpResult": {
    "id": "004@1.0.0",
    "cfg": "1.0.0",
    "channelResult": [
      {
        "id": "001@1.0.0",
        "cfg": "1.0.0",
        "prcgTm": 3577647,
        "result": 0,
        "typologyResult": [
          {
            "id": "typology-processor@1.0.0",
            "cfg": "098@1.0.0",
            "result": 200,
            "ruleResults": [
              {
                "id": "026@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 21634641,
                "wght": 0
              },
              {
                "id": "021@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29189643,
                "wght": 0
              },
              {
                "id": "025@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29964117,
                "wght": 0
              },
              {
                "id": "024@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 35677575,
                "wght": 0
              },
              {
                "id": "044@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".02",
                "result": true,
                "prcgTm": 36050899,
                "wght": 200
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "027@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 37390978,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              },
              {
                "id": "011@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49988064,
                "wght": 0
              },
              {
                "id": "090@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 63108394,
                "wght": 0
              },
              {
                "id": "054@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 59658938,
                "wght": 0
              }
            ],
            "prcgTm": 11517895,
            "review": false,
            "workflow": {
              "alertThreshold": 800
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "005@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "020@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 17460669,
                "wght": 0
              },
              {
                "id": "021@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29189643,
                "wght": 0
              },
              {
                "id": "025@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29964117,
                "wght": 0
              },
              {
                "id": "024@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 35677575,
                "wght": 0
              },
              {
                "id": "017@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 41696860,
                "wght": 0
              },
              {
                "id": "018@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 48939905,
                "wght": 0
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "048@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 57252009,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              },
              {
                "id": "090@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 63108394,
                "wght": 0
              },
              {
                "id": "054@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 59658938,
                "wght": 0
              }
            ],
            "prcgTm": 28291354,
            "review": false,
            "workflow": {
              "alertThreshold": 800
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "028@1.0.0",
            "result": 400,
            "ruleResults": [
              {
                "id": "026@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 21634641,
                "wght": 0
              },
              {
                "id": "021@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29189643,
                "wght": 0
              },
              {
                "id": "010@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36957002,
                "wght": 0
              },
              {
                "id": "084@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 20942573,
                "wght": 0
              },
              {
                "id": "045@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".02",
                "result": true,
                "prcgTm": 25718258,
                "wght": 200
              },
              {
                "id": "024@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 35677575,
                "wght": 0
              },
              {
                "id": "003@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 26693342,
                "wght": 0
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "048@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 57252009,
                "wght": 0
              },
              {
                "id": "008@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36520491,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "030@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": true,
                "prcgTm": 44223416,
                "wght": 200
              },
              {
                "id": "011@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49988064,
                "wght": 0
              }
            ],
            "prcgTm": 26066601,
            "review": false,
            "workflow": {
              "alertThreshold": 900,
              "interdictionThreshold": 1000
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "095@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "006@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 20572531,
                "wght": 0
              },
              {
                "id": "026@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 21634641,
                "wght": 0
              },
              {
                "id": "024@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 35677575,
                "wght": 0
              },
              {
                "id": "076@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 47695123,
                "wght": 0
              },
              {
                "id": "007@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 31002727,
                "wght": 0
              },
              {
                "id": "008@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36520491,
                "wght": 0
              }
            ],
            "prcgTm": 25260119,
            "review": false,
            "workflow": {
              "alertThreshold": 400,
              "interdictionThreshold": 500
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "010@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "006@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 20572531,
                "wght": 0
              },
              {
                "id": "091@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 37018056,
                "wght": 0
              },
              {
                "id": "017@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 41696860,
                "wght": 0
              },
              {
                "id": "048@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 57252009,
                "wght": 0
              }
            ],
            "prcgTm": 24173248,
            "review": false,
            "workflow": {
              "alertThreshold": 300
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "185@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "020@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 17460669,
                "wght": 0
              },
              {
                "id": "010@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36957002,
                "wght": 0
              },
              {
                "id": "018@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 48939905,
                "wght": 0
              },
              {
                "id": "048@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 57252009,
                "wght": 0
              },
              {
                "id": "011@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49988064,
                "wght": 0
              }
            ],
            "prcgTm": 12463272,
            "review": false,
            "workflow": {
              "alertThreshold": 300,
              "interdictionThreshold": 400
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "002@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "010@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36957002,
                "wght": 0
              },
              {
                "id": "076@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 47695123,
                "wght": 0
              },
              {
                "id": "048@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 57252009,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              }
            ],
            "prcgTm": 25635439,
            "review": false,
            "workflow": {
              "alertThreshold": 300
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "129@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "010@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36957002,
                "wght": 0
              },
              {
                "id": "025@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29964117,
                "wght": 0
              },
              {
                "id": "024@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 35677575,
                "wght": 0
              },
              {
                "id": "018@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 48939905,
                "wght": 0
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              },
              {
                "id": "011@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49988064,
                "wght": 0
              },
              {
                "id": "090@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 63108394,
                "wght": 0
              },
              {
                "id": "054@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 59658938,
                "wght": 0
              }
            ],
            "prcgTm": 8963608,
            "review": false,
            "workflow": {
              "alertThreshold": 700
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "107@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "021@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29189643,
                "wght": 0
              },
              {
                "id": "084@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 20942573,
                "wght": 0
              },
              {
                "id": "017@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 41696860,
                "wght": 0
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              },
              {
                "id": "083@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50430987,
                "wght": 0
              },
              {
                "id": "090@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 63108394,
                "wght": 0
              },
              {
                "id": "054@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 59658938,
                "wght": 0
              }
            ],
            "prcgTm": 3567556,
            "review": false,
            "workflow": {
              "alertThreshold": 600
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "214@1.0.0",
            "result": 600,
            "ruleResults": [
              {
                "id": "020@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 17460669,
                "wght": 0
              },
              {
                "id": "026@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 21634641,
                "wght": 0
              },
              {
                "id": "010@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36957002,
                "wght": 0
              },
              {
                "id": "025@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29964117,
                "wght": 0
              },
              {
                "id": "045@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".02",
                "result": true,
                "prcgTm": 25718258,
                "wght": 200
              },
              {
                "id": "091@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 37018056,
                "wght": 0
              },
              {
                "id": "024@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 35677575,
                "wght": 0
              },
              {
                "id": "017@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 41696860,
                "wght": 0
              },
              {
                "id": "018@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 48939905,
                "wght": 0
              },
              {
                "id": "003@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 26693342,
                "wght": 0
              },
              {
                "id": "044@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".02",
                "result": true,
                "prcgTm": 36050899,
                "wght": 200
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "027@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 37390978,
                "wght": 0
              },
              {
                "id": "048@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 57252009,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              },
              {
                "id": "004@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 34005938,
                "wght": 0
              },
              {
                "id": "030@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": true,
                "prcgTm": 44223416,
                "wght": 200
              },
              {
                "id": "001@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": true,
                "prcgTm": 42768135,
                "wght": 0
              },
              {
                "id": "011@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49988064,
                "wght": 0
              },
              {
                "id": "090@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 63108394,
                "wght": 0
              },
              {
                "id": "054@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 59658938,
                "wght": 0
              }
            ],
            "prcgTm": 4171501,
            "review": false,
            "workflow": {
              "alertThreshold": 1500
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "195@1.0.0",
            "result": 200,
            "ruleResults": [
              {
                "id": "045@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".02",
                "result": true,
                "prcgTm": 25718258,
                "wght": 200
              },
              {
                "id": "003@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 26693342,
                "wght": 0
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "011@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49988064,
                "wght": 0
              }
            ],
            "prcgTm": 10549146,
            "review": false,
            "workflow": {
              "alertThreshold": 300
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "024@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "026@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 21634641,
                "wght": 0
              },
              {
                "id": "021@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29189643,
                "wght": 0
              },
              {
                "id": "025@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 29964117,
                "wght": 0
              },
              {
                "id": "084@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 20942573,
                "wght": 0
              },
              {
                "id": "024@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 35677575,
                "wght": 0
              },
              {
                "id": "017@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 41696860,
                "wght": 0
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "027@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 37390978,
                "wght": 0
              },
              {
                "id": "008@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36520491,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              },
              {
                "id": "083@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50430987,
                "wght": 0
              },
              {
                "id": "090@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 63108394,
                "wght": 0
              },
              {
                "id": "054@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 59658938,
                "wght": 0
              }
            ],
            "prcgTm": 6614512,
            "review": false,
            "workflow": {
              "alertThreshold": 900
            }
          },
          {
            "id": "typology-processor@1.0.0",
            "cfg": "216@1.0.0",
            "result": 0,
            "ruleResults": [
              {
                "id": "010@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 36957002,
                "wght": 0
              },
              {
                "id": "017@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 41696860,
                "wght": 0
              },
              {
                "id": "016@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 50797013,
                "wght": 0
              },
              {
                "id": "063@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49726350,
                "wght": 0
              },
              {
                "id": "002@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 51215907,
                "wght": 0
              },
              {
                "id": "011@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 49988064,
                "wght": 0
              },
              {
                "id": "090@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".01",
                "result": false,
                "prcgTm": 63108394,
                "wght": 0
              },
              {
                "id": "054@1.0.0",
                "cfg": "1.0.0",
                "subRuleRef": ".x01",
                "result": false,
                "prcgTm": 59658938,
                "wght": 0
              }
            ],
            "prcgTm": 3414472,
            "review": false,
            "workflow": {
              "alertThreshold": 500
            }
          }
        ]
      }
    ],
    "prcgTm": 8413061
  }
}

Acceptance criteria

  1. Create a new Admin API to retrieve a transaction evaluationResult from ArangoDB via the Admin API.
  2. Add Swagger document and use for request validation (if any)

Checklist

  • Create Fasify API and Github repository set basic branch rules
  • Define the new endpoint for retrieving the report using msgid as parameter
  • Add logic for getting report
  • Attach swagger documentation
  • Create JSON Schema for the report and validate the response
  • Validate incoming request
  • Dockerizing
  • docs: Create diagrams and put them in Images folder
  • docs: Create an overview, and detailed documentation
  • Create unit tests
  • Add code formatting plugins i.e prettier, eslint
  • Ensure husky is attached and it runs code formatting plugns for pre-commit and unit test for pre-push

Testing guidelines

  1. Pass in a request body with a MsgId
  2. Verify the correct response body
  3. Test for a request without an MsgId and with an invalid/unknown MsgId
@cshezi cshezi added the enhancement New feature or request label Jun 26, 2024
@cshezi cshezi self-assigned this Jun 26, 2024
@cshezi cshezi linked a pull request Jun 26, 2024 that will close this issue
Init branch #1
Closed
12 tasks
@cshezi cshezi mentioned this issue Jun 26, 2024
Closed
12 tasks
@cshezi cshezi linked a pull request Jun 27, 2024 that will close this issue
Get report route #6
Merged
11 tasks
@cshezi cshezi removed a link to a pull request Jun 27, 2024
Init branch #1
Closed
12 tasks
@cshezi cshezi closed this as completed in #6 Jun 27, 2024
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cshezi cshezi

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Get report route frmscoe/admin-service
1 participant
@cshezi