docs/api/swagger/SO_MONITORING_SWAGGER.yaml

   1 swagger: '2.0'
   2 info:
   3   version: 3.1.2
   4   title: SO Monitoring APIs
   5 tags:
   6 - name: getProcessInstanceId
   7 - name: getSingleProcessInstance
   8 - name: getProcessDefinitionXml
   9 - name: getActivityInstanceDetail
  10 - name: getProcessInstanceVariables
  11 - name: getInfraActiveRequests
  12 schemes:
  13 - http
  14 paths:
  15   /so/monitoring/process-instance-id/{requestId}:
  16     get:
  17       tags:
  18       - getProcessInstanceId
  19       summary: Get process instance ID for given request ID
  20       description: ''
  21       operationId: getProcessInstanceId
  22       consumes:
  23       - application/json
  24       produces:
  25       - application/json
  26       - application/xml
  27       parameters:
  28       - name: requestId
  29         in: path
  30         required: true
  31         type: string
  32         pattern: ^(?!\s*$).+
  33       responses:
  34         200:
  35           description: A ProcessInstanceIdDetail object
  36           schema:
  37             type: object
  38             properties:
  39               processInstanceId:
  40                 type: string
  41                 description: The process instance ID
  42         204:
  43           description: Unable to find process instance id for given request ID.
  44         400:
  45           description: Unable to find process instance id for given request ID.
  46         500:
  47           description: Unable to find process instance id for given request ID.
  48   /so/monitoring/process-instance/{processInstanceId}:
  49     get:
  50       tags:
  51       - getSingleProcessInstance
  52       summary: Get process instance for given process instance ID
  53       description: ''
  54       operationId: getSingleProcessInstance
  55       consumes:
  56       - application/json
  57       produces:
  58       - application/json
  59       - application/xml
  60       parameters:
  61       - name: processInstanceId
  62         in: path
  63         required: true
  64         type: string
  65         pattern: ^(?!\s*$).+
  66       responses:
  67         200:
  68           description: A ProcessInstanceDetail object
  69           schema:
  70             type: object
  71             properties:
  72               processInstanceId:
  73                 type: string
  74                 description: The process instance ID
  75               processDefinitionId:
  76                 type: string
  77                 description: The process definition ID
  78               processDefinitionName:
  79                 type: string
  80                 description: The process definition name
  81               superProcessInstanceId:
  82                 type: string
  83                 description: The super process instance ID
  84         204:
  85           description: Unable to find process instance for given process instance ID.
  86         400:
  87           description: Unable to find process instance for given process instance ID.
  88         500:
  89           description: Unable to find process instance  for given process instance ID.
  90   /so/monitoring/process-definition/{processDefinitionId}:
  91     get:
  92       tags:
  93       - getProcessDefinitionXml
  94       summary: Get process definition for given process definition ID
  95       description: ''
  96       operationId: getProcessDefinitionXml
  97       consumes:
  98       - application/json
  99       produces:
 100       - application/json
 101       - application/xml
 102       parameters:
 103       - name: processDefinitionId
 104         in: path
 105         required: true
 106         type: string
 107         pattern: ^(?!\s*$).+
 108       responses:
 109         200:
 110           description: A ProcessDefinitionDetail object
 111           schema:
 112             type: object
 113             properties:
 114               processDefinitionId:
 115                 type: string
 116                 description: The process definition ID
 117               processDefinitionXml:
 118                 type: string
 119                 description: The process definition XML
 120         204:
 121           description: Unable to find process definition xml for given process definition ID.
 122         400:
 123           description: Unable to find process definition xml for given process definition ID.
 124         500:
 125           description: Unable to find process definition xml for given process definition ID.
 126   /so/monitoring/activity-instance/{processInstanceId}:
 127     get:
 128       tags:
 129       - getActivityInstanceDetail
 130       summary: Get activity instance details for given process instance ID
 131       description: ''
 132       operationId: getActivityInstanceDetail
 133       consumes:
 134       - application/json
 135       produces:
 136       - application/json
 137       - application/xml
 138       parameters:
 139       - name: processInstanceId
 140         in: path
 141         required: true
 142         type: string
 143         pattern: ^(?!\s*$).+
 144       responses:
 145         200:
 146           description: A ActivityInstanceDetail object
 147           schema:
 148             type: array
 149             items:
 150               properties:
 151                 activityId:
 152                   type: string
 153                   description: The activity ID
 154                 activityName:
 155                   type: string
 156                   description: The activity name
 157                 activityType:
 158                   type: string
 159                   description: The activity type
 160                 processInstanceId:
 161                   type: string
 162                   description: The process instance ID
 163                 calledProcessInstanceId:
 164                   type: string
 165                   description: The sub-process instance ID
 166                 startTime:
 167                   type: string
 168                   description: The process execution start time
 169                 endTime:
 170                   type: string
 171                   description: The process execution end time
 172                 durationInMilliseconds:
 173                   type: string
 174                   description: The process execution duration in ms
 175         204:
 176           description: Unable to find process instance variables for given process instance ID.
 177         400:
 178           description: Unable to find process instance variables for given process instance ID.
 179         500:
 180           description: Unable to find process instance variables for given process instance ID.
 181   /so/monitoring/variable-instance/{processInstanceId}:
 182     get:
 183       tags:
 184       - getProcessInstanceVariables
 185       summary: Get process instance variables for given process instance ID
 186       description: ''
 187       operationId: getProcessInstanceVariables
 188       consumes:
 189       - application/json
 190       produces:
 191       - application/json
 192       - application/xml
 193       parameters:
 194       - name: processInstanceId
 195         in: path
 196         required: true
 197         type: string
 198         pattern: ^(?!\s*$).+
 199       responses:
 200         200:
 201           description: A ProcessInstanceVariableDetail object
 202           schema:
 203             type: object
 204             properties:
 205               name:
 206                 type: string
 207                 description: The variable name
 208               value:
 209                 type: object
 210                 description: The variable value
 211               type:
 212                 type: string
 213                 description: The variable type
 214         204:
 215           description: Unable to find activity instance for given process instance ID.
 216         400:
 217           description: Unable to find activity instance for given process instance ID.
 218         500:
 219           description: Unable to find activity instance for given process instance ID.
 220   /so/monitoring/v1/search:
 221     post:
 222       tags:
 223       - getInfraActiveRequests
 224       summary: Search infra active request for given parameter map and parameters
 225       description: ''
 226       operationId: getInfraActiveRequests
 227       consumes:
 228       - application/json
 229       produces:
 230       - application/json
 231       - application/xml
 232       parameters:
 233       - in: body
 234         name: filters
 235         required: true
 236         schema:
 237           type: object
 238           additionalProperties:
 239             type: string
 240       - in: query
 241         name: from
 242         required: true
 243         type: number
 244       - in: query
 245         name: to
 246         required: true
 247         type: number
 248       - in: query
 249         name: maxResult
 250         required: false
 251         type: number
 252       responses:
 253         200:
 254           description: A SoInfraRequest object
 255           schema:
 256             type: array
 257             items:
 258               properties:
 259                 requestId:
 260                   type: string
 261                   description: The request ID
 262                 serviceInstanceId:
 263                   type: string
 264                   description: The service instance ID
 265                 serviceIstanceName:
 266                   type: string
 267                   description: The service instance name
 268                 networkId:
 269                   type: string
 270                   description: The network ID
 271                 requestStatus:
 272                   type: string
 273                   description: The request status
 274                 serviceType:
 275                   type: string
 276                   description: The service type
 277                 startTime:
 278                   type: string
 279                   description: The process execution start time
 280                 endTime:
 281                   type: string
 282                   description: The process execution send time
 283         204:
 284           description: Unable to find search request for given filter and parameters.
 285         400:
 286           description: Unable to find search request for given filter and parameters
 287         500:
 288           description: Unable to find search request for given filter and parameters