Postman.json - Developer Documentation
Skip to content

Postman.json

{
  "info": {
    "_postman_id": "a8db02e6-0d2c-433f-aca1-475eed567875",
    "name": "Event Analytics API",
    "description": "Contains exemples fo Event Analytics API endpoints.\nCreated: 21.06.2018",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "/matchEventPatterns",
      "event": [
        {
          "listen": "test",
          "script": {
            "id": "f240743b-4932-48b3-a895-4af713daba1b",
            "exec": [
              ""
            ],
            "type": "text/javascript"
          }
        },
        {
          "listen": "prerequest",
          "script": {
            "id": "7bd69147-dd5b-4ff0-be75-73211918cee2",
            "exec": [
              "pm.request.headers = pm.request.headers.all()",
              "    .filter(headerObj => { return headerObj.key != \"Cookie\";})",
              "    ",
              "pm.environment.set(\"COOKIES\", \"XSRF-TOKEN=\"+pm.environment.get(\"XSRF-TOKEN\")+\"; \"+\"SESSION=\"+pm.environment.get(\"SESSION\"))"
            ],
            "type": "text/javascript"
          }
        }
      ],
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "X-XSRF-TOKEN",
            "value": "{{XSRF-TOKEN}}"
          },
          {
            "key": "Cookie",
            "value": "{{COOKIES}}",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\r\n  \"maxPatternInterval\": 200000,\r\n  \"patternsList\": [\r\n    {\r\n      \"pattern\": [\r\n        {\r\n          \"eventText\": \"INTRODUCING FUEL\",\r\n          \"minRepetitions\": 1,\r\n          \"maxRepetitions\": 2\r\n        },\r\n        {\r\n          \"eventText\": \"Status@Flame On\",\r\n          \"minRepetitions\": 0,\r\n          \"maxRepetitions\": 1\r\n        },\r\n        {\r\n          \"eventText\": \"Module STOP due to parameter assignment\",\r\n          \"minRepetitions\": 1,\r\n          \"maxRepetitions\": 1\r\n        }\r\n      ]\r\n    },\r\n    {\r\n      \"pattern\": [\r\n        {\r\n          \"eventText\": \"Downloading the module database causes module .. restart\",\r\n          \"minRepetitions\": 1,\r\n          \"maxRepetitions\": 1\r\n        },\r\n        {\r\n          \"eventText\": \"The SIMATIC mode was selected for time-of-day synchronization of the module with Id: ..\",\r\n          \"minRepetitions\": 1,\r\n          \"maxRepetitions\": 1\r\n        }\r\n      ]\r\n    }\r\n  ],\r\n  \"nonEvents\": [\r\n    \"Error 2.. occurred\",\r\n    \"STOPPING ENGINE\"\r\n  ],\r\n  \"eventsInput\": {\r\n    \"eventsMetadata\": {\r\n      \"eventTextPropertyName\": \"text\"\r\n    },\r\n    \"events\": [\r\n      {\r\n        \"_time\": \"2017-10-01T12:00:00.001Z\",\r\n        \"text\": \"Downloading the module database causes module 11 restart\",\r\n        \"text_qc\": 0\r\n      },\r\n      {\r\n        \"_time\": \"2017-10-01T12:00:01.001Z\",\r\n        \"text\": \"The direction for forwarding the time of day is recognized automatically by the module\",\r\n        \"text_qc\": 0\r\n      },\r\n      {\r\n        \"_time\": \"2017-10-01T12:00:02.001Z\",\r\n        \"text\": \"Status@Flame On\",\r\n        \"text_qc\": 0\r\n      },\r\n      {\r\n        \"_time\": \"2017-10-01T12:00:03.001Z\",\r\n        \"text\": \"The SIMATIC mode was selected for time-of-day synchronization of the module with Id: 33\",\r\n        \"text_qc\": 0\r\n      },\r\n      {\r\n        \"_time\": \"2017-10-01T12:00:06.001Z\",\r\n        \"text\": \"INTRODUCING FUEL\",\r\n        \"text_qc\": 0\r\n      },\r\n      {\r\n        \"_time\": \"2017-10-01T12:00:09.001Z\",\r\n        \"text\": \"Module STOP due to parameter assignment\",\r\n        \"text_qc\": 0\r\n      }\r\n    ]\r\n  }\r\n}"
        },
        "url": {
          "raw": "https://{{TENANT}}-analytics.{{MINDGATE}}/api/eventanalytics/v3/matchEventPatterns",
          "protocol": "https",
          "host": [
            "{{TENANT}}-analytics",
            "{{MINDGATE}}"
          ],
          "path": [
            "api",
            "eventanalytics",
            "v3",
            "matchEventPatterns"
          ]
        },
        "description": "Integ matchPatterns"
      },
      "response": []
    },
    {
      "name": "/findTopEvents",
      "event": [
        {
          "listen": "prerequest",
          "script": {
            "id": "3a8d3da1-1650-4313-b7f3-d88067392cdc",
            "exec": [
              "pm.request.headers = pm.request.headers.all()",
              "    .filter(headerObj => { return headerObj.key != \"Cookie\";})",
              "    ",
              "pm.environment.set(\"COOKIES\", \"XSRF-TOKEN=\"+pm.environment.get(\"XSRF-TOKEN\")+\"; \"+\"SESSION=\"+pm.environment.get(\"SESSION\"))"
            ],
            "type": "text/javascript"
          }
        }
      ],
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "X-XSRF-TOKEN",
            "value": "{{XSRF-TOKEN}}"
          },
          {
            "key": "Cookie",
            "value": "{{COOKIES}}",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\r\n  \"eventsMetadata\": {\r\n    \"eventTextPropertyName\": \"text\"\r\n  },\r\n  \"events\": [\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:00.001Z\",\r\n      \"text\": \"INTRODUCING FUEL\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:01.001Z\",\r\n      \"text\": \"Status@Flame On\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:02.001Z\",\r\n      \"text\": \"Status@Flame On\",\r\n      \"text_qc\": 0\r\n    }\r\n  ],\r\n  \"numberOfTopPositionsRequired\": 5\r\n}"
        },
        "url": {
          "raw": "https://{{TENANT}}-analytics.{{MINDGATE}}/api/eventanalytics/v3/findTopEvents",
          "protocol": "https",
          "host": [
            "{{TENANT}}-analytics",
            "{{MINDGATE}}"
          ],
          "path": [
            "api",
            "eventanalytics",
            "v3",
            "findTopEvents"
          ]
        },
        "description": "Integ matchPatterns"
      },
      "response": []
    },
    {
      "name": "/removeDuplicateEvents",
      "event": [
        {
          "listen": "prerequest",
          "script": {
            "id": "43894697-8eb9-4ec9-b1bb-9c752c6dcdda",
            "exec": [
              "pm.request.headers = pm.request.headers.all()",
              "    .filter(headerObj => { return headerObj.key != \"Cookie\";})",
              "    ",
              "pm.environment.set(\"COOKIES\", \"XSRF-TOKEN=\"+pm.environment.get(\"XSRF-TOKEN\")+\"; \"+\"SESSION=\"+pm.environment.get(\"SESSION\"))"
            ],
            "type": "text/javascript"
          }
        }
      ],
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "X-XSRF-TOKEN",
            "value": "{{XSRF-TOKEN}}"
          },
          {
            "key": "Cookie",
            "value": "{{COOKIES}}",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\r\n  \"eventsMetadata\": {\r\n    \"eventTextPropertyName\": \"text\",\r\n    \"splitInterval\": 5000\r\n  },\r\n  \"events\": [\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:00.001Z\",\r\n      \"text\": \"INTRODUCING FUEL\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:01.001Z\",\r\n      \"text\": \"Status@Flame On\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:02.001Z\",\r\n      \"text\": \"Status@Flame Off\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:03.001Z\",\r\n      \"text\": \"Error code: 340\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:04.001Z\",\r\n      \"text\": \"Error code: 340\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:06.001Z\",\r\n      \"text\": \"INTRODUCING FUEL\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:08.001Z\",\r\n      \"text\": \"Status@Flame On\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:09.001Z\",\r\n      \"text\": \"Status@Flame Off\",\r\n      \"text_qc\": 0\r\n    }\r\n  ]\r\n}"
        },
        "url": {
          "raw": "https://{{TENANT}}-analytics.{{MINDGATE}}/api/eventanalytics/v3/removeDuplicateEvents",
          "protocol": "https",
          "host": [
            "{{TENANT}}-analytics",
            "{{MINDGATE}}"
          ],
          "path": [
            "api",
            "eventanalytics",
            "v3",
            "removeDuplicateEvents"
          ]
        },
        "description": "Integ matchPatterns"
      },
      "response": []
    },
    {
      "name": "/countEvents",
      "event": [
        {
          "listen": "prerequest",
          "script": {
            "id": "c9c92c58-e1a4-4c05-91ce-6f7c976cd6b8",
            "exec": [
              "pm.request.headers = pm.request.headers.all()",
              "    .filter(headerObj => { return headerObj.key != \"Cookie\";})",
              "    ",
              "pm.environment.set(\"COOKIES\", \"XSRF-TOKEN=\"+pm.environment.get(\"XSRF-TOKEN\")+\"; \"+\"SESSION=\"+pm.environment.get(\"SESSION\"))"
            ],
            "type": "text/javascript"
          }
        }
      ],
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "X-XSRF-TOKEN",
            "value": "{{XSRF-TOKEN}}"
          },
          {
            "key": "Cookie",
            "value": "{{COOKIES}}",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\r\n  \"eventsMetadata\": {\r\n    \"eventTextPropertyName\": \"text\",\r\n    \"splitInterval\": 5000\r\n  },\r\n  \"events\": [\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:00.001Z\",\r\n      \"text\": \"INTRODUCING FUEL\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:01.001Z\",\r\n      \"text\": \"Status@Flame On\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:02.001Z\",\r\n      \"text\": \"Status@Flame Off\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:03.001Z\",\r\n      \"text\": \"Error code: 340\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:04.001Z\",\r\n      \"text\": \"Error code: 340\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:06.001Z\",\r\n      \"text\": \"INTRODUCING FUEL\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:08.001Z\",\r\n      \"text\": \"Status@Flame On\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:09.001Z\",\r\n      \"text\": \"Status@Flame Off\",\r\n      \"text_qc\": 0\r\n    }\r\n  ]\r\n}"
        },
        "url": {
          "raw": "https://{{TENANT}}-analytics.{{MINDGATE}}/api/eventanalytics/v3/countEvents",
          "protocol": "https",
          "host": [
            "{{TENANT}}-analytics",
            "{{MINDGATE}}"
          ],
          "path": [
            "api",
            "eventanalytics",
            "v3",
            "countEvents"
          ]
        }
      },
      "response": []
    },
    {
      "name": "/filterEvents",
      "event": [
        {
          "listen": "prerequest",
          "script": {
            "id": "ab4bf286-c8c3-4b07-8b09-b6ddc688d751",
            "exec": [
              "pm.request.headers = pm.request.headers.all()",
              "    .filter(headerObj => { return headerObj.key != \"Cookie\";})",
              "    ",
              "pm.environment.set(\"COOKIES\", \"XSRF-TOKEN=\"+pm.environment.get(\"XSRF-TOKEN\")+\"; \"+\"SESSION=\"+pm.environment.get(\"SESSION\"))"
            ],
            "type": "text/javascript"
          }
        },
        {
          "listen": "test",
          "script": {
            "id": "c96ea138-9d35-4aa0-b4b3-6ddc34daeaf4",
            "exec": [
              ""
            ],
            "type": "text/javascript"
          }
        }
      ],
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "X-XSRF-TOKEN",
            "value": "{{XSRF-TOKEN}}"
          },
          {
            "key": "Cookie",
            "value": "{{COOKIES}}",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\r\n  \"eventsMetadata\": {\r\n    \"eventTextPropertyName\": \"text\"\r\n  },\r\n  \"events\": [\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:00.001Z\",\r\n      \"text\": \"INTRODUCING FUEL\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:01.001Z\",\r\n      \"text\": \"Status@Flame On\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:02.001Z\",\r\n      \"text\": \"Status@Flame Off\",\r\n      \"text_qc\": 0\r\n    },\r\n    {\r\n      \"_time\": \"2017-10-01T12:00:03.001Z\",\r\n      \"text\": \"Error code: 340\",\r\n      \"text_qc\": 0\r\n    }\r\n  ],\r\n  \"filterList\": [\r\n    \"INTRODUCING FUEL\",\r\n    \"MEANINGLESS ALARM\",\r\n    \"Status@Flame On\"\r\n  ]\r\n}"
        },
        "url": {
          "raw": "https://{{TENANT}}-analytics.{{MINDGATE}}/api/eventanalytics/v3/filterEvents",
          "protocol": "https",
          "host": [
            "{{TENANT}}-analytics",
            "{{MINDGATE}}"
          ],
          "path": [
            "api",
            "eventanalytics",
            "v3",
            "filterEvents"
          ]
        }
      },
      "response": []
    }
  ],
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "id": "d57a7730-627a-4661-9751-27bc642aa5f3",
        "type": "text/javascript",
        "exec": [
          ""
        ]
      }
    },
    {
      "listen": "test",
      "script": {
        "id": "0bb6c088-0078-41ac-a75e-4d0d95e61c8f",
        "type": "text/javascript",
        "exec": [
          ""
        ]
      }
    }
  ]
}

Last update: October 7, 2021

Except where otherwise noted, content on this site is licensed under the Development License Agreement.