docs/api/swagger/SO_MONITORING_SWAGGER.json


1
2
3
4
5
6
7
8
9
10
11

@media only all and (prefers-color-scheme: dark) {
.highlight .hll { background-color: #49483e }
.highlight .c { color: #75715e } /* Comment */
.highlight .err { color: #960050; background-color: #1e0010 } /* Error */
.highlight .k { color: #66d9ef } /* Keyword */
.highlight .l { color: #ae81ff } /* Literal */
.highlight .n { color: #f8f8f2 } /* Name */
.highlight .o { color: #f92672 } /* Operator */
.highlight .p { color: #f8f8f2 } /* Punctuation */
.highlight .ch { color: #75715e } /* Comment.Hashbang */
.highlight .cm { color: #75715e } /* Comment.Multiline */
.highlight .cp { color: #75715e } /* Comment.Preproc */
.highlight .cpf { color: #75715e } /* Comment.PreprocFile */
.highlight .c1 { color: #75715e } /* Comment.Single */
.highlight .cs { color: #75715e } /* Comment.Special */
.highlight .gd { color: #f92672 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gi { color: #a6e22e } /* Generic.Inserted */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #75715e } /* Generic.Subheading */
.highlight .kc { color: #66d9ef } /* Keyword.Constant */
.highlight .kd { color: #66d9ef } /* Keyword.Declaration */
.highlight .kn { color: #f92672 } /* Keyword.Namespace */
.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */
.highlight .kr { color: #66d9ef } /* Keyword.Reserved */
.highlight .kt { color: #66d9ef } /* Keyword.Type */
.highlight .ld { color: #e6db74 } /* Literal.Date */
.highlight .m { color: #ae81ff } /* Literal.Number */
.highlight .s { color: #e6db74 } /* Literal.String */
.highlight .na { color: #a6e22e } /* Name.Attribute */
.highlight .nb { color: #f8f8f2 } /* Name.Builtin */
.highlight .nc { color: #a6e22e } /* Name.Class */
.highlight .no { color: #66d9ef } /* Name.Constant */
.highlight .nd { color: #a6e22e } /* Name.Decorator */
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
.highlight .ne { color: #a6e22e } /* Name.Exception */
.highlight .nf { color: #a6e22e } /* Name.Function */
.highlight .nl { color: #f8f8f2 } /* Name.Label */
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
.highlight .nx { color: #a6e22e } /* Name.Other */
.highlight .py { color: #f8f8f2 } /* Name.Property */
.highlight .nt { color: #f92672 } /* Name.Tag */
.highlight .nv { color: #f8f8f2 } /* Name.Variable */
.highlight .ow { color: #f92672 } /* Operator.Word */
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
.highlight .mb { color: #ae81ff } /* Literal.Number.Bin */
.highlight .mf { color: #ae81ff } /* Literal.Number.Float */
.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */
.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */
.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */
.highlight .sa { color: #e6db74 } /* Literal.String.Affix */
.highlight .sb { color: #e6db74 } /* Literal.String.Backtick */
.highlight .sc { color: #e6db74 } /* Literal.String.Char */
.highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */
.highlight .sd { color: #e6db74 } /* Literal.String.Doc */
.highlight .s2 { color: #e6db74 } /* Literal.String.Double */
.highlight .se { color: #ae81ff } /* Literal.String.Escape */
.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */
.highlight .si { color: #e6db74 } /* Literal.String.Interpol */
.highlight .sx { color: #e6db74 } /* Literal.String.Other */
.highlight .sr { color: #e6db74 } /* Literal.String.Regex */
.highlight .s1 { color: #e6db74 } /* Literal.String.Single */
.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */
.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #a6e22e } /* Name.Function.Magic */
.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */
.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */
.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */
.highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */
.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */
}
@media (prefers-color-scheme: light) {
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
}
{
  "version": "1.0",
  "eventType": "CREATE",
  "event": {
    "subscription": {
      "clientID": "SCO-9989752",
      "name": "cm-subscription-001"
    },
    "dataType": {
      "dataspace": "ALL",
      "dataCategory": "CM",
      "dataProvider": "CM-SERVICE",
      "schemaName": "org.onap.ncmp:cm-network-avc-event.rfc8641",
      "schemaVersion": "1.0"
    },
    "predicates": {
      "targets" :  ["CMHandle1", "CMHandle2", "CMHandle3"],
      "datastore": "passthrough-running",
      "xpath-filter": "//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/_3gpp-nr-nrm-nrcelldu:NRCellDU/ | //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// | //_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// | //_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//"
  }

}
}
{
  "swagger": "2.0",
  "info": {
    "version": "3.1.2",
    "title": "SO Monitoring APIs"
  },
  "tags": [
    {
      "name": "getProcessInstanceId"
    },
    {
      "name": "getSingleProcessInstance"
    },
    {
      "name": "getProcessDefinitionXml"
    },
    {
      "name": "getActivityInstanceDetail"
    },
    {
      "name": "getProcessInstanceVariables"
    },
    {
      "name": "getInfraActiveRequests"
    }
  ],
  "schemes": [
    "http"
  ],
  "paths": {
    "/so/monitoring/process-instance-id/{requestId}": {
      "get": {
        "tags": [
          "getProcessInstanceId"
        ],
        "summary": "Get process instance ID for given request ID",
        "description": "",
        "operationId": "getProcessInstanceId",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "requestId",
            "in": "path",
            "required": true,
            "type": "string",
            "pattern": "^(?!\\s*$).+"
          }
        ],
        "responses": {
          "200": {
            "description": "A ProcessInstanceIdDetail object",
            "schema": {
              "type": "object",
              "properties": {
                "processInstanceId": {
                  "type": "string",
                  "description": "The process instance ID"
                }
              }
            }
          },
          "204": {
            "description": "Unable to find process instance id for given request ID."
          },
          "400": {
            "description": "Unable to find process instance id for given request ID."
          },
          "500": {
            "description": "Unable to find process instance id for given request ID."
          }
        }
      }
    },
    "/so/monitoring/process-instance/{processInstanceId}": {
      "get": {
        "tags": [
          "getSingleProcessInstance"
        ],
        "summary": "Get process instance for given process instance ID",
        "description": "",
        "operationId": "getSingleProcessInstance",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "processInstanceId",
            "in": "path",
            "required": true,
            "type": "string",
            "pattern": "^(?!\\s*$).+"
          }
        ],
        "responses": {
          "200": {
            "description": "A ProcessInstanceDetail object",
            "schema": {
              "type": "object",
              "properties": {
                "processInstanceId": {
                  "type": "string",
                  "description": "The process instance ID"
                },
                "processDefinitionId": {
                  "type": "string",
                  "description": "The process definition ID"
                },
                "processDefinitionName": {
                  "type": "string",
                  "description": "The process definition name"
                },
                "superProcessInstanceId": {
                  "type": "string",
                  "description": "The super process instance ID"
                }
              }
            }
          },
          "204": {
            "description": "Unable to find process instance for given process instance ID."
          },
          "400": {
            "description": "Unable to find process instance for given process instance ID."
          },
          "500": {
            "description": "Unable to find process instance  for given process instance ID."
          }
        }
      }
    },
    "/so/monitoring/process-definition/{processDefinitionId}": {
      "get": {
        "tags": [
          "getProcessDefinitionXml"
        ],
        "summary": "Get process definition for given process definition ID",
        "description": "",
        "operationId": "getProcessDefinitionXml",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "processDefinitionId",
            "in": "path",
            "required": true,
            "type": "string",
            "pattern": "^(?!\\s*$).+"
          }
        ],
        "responses": {
          "200": {
            "description": "A ProcessDefinitionDetail object",
            "schema": {
              "type": "object",
              "properties": {
                "processDefinitionId": {
                  "type": "string",
                  "description": "The process definition ID"
                },
                "processDefinitionXml": {
                  "type": "string",
                  "description": "The process definition XML"
                }
              }
            }
          },
          "204": {
            "description": "Unable to find process definition xml for given process definition ID."
          },
          "400": {
            "description": "Unable to find process definition xml for given process definition ID."
          },
          "500": {
            "description": "Unable to find process definition xml for given process definition ID."
          }
        }
      }
    },
    "/so/monitoring/activity-instance/{processInstanceId}": {
      "get": {
        "tags": [
          "getActivityInstanceDetail"
        ],
        "summary": "Get activity instance details for given process instance ID",
        "description": "",
        "operationId": "getActivityInstanceDetail",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "processInstanceId",
            "in": "path",
            "required": true,
            "type": "string",
            "pattern": "^(?!\\s*$).+"
          }
        ],
        "responses": {
          "200": {
            "description": "A ActivityInstanceDetail object",
            "schema": {
              "type": "array",
              "items": {
                "properties": {
                  "activityId": {
                    "type": "string",
                    "description": "The activity ID"
                  },
                  "activityName": {
                    "type": "string",
                    "description": "The activity name"
                  },
                  "activityType": {
                    "type": "string",
                    "description": "The activity type"
                  },
                  "processInstanceId": {
                    "type": "string",
                    "description": "The process instance ID"
                  },
                  "calledProcessInstanceId": {
                    "type": "string",
                    "description": "The sub-process instance ID"
                  },
                  "startTime": {
                    "type": "string",
                    "description": "The process execution start time"
                  },
                  "endTime": {
                    "type": "string",
                    "description": "The process execution end time"
                  },
                  "durationInMilliseconds": {
                    "type": "string",
                    "description": "The process execution duration in ms"
                  }
                }
              }
            }
          },
          "204": {
            "description": "Unable to find process instance variables for given process instance ID."
          },
          "400": {
            "description": "Unable to find process instance variables for given process instance ID."
          },
          "500": {
            "description": "Unable to find process instance variables for given process instance ID."
          }
        }
      }
    },
    "/so/monitoring/variable-instance/{processInstanceId}": {
      "get": {
        "tags": [
          "getProcessInstanceVariables"
        ],
        "summary": "Get process instance variables for given process instance ID",
        "description": "",
        "operationId": "getProcessInstanceVariables",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "processInstanceId",
            "in": "path",
            "required": true,
            "type": "string",
            "pattern": "^(?!\\s*$).+"
          }
        ],
        "responses": {
          "200": {
            "description": "A ProcessInstanceVariableDetail object",
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The variable name"
                },
                "value": {
                  "type": "object",
                  "description": "The variable value"
                },
                "type": {
                  "type": "string",
                  "description": "The variable type"
                }
              }
            }
          },
          "204": {
            "description": "Unable to find activity instance for given process instance ID."
          },
          "400": {
            "description": "Unable to find activity instance for given process instance ID."
          },
          "500": {
            "description": "Unable to find activity instance for given process instance ID."
          }
        }
      }
    },
    "/so/monitoring/v1/search": {
      "post": {
        "tags": [
          "getInfraActiveRequests"
        ],
        "summary": "Search infra active request for given parameter map and parameters",
        "description": "",
        "operationId": "getInfraActiveRequests",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "filters",
            "required": true,
            "schema": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          {
            "in": "query",
            "name": "from",
            "required": true,
            "type": "number"
          },
          {
            "in": "query",
            "name": "to",
            "required": true,
            "type": "number"
          },
          {
            "in": "query",
            "name": "maxResult",
            "required": false,
            "type": "number"
          }
        ],
        "responses": {
          "200": {
            "description": "A SoInfraRequest object",
            "schema": {
              "type": "array",
              "items": {
                "properties": {
                  "requestId": {
                    "type": "string",
                    "description": "The request ID"
                  },
                  "serviceInstanceId": {
                    "type": "string",
                    "description": "The service instance ID"
                  },
                  "serviceIstanceName": {
                    "type": "string",
                    "description": "The service instance name"
                  },
                  "networkId": {
                    "type": "string",
                    "description": "The network ID"
                  },
                  "requestStatus": {
                    "type": "string",
                    "description": "The request status"
                  },
                  "serviceType": {
                    "type": "string",
                    "description": "The service type"
                  },
                  "startTime": {
                    "type": "string",
                    "description": "The process execution start time"
                  },
                  "endTime": {
                    "type": "string",
                    "description": "The process execution send time"
                  }
                }
              }
            }
          },
          "204": {
            "description": "Unable to find search request for given filter and parameters."
          },
          "400": {
            "description": "Unable to find search request for given filter and parameters"
          },
          "500": {
            "description": "Unable to find search request for given filter and parameters"
          }
        }
      }
    }
  }
}