The REST API provides the following methods for monitoring components:

Components

GET /api/components

URI

GET /api/components

Description

Retrieves the identifiers of the communication points, filters and routes in all lockers that the user has view permissions for. Returns the identifier, UUID, name and current state.
Request Header Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_1+json
Accept: application/vnd.orchestral.rhapsody.6_4+json

Request Body

 Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
  "data": {
    "id": 0,
    "uuid": "e575bcad-01b3-44eb-bbf6-b36c693ef58b",
    "name": "",
    "childFolders": [
      {
        "id": 23,
        "uuid": "009b1edb-416a-497a-a5d7-d0374fe58ae3",
        "name": "New Folder",
        "childFolders": [],
        "childComponents": [
          {
            "id": 9,
            "uuid": "9aa81528-4bd0-4173-bacd-ff48725492c1",
            "name": "NewRoute",
            "state": "STOPPED",
            "type": "ROUTE",
            "childComponents":[]
          }
        ]
      }
    ],
    "childComponents": [
      {
        "id": 1,
        "uuid": "5a8984c8-16d4-49bb-b2b0-2697f85a38f8",
        "name": "Sink",
        "state": "STOPPED",
        "type": "COMMUNICATION_POINT"
      },
      {
        "id": 2,
        "uuid":"1ec62533-b690-4b9c-ba23-1782ae562c1e",
        "name": "Timer",
        "state": "STOPPED",
        "type": "COMMUNICATION_POINT"
      },
      {
        "id": 3,
        "uuid": "a0d64cdd-d849-4ce3-984d-acd73cbb8f5b",
        "name": "NewRoute",
        "state": "STOPPED",
        "type": "ROUTE",
        "childComponents":[
      {
        "id":"5",
        "uuid","a0d64cdd-d849-4ce3-984d-acd73cbb8f5b/52d2220b-60d1-427d-8ef3-1ec11333568a",
        "name":"filter1",
        "state":"NONE",
        "type":"FILTER"
      }
    ]
      }
    ]
  },
  "error": null
}

Access Rights

'View components REST API'.
'View locker'.

GET /api/components/status

URI

GET /api/components/status

Description

Retrieves the identifiers of the communication points and routes in all lockers that the user has view permissions for. Returns the identifier, UUID, name and current state, and the inbound, outbound and failed queue sizes for communication points.

Request Header

Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_1+json
Accept: application/vnd.orchestral.rhapsody.6_4+json
Accept: application/vnd.orchestral.rhapsody.6_5+json

Request Body

 Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
  "data": {
    "id": 0,
    "uuid": "e575bcad-01b3-44eb-bbf6-b36c693ef58b",
    "name": "",
    "childFolders": [],
    "childComponents": [
      {
        "id": 649,
        "uuid": "fcb47b1e-bbec-402d-88d5-a7cd524d311c",
        "name": "Web Service Client",
        "state": "STOPPED",
        "type": "COMMUNICATION_POINT",
        "inboundQueueSize": 0,
        "outboundQueueSize": 0,
        "failedQueueSize": 0
      },
      {
        "id": 650,
        "uuid": "929648e3-d036-4b70-93ef-c5603757b262",
        "name": "Web Service Hosting",
        "state": "STOPPED",
        "type": "COMMUNICATION_POINT",
        "inboundQueueSize": 0,
        "outboundQueueSize": 8,
        "failedQueueSize": 0
      },
      {
        "id": 647,
        "uuid": "6e2bb75f-d9c3-4864-b891-17ad43759c7d",
        "name": "Timer",
        "state": "STOPPED",
        "type": "COMMUNICATION_POINT",
        "inboundQueueSize": 12,
        "outboundQueueSize": 0,
        "failedQueueSize": 0
      },
      {
        "id": 646,
        "uuid": "5a8984c8-16d4-49bb-b2b0-2697f85a38f8",
        "name": "Sink",
        "state": "STOPPED",
        "type": "COMMUNICATION_POINT",
        "inboundQueueSize": 0,
        "outboundQueueSize": 0,
        "failedQueueSize": 0
      },
      {
        "id": 643,
        "uuid": "9aa81528-4bd0-4173-bacd-ff48725492c1",
        "name": "NewRoute",
        "state": "STOPPED",
        "type": "ROUTE"
      },
      {
        "id": 642,
        "uuid": "2026839a-d0a0-4089-aeec-c45611aace2a",
        "name": "Directory",
        "state": "STOPPED",
        "type": "COMMUNICATION_POINT",
        "inboundQueueSize": 0,
        "outboundQueueSize": 0,
        "failedQueueSize": 0
      }
    ]
  },
  "error": null
}

Access Rights

'View components REST API'.
'View locker'.

POST /api/components/find

URI

POST /api/components/find

Description

Retrieves the identifier of a locker, folder, communication point, filter or route that is identified by the given <path> parameter.

Request Header

Accept: text/plain
Content-Type: text/plain
CSRF Protection Enabled

Request Body

The full path to the locker, folder, communication point, filter or route with lockers and folders separated using a forward slash, for example locker/folder/route1. The path is case sensitive.
Response Status

200 OK - operation successful.

Response Body

The identifier of the locker, folder, communication point, filter or route.

Access Rights

'View components REST API'.
'View locker'.

GET api/components/registeredports

URI

GET api/components/registeredports

Description

Retrieves a list of the ports in use by standard components in the engine.

Only ports used by components that have a configurable port number are displayed.
Request Header Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_3+json

Accept: application/vnd.orchestral.rhapsody.6_5+json
Request Parameter type - remote, local, or all. This parameter is optional and defaults to all.

Request Body

 Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
  "data": [
    {
      "id": -1,
      "port": 3041,
      "type": "Local"
    },
    {
      "id": 28,
      "name": "TCP Server 2",
      "folderPath": "New Locker",
      "port": 80,
      "portVariable": "$(localPort)",
      "type": "Local"
    },
    {
      "id": -1,
      "port": 8444,
      "type": "Local"
    },
    {
      "id": 27,
      "name": "TCP Server",
      "folderPath": "New Locker",
      "port": 8080,
      "type": "Local"
    },
    {
      "id": -1,
      "port": 8500,
      "type": "Local"
    },
    {
      "id": 42,
      "name": "TCP Client",
      "folderPath": "New Locker",
      "port": 22,
      "type": "Remote"
    }
  ],
  "error": null
}

Access Rights

'View components REST API'.
'View locker'.

Communication Points

GET /api/commpoint/<id>

URI

GET /api/commpoint/<id>

Description

Retrieves the information for a communication point with the given identifier or UUID. Returns the identifier, UUID, name, mode, type, path, state, inbound queue size, outbound queue size, failed queue size, received count, sent count, failed count, input idle time, output idle time, and schedule.

Request Header

Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_1+json
Accept: application/vnd.orchestral.rhapsody.6_2_4+json
Accept: application/vnd.orchestral.rhapsody.6_4+json
Accept: application/vnd.orchestral.rhapsody.6_5+json

Request Body

 Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
  "data": {
    "id": 1,
    "uuid": "5a8984c8-16d4-49bb-b2b0-2697f85a38f8"
    "name": "Sink",
    "folderPath": "New Folder/New Folder",
    "mode": "OUTPUT",
    "state": "RUNNING",
    "commPointType": "Sink",
    "inQueueSize": null,
    "inputIdleTime": "PT1.959S",
    "outQueueSize": 0,
    "outputIdleTime": "PT1.952S",
    "failedQueueSize": 0,
    "failedIdleTime": "PT1.952S",
    "uptime": "PT1.959S",
    "connectionCount": 1,
    "receivedCount": null,
    "sentCount": 263,
    "failedCount": 75,
    "schedule" {
      "active": true,
      "startCronExpressions":["0 0 0 ? * MON"],
      "stopCronExpressions":["0 0 0 ? * MON"],
      "restartCronExpressions":[]
    }
  },
  "error": null
}

Access Rights

'View communication points REST API'.
'View locker'.

GET /api/commpoint/<id>/state

URI

GET /api/commpoint/<id>/state

Description

Retrieves the state of the communication point with the given identifier. This state may be started, stopped, not configured and so forth.

Request Header

Accept: text/plain
Accept: text/vnd.orchestral.rhapsody.6_0+plain

Request Body

Empty.
Response Status

200 OK - operation successful.

Response Body

The state of the communication point (for example INITIALIZING, STOPPED, STOPPING, RUNNING, RETRYING, STARTING, NOT_CONFIGURED, DELETED, ERROR).

Access Rights

'View communication points REST API'.
'View locker'.

PUT /api/commpoint/<id>/state

URI

PUT /api/commpoint/<id>/state

Description

Accepts the new state of the communication point with the given identifier.

Request Header

Content-Type: text/plain
 CSRF Protection Enabled
Content-Type: text/vnd.orchestral.rhapsody.6_0+plain
 CSRF Protection Enabled

Request Body

The action to perform on the state of the communication point (for example START, STOP or RESTART).
Response Status

204 No Content - new state of communication point accepted.
400 Bad Request - state of an invalid type.
500 Internal Server Error - the communication point could not be changed to the new state (for example, if the communication point is not on a route).

Response Body

Empty.

Access Rights

'View communication points REST API'.
'View locker'.
'Start/stop communication points REST API'.
'Start/stop communication points' (for the communication point's locker).

GET /api/commpoint/<id>/messagecount

URI

GET /api/commpoint/<id>/messagecount

Description

Retrieves the number of sent, received and failed messages on the given communication point.

Request Header

Accept: application/json, text/html

Accept: application/vnd.orchestral.rhapsody.6_0+json

Accept: application/vnd.orchestral.rhapsody.6_5+json

Request Body

Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
  "data": {
    "received": 11,
    "sent": 0
    "failed": 1
  },
  "error": null
}

Access Rights

'View communication points REST API'.
'View locker'.

POST /api/commpoint/<id>/messagecount

URI

POST /api/commpoint/<id>/messagecount  

Description

Retrieves the number of sent, received or failed messages on the given communication point in a specified time period as per the specified sampling resolution.

This method can only provide those statistics for any specified time period and sampling resolution that are available in the statistics store. Rhapsody deletes statistics records in the statistics store over time in accordance with a statistics retention policy.

Request Header

Content-Type: application/json
 Accept: application/json
Content-Type: application/vnd.orchestral.rhapsody.6_1+json
 Accept: application/vnd.orchestral.rhapsody.6_1+json
Content-Type: application/vnd.orchestral.rhapsody.6_5+json
 Accept: application/vnd.orchestral.rhapsody.6_5+json

Request Body

The request body has the following structure:

  • messageCountType - SENT, RECEIVED or FAILED.

  • startTime.

  • endTime.

  • samplingResolution - the sampling resolution in ISO 8601 duration format, for example:

    ISO 8601 Duration Description
    PT2M  2 minutes 
    PT5M  5 minutes 
    PT1H  1 hour 
    P1D  1 day  
{
 "messageCountType":"SENT",
 "startTime":"2017-06-28T10:42:00.10",
 "endTime":"2017-06-28T10:52:00.10",
 "samplingResolution":"PT2M"
}
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
    "data": {
        "startTime": "2017-06-28T10:42:00.10",
        "endTime": "2017-06-28T10:52:00.10",
        "samplingResolution": "PT2M",
        "results": [
            {
                "time": "20170628T104230.000+1200",
                "value": 1569
            },
            {
                "time": "20170628T104430.000+1200",
                "value": 1779
            },
            {
                "time": "20170628T104630.000+1200",
                "value": 2019
            },
            {
                "time": "20170628T104830.000+1200",
                "value": 2259
            },
            {
                "time": "20170628T105030.000+1200",
                "value": 2497
            },
            {
                "time": "20170628T105200.000+1200",
                "value": 2677
            }
        ],
        "messageCountType": "SENT"
    },
    "error": null
}

Access Rights

'View communication points REST API'.
'View locker'.

GET /api/commpoint/<id>/supportnotes

URI

GET /api/commpoint/<id>/supportnotes
Description Retrieves the support notes for the communication point with a given identifier. 
Request Header Accept: text/html
Accept: application/vnd.orchestral.rhapsody.6_2+html
Request Body Empty.
Response Status

200 OK - operation successful.
Response Body

The support notes for the communication point.
Access Rights

'View support notes REST API'.
'View communication points REST API'.
'View locker'.
'View notification settings REST API'.

GET /api/commpoint/<id>/alerts/customsettings

URI GET /api/commpoint/<id>/alerts/customsettings
Description

Retrieves the custom communication point alert settings.

This method replaces GET /api/commpoint/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_5+json
Request Body Empty.
Response Status 200 OK - operation successful.
Response Body

The response body has the following structure:

Example... 
{
  "data":{
  "atAllTimesAlerts":
  [
    {
      "id": 134348912,
      "alertName": "This is a notification testing bunndle issue 3",
      "alertMnemonic": "COMPOINT_ISSUE_CLOSE_ON_USER_RESOLVE",
      "enabled": true,
      "parameters": {
        "severity": "ALARM",
        "type": "UNARY"
      }
    }{...}
  ],
  "timePeriodAlerts":
  [
    {
      "daysOfWeek":["MONDAY"],
      "startTime":{"hourOfDay":2,"minuteOfHour":0},
      "endTime":{"hourOfDay":3,"minuteOfHour":0},
      "alerts":
      [
         {
           "id": 268763137,
           "alertName": "Unexpected Message Tracking Response",
           "alertMnemonic": "MESSAGE_TRACKING_UNEXPECTED_RESPONSE",
           "enabled": true,
           "parameters": {
             "severity": "ALARM",
             "type": "UNARY"
           }
         }{...}
      ]
    }{...}
  ]}
  "error":null
}
Access Rights 'View communication points REST API'.
'View locker'.
'View notification settings REST API'.

PUT /api/commpoint/<id>/alerts/customsettings

URI

PUT /api/commpoint/<id>/alerts/customsettings
Description

Modifies the custom communication point alert settings. Replaces all settings with the ones provided in the API call.

This method replaces PUT /api/commpoint/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header Content-Type: application/json
CSRF Protection Enabled
Content-Type: application/vnd.orchestral.rhapsody.6_5+json
CSRF Protection Enabled
Request Body

The issues to update settings for:

  • atAllTimesAlerts - [array] an array of issues:
    • id - [str] issue identifier.
    • enabled - [boolean] if the issue is enabled or not.
    • parameters - [object] the issue setting parameters:
      • type - [enumerated string] the parameter type (one of UNARY, BINARY or TERNARY).
      • severity - [enumerated string] the parameter setting for UNARY types (one of WARNING or ALARM).
      • warning - [object] the warning threshold settings for BINARY and TERNARY types:
        • value - [string] the value of the warning threshold.
      • alarm - [object] the alarm threshold settings for BINARY and TERNARY types:
        • value - [string] the value of the alarm threshold.
      • sharedParam - [object] the shared parameter settings for TERNARY types:
        • value - [string] the value of the shared parameter threshold.
  • timePeriodAlerts - [array] an array of time periods:
    • daysOfWeek - [array of enumerated string] the days of the week the time period applies on (one of MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY).
    • startTime - [object] the start time of the period:
      • hourOfDay - [number] the hour of the day, between 0 and 23.
      • minuteOfHour - [number] the minute of the hour, between 0 and 59.
    • endTime - [object] the end time of the period:
      • hourOfDay - [number] the hour of the day, between 0 and 23.
      • minuteOfHour - [number] the minute of the hour, between 0 and 59.
    • alerts - [array] an array of issues, see atAllTimesAlerts for the format.

Example... 
{
"atAllTimesAlerts":
  [
    {
      "id": 134348912,
      "alertName": "This is a notification testing bunndle issue 3",
      "alertMnemonic": "COMPOINT_ISSUE_CLOSE_ON_USER_RESOLVE",
      "enabled": true,
      "parameters": {
        "severity": "ALARM",
        "type": "UNARY"
      }
    }{...}
  ],
  "timePeriodAlerts":
  [
    {
      "daysOfWeek":["MONDAY"],
      "startTime":{"hourOfDay":2,"minuteOfHour":0},
      "endTime":{"hourOfDay":3,"minuteOfHour":0},
      "alerts":
      [
         {
           "id": 268763137,
           "alertName": "Unexpected Message Tracking Response",
           "alertMnemonic": "MESSAGE_TRACKING_UNEXPECTED_RESPONSE",
           "enabled": true,
           "parameters": {
             "severity": "ALARM",
             "type": "UNARY"
           }
         }{...}
      ]
    }{...}
  ]
}
Response Status 204 No Content - operation successful.
Response Body No value is returned.
Access Rights 'View communication points REST API'.
'View locker'.
'Change notification settings REST API'.

DELETE/api/commpoint/<id>/alerts/customsettings

URI DELETE /api/commpoint/<id>/alerts/customsettings
Description

Removes the custom communication point alert settings and all time period settings.

This method replaces DELETE /api/commpoint/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header CSRF Protection Enabled
Request Body Empty.
Response Status 204 No Content - operation successful.
Response Body No value is returned.
Access Rights 'View communication points REST API'.
'View locker'.
'Change notification settings REST API'.

PUT /api/commpoint/<id>/alerts/suspend

URI PUT /api/commpoint/alerts/<id>/suspend
Description Suspends or resumes the notifications for the specified communication point.
Request Header Content-Type: application/json
CSRF Protection Enabled
Content-Type: application/vnd.orchestral.rhapsody.6_4+json
CSRF Protection Enabled
Request Body

The response body has the following structure:

    • action - [enumerated string] the action to perform (one of SUSPEND orRESUME).
    • duration - [number] the period of time to suspend for in minutes.
Examples... 
{"action":"SUSPEND", "duration":10}
{"action":"RESUME"}
Response Status 204 No Content - operation successful.
Response Body Empty.
Access Rights 'View communication points REST API'.
'View locker'.
'Suspend/resume component and issue notifications REST API'.

Routes

GET /api/route/<id>

URI

GET /api/route/<id>

Description

Retrieves the information for a route with the given identifier or UUID. Returns the identifier, UUID, name, path, state, processing queue size, waiting queue size, processed count, idle time.

You can use this method to retrieve the information for a filter with a given UUID. Due to the way filter UUIDs are determined, a filter with the UUID a0d64cdd-d849-4ce3-984d-acd73cbb8f5b/52d2220b-60d1-427d-8ef3-1ec11333568a, for example, can be accessed via GET api/route/a0d64cdd-d849-4ce3-984d-acd73cbb8f5b/filter/52d2220b-60d1-427d-8ef3-1ec11333568a. The first part of the filter UUID is the route UUID.

Request Header

 Accept: application/json

Accept: application/vnd.orchestral.rhapsody.6_1+json

Accept: application/vnd.orchestral.rhapsody.6_4+json

Request Body

 Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
  "data": {
    "id": 3,
    "uuid": "9aa81528-4bd0-4173-bacd-ff48725492c1",
    "name": "NewRoute",
    "folderPath": "",
    "state": "RUNNING",
    "idleTime": "PT7.708S",
    "processedCount": 459,
    "processingQueueSize": 0,
    "waitingQueueSize": 2
  },
  "error": null
}

Access Rights

'View routes REST API'.
'View locker'.

GET /api/route/<id>/state

URI

GET /api/route/<id>/state

Description

Retrieves the state of the route with the given identifier. This state may be started, stopped, not configured and so on.

Request Header

Accept: text/plain
Accept: text/vnd.orchestral.rhapsody.6_0+plain

Request Body

Empty.
Response Status

200 OK - operation successful.

Response Body

The state of the route (for example STOPPED, STOPPING, RUNNING, STARTING, NOT_CONFIGURED, DELETED, ERROR).

Access Rights

'View routes REST API'.
'View locker'.

PUT /api/route/<id>/state

URI

PUT /api/route/<id>/state

Description

Accepts the new state of the route with the given identifier.

Request Header

Content-Type: text/plain
 CSRF Protection Enabled
Content-Type: text/vnd.orchestral.rhapsody.6_0+plain
 CSRF Protection Enabled

Request Body

The action to perform on the state of the route (for example START, STOP or RESTART).
Response Status 204 No Content - new state of the route accepted.
400 Bad Request - state of an invalid type.
500 Internal Server Error - the route could not be changed to the new type.

Response Body

Empty.

Access Rights

'View routes REST API'.
'View locker'.
'Start/stop routes REST API'.
'Start/stop routes' (for the route's locker).

GET /api/route/<id>/messagecount

URI

GET /api/route/<id>/messagecount

Description

Retrieves the number of processed messages on the given route.

Request Header

Accept: application/json, text/html
Accept: application/vnd.orchestral.rhapsody.6_0+json

Request Body

Empty.
Response Status 200 OK - operation successful.

Response Body

The number of processed messages:

Example...

Access Rights

'View routes REST API'.
'View locker'.

POST /api/route/<id>/messagecount

URI

POST /api/route/<id>/messagecount 

Description

Retrieves the number of processed messages on the given route in a specified time period as per the specified sampling resolution.

This method can only provide those statistics for any specified time period and sampling resolution that are available in the statistics store. Rhapsody deletes statistics records in the statistics store over time in accordance with a statistics retention policy.

Request Header

Content-Type: application/json
 Accept: application/json
Content-Type: application/vnd.orchestral.rhapsody.6_1+json
 Accept: application/vnd.orchestral.rhapsody.6_1+json

Request Body

The request body has the following structure:

  • messageCountType - either SENT or RECEIVED.

  • samplingResolution - the sampling resolution in ISO 8601 duration format, for example:

    ISO 8601 Duration Description
    PT2M  2 minutes 
    PT5M  5 minutes 
    PT1H  1 hour 
    P1D  1 day  
{
  "messageCountType":"PROCESSED",
  "startTime":"2017-06-28T10:42:00.10",
  "endTime":"2017-06-28T10:52:00.10",
  "samplingResolution":"PT2M"
}
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
    "data": {
        "startTime": "2017-06-28T10:42:00.10",
        "endTime": "2017-06-28T10:52:00.10",
        "samplingResolution": "PT2M",
        "results": [
            {
                "time": "20170628T104230.000+1200",
                "value": 1569
            },
            {
                "time": "20170628T104430.000+1200",
                "value": 1779
            },
            {
                "time": "20170628T104630.000+1200",
                "value": 2019
            },
            {
                "time": "20170628T104830.000+1200",
                "value": 2259
            },
            {
                "time": "20170628T105030.000+1200",
                "value": 2497
            },
            {
                "time": "20170628T105200.000+1200",
                "value": 2677
            }
        ],
        "messageCountType": "PROCESSED"
    },
    "error": null
}

Access Rights

'View routes REST API'.
'View locker'.

GET /api/route/<id>/supportnotes

URI

GET /api/route/<id>/supportnotes
Description Retrieves the support notes for the route with a given identifier. 
Request Header Accept: text/html
Accept: application/vnd.orchestral.rhapsody.6_2+html
Request Body Empty.
Response Status

200 OK - operation successful.
Response Body

Support notes for the route. 
Access Rights

'View support notes REST API'.
'View routes REST API'.
'View locker'.
'View notification settings REST API'.

GET /api/route/<id>/filter/<id>/supportnotes

URI

GET /api/route/<id>/filter/<id>/supportnotes
Description Retrieves the support notes for the filter in the route with given identifiers. 
Request Header Accept: text/html
Accept: application/vnd.orchestral.rhapsody.6_2+html
Request Body Empty.
Response Status

200 OK - operation successful.
Response Body

Support notes for the filter. 
Access Rights

'View support notes REST API'.
'View routes REST API'.
'View locker'.
'View notification settings REST API'.

GET /api/route/<id>/alerts/customsettings

URI GET /api/route/<id>/alerts/customsettings
Description

Retrieves the custom route alert settings.

This method replaces GET /api/route/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header Accept: application/json

Accept: application/vnd.orchestral.rhapsody.6_5+json
Request Body Empty.
Response Status 200 OK - operation successful.
Response Body

The response body has the following structure:

Example... 
{
  "data":{
  "atAllTimesAlerts":
  [
    {
      "id": 402849792,
      "alertName": "Route Stopped In Error",
      "alertMnemonic": "ROUTE_STOPPED_IN_ERROR",
      "enabled": true,
      "parameters": {
        "severity": "ALARM",
        "type": "UNARY"
      }
    }{...}
  ],
  "timePeriodAlerts":
  [
    {
      "daysOfWeek":["MONDAY"],
      "startTime":{"hourOfDay":2,"minuteOfHour":0},
      "endTime":{"hourOfDay":3,"minuteOfHour":0},
      "alerts":
      [
         {
           "id": 402849797,
           "alertName": "Error Queue Message",
           "alertMnemonic": "MESSAGE_SENT_TO_ERROR_QUEUE_BY_ROUTE",
           "enabled": true,
           "parameters": {
             "severity": "ALARM",
             "type": "UNARY"
           }
         }{...}
      ]
    }{...}
  ]}
  "error":null
}
Access Rights 'View routes REST API'.
'View locker'.
'View notification settings REST API'.

PUT /api/route/<id>/alerts/customsettings

URI PUT /api/route/<id>/alerts/customsettings
Description

Modifies the custom route alert settings. Replaces all settings with the ones provided in the API call.

This method replaces PUT /api/route/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header Content-Type: application/json
CSRF Protection Enabled
Content-Type: application/vnd.orchestral.rhapsody.6_5+json
CSRF Protection Enabled
Request Body

The issues to update settings for:

  • atAllTimesAlerts - [array] an array of issues:
    • id - [str] issue identifier.
    • enabled - [boolean] if the issue is enabled or not.
    • parameters - [object] the issue setting parameters:
      • type - [enumerated string] the parameter type (one of UNARY, BINARY or TERNARY).
      • severity - [enumerated string] the parameter setting for UNARY types (one of WARNING or ALARM).
      • warning - [object] the warning threshold settings for BINARY and TERNARY types:
        • value - [string] the value of the warning threshold.
      • alarm - [object] the alarm threshold settings for BINARY and TERNARY types:
        • value - [string] the value of the alarm threshold.
      • sharedParam - [object] the shared parameter settings for TERNARY types:
        • value - [string] the value of the shared parameter threshold.
  • timePeriodAlerts - [array] an array of time periods:
    • daysOfWeek - [array of enumerated string] the days of the week the time period applies on (one of MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY).
    • startTime - [object] the start time of the period:
      • hourOfDay - [number] the hour of the day, between 0 and 23.
      • minuteOfHour - [number] the minute of the hour, between 0 and 59.
    • endTime - [object] the end time of the period:
      • hourOfDay - [number] the hour of the day, between 0 and 23.
      • minuteOfHour - [number] the minute of the hour, between 0 and 59.
    • alerts - [array] an array of issues, see atAllTimesAlerts for the format.
Example... 
{
"atAllTimesAlerts":
  [
    {
      "id": 402849792,
      "alertName": "Route Stopped In Error",
      "alertMnemonic": "ROUTE_STOPPED_IN_ERROR",
      "enabled": true,
      "parameters": {
        "severity": "ALARM",
        "type": "UNARY"
      }
    }{...}
  ],
  "timePeriodAlerts":
  [
    {
      "daysOfWeek":["MONDAY"],
      "startTime":{"hourOfDay":2,"minuteOfHour":0},
      "endTime":{"hourOfDay":3,"minuteOfHour":0},
      "alerts":
      [
         {
           "id": 402849797,
           "alertName": "Error Queue Message",
           "alertMnemonic": "MESSAGE_SENT_TO_ERROR_QUEUE_BY_ROUTE",
           "enabled": true,
           "parameters": {
             "severity": "ALARM",
             "type": "UNARY"
           }
         }{...}
      ]
    }{...}
  ]
}
Response Status 204 No Content - operation successful.
Response Body No value is returned.
Access Rights 'View routes REST API'.
'View locker'.
'Change notification settings REST API'.

DELETE/api/route/<id>/alerts/customsettings

URI DELETE /api/route/<id>/alerts/customsettings
Description

Removes the custom route alert settings and all time period settings.

This method replaces DELETE /api/route/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header CSRF Protection Enabled
Request Body Empty.
Response Status 204 No Content - operation successful.
Response Body No value is returned.
Access Rights 'View routes REST API'.
'View locker'.
'Change notification settings REST API'.

PUT /api/route/<id>/alerts/suspend

URI PUT /api/route/<id>/suspend
Description Suspends or resumes the notifications for the specified route.
Request Header Content-Type: application/json
CSRF Protection Enabled
Content-Type: application/vnd.orchestral.rhapsody.6_4+json
CSRF Protection Enabled
Request Body
    • action - [enumerated string] the action to perform (one of SUSPEND or RESUME).
    • duration - [number] the period of time to suspend for in minutes.
Examples... 
{"action":"SUSPEND", "duration":10}
{"action":"RESUME"}
Response Status 204 No Content - operation successful.
Response Body Empty.
Access Rights 'View routes REST API'.
'View locker'.
'Suspend/resume component and issue notifications REST API'.

Web Services

GET /api/webservice

URI

GET /api/webservice

Description

Retrieves the identifiers of the web services. Returns the identifier, UUID, name and current state.

Request Header

Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_1+json

Accept: application/vnd.orchestral.rhapsody.6_4+json

Request Body

 Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{
    "data": [
      {
        "id": 4,
        "uuid": "ccdeaca1-f972-4149-a613-c5cb827aa4cb",
        "name": "a",
        "state": "RETRYING",
        "type": "WEB_SERVICE"
      },
      {
        "id": 24,
        "uuid": "42fc4f9d-43ee-469d-a34d-f7a8aa30680e",
        "name": "bdfbdfb",
        "state": "NOT_CONFIGURED",
        "type": "WEB_SERVICE"
      }
    ],
    "error": null
}

Access Rights

'View web services REST API'.

POST /api/webservice/find

URI

POST /api/webservice/find

Description

Retrieves the identifier of a web service that is identified by the given <name> parameter.

Request Header

Accept: text/plain
Content-Type: text/plain
CSRF Protection Enabled

Request Body

The name of the web service, for example: Webservice1.
Response Status 200 OK - operation successful.

Response Body

The identifier of the web service or route.

Access Rights

'View web services REST API'.

GET /api/webservice/<id>

URI

GET /api/webservice/<id>

Description

Retrieves the information for a web service with the given identifier or UUID. Returns the identifier, UUID, name, state, input idle time, output idle time, uptime, received count, sent count, WSDL location.

Request Header

Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_1+json

Accept: application/vnd.orchestral.rhapsody.6_4+json

Request Body

 Empty.
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 



{
    "data":
    {
        "id": 4,
        "uuid": "ccdeaca1-f972-4149-a613-c5cb827aa4cb",
        "name": "a",
        "folderPath": "",
        "state": "RUNNING",
        "inputIdleTime": "PT7.845S",
        "outputIdleTime": null,
        "upTime": "PT7.845S",
        "retryCount": null,
        "retryingTime": null,
        "receivedCount": 0,
        "sentCount": 0,
        "wsdlLocation": "http://localhost:8333/services/a?wsdl"
    },
    "error": null
}

Access Rights

'View web services REST API'.

GET /api/webservice/<id>/state

URI

GET /api/webservice/<id>/state

Description

Retrieves the state of the web service with the given identifier. This state may be started, stopped, not configured and so on.

Request Header

Accept: text/plain
Accept: text/vnd.orchestral.rhapsody.6_0+plain

Request Body

Empty.
Response Status

200 OK - operation successful.

Response Body

The state of the web service (for example RUNNING, NOT_CONFIGURED, or RETRYING).

Access Rights

'View web services REST API'.

PUT /api/webservice/<id>/state

URI

PUT /api/webservice/<id>/state

Description

Restarts the web service with the given identifier.

Request Header

Content-Type: text/plain
CSRF Protection Enabled
Content-Type: text/vnd.orchestral.rhapsody.6_0+plain  
CSRF Protection Enabled

Request Body

The action to perform on the state of the web service. The action can only be RESTART.
Response Status 204 No Content - new state of the web service accepted.

Response Body

Empty.

Access Rights

'Restart web services REST API'.

GET /api/webservice/<id>/messagecount

URI

GET /api/webservice/<id>/messagecount

Description

Retrieves the number of sent and received messages on the given web service.

Request Header

Accept: application/json, text/html
Accept: application/vnd.orchestral.rhapsody.6_0+json

Request Body

Empty.
Response Status 200 OK - operation successful.

Response Body

The number of sent and received messages:

Access Rights

'View web services REST API'.

POST /api/webservice/<id>/messagecount

URI

POST /api/webservice/<id>/messagecount

Description

Retrieves the number of sent or received messages on the given web service in a specified time period as per the specified sampling resolution.

This method can only provide those statistics for any specified time period and sampling resolution that are available in the statistics store. Rhapsody deletes statistics records in the statistics store over time in accordance with a statistics retention policy.

Request Header

Content-Type: application/json
Accept: application/json
Content-Type: application/vnd.orchestral.rhapsody.6_1+json
Accept: application/vnd.orchestral.rhapsody.6_1+json

Request Body

The request body has the following structure:

  • messageCountType - either SENT or RECEIVED.

  • samplingResolution - the sampling resolution in ISO 8601 duration format, for example:

ISO 8601 Duration Description
PT2M  2 minutes 
PT5M  5 minutes 
PT1H  1 hour 
P1D  1 day  
{
   "messageCountType":"SENT",
   "startTime":"2016-09-22T17:01:00.000",
   "endTime":  "2016-09-22T17:03:00.000",
   "samplingResolution":"PT2M"
}
Response Status 200 OK - operation successful.

Response Body

The response body has the following structure:

Example... 
{ 
  "data":{
    "startTime":"2016-09-22T17:01:00.000",
    "endTime":  "2016-09-22T17:03:00.000",
    "samplingResolution": "PT2M",
    "messageCountType": "SENT",
    "results":[
      {
       "time": "20160922T170200.000+1200",
       "value": 45
      }
     ]
   },
  "error": null
}

Access Rights

'View web services REST API'.

GET /api/webservice/<id>/alerts/customsettings

URI GET /api/webservice/<id>/alerts/customsettings
Description

Retrieves the custom web service alert settings.

This method replaces GET /api/webservice/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header Accept: application/json
Accept: application/vnd.orchestral.rhapsody.6_5+json
Request Body Empty.
Response Status 200 OK - operation successful.
Response Body

The response body has the following structure:

Example... 
{
  "data":{
  "atAllTimesAlerts":
  [
    {
      "id": 268828674,
      "alertName": "Web Service Retrying",
      "alertMnemonic": "WEB_SERVICE_RETRYING",
      "enabled": true,
      "parameters": {
        "severity": "ALARM",
        "type": "UNARY"
      }
    }{...}
  ],
  "timePeriodAlerts":
  [
    {
      "daysOfWeek":["MONDAY"],
      "startTime":{"hourOfDay":2,"minuteOfHour":0},
      "endTime":{"hourOfDay":3,"minuteOfHour":0},
      "alerts":
      [
         {
           "id": 134610947,
           "alertName": "Web Service Connector Restarted",
           "alertMnemonic": "WEB_SERVICE_CONNECTOR_RESTARTED",
           "enabled": true,
           "parameters": {
             "severity": "ALARM",
             "type": "UNARY"
           }
         }{...}
      ]
    }{...}
  ]}
  "error":null
}
Access Rights 'View web services REST API'.
'View notification settings REST API'.

PUT /api/webservice/<id>/alerts/customsettings

URI PUT /api/webservice/<id>/alerts/customsettings
Description

Modifies the custom web service alert settings. Replaces all settings with the ones provided in the API call.

This method replaces PUT /api/webservice/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header Content-Type: application/json
CSRF Protection Enabled
Content-Type: application/vnd.orchestral.rhapsody.6_5+json
CSRF Protection Enabled
Request Body

The issues to update settings for:

  • atAllTimesAlerts - [array] an array of issues:
    • id - [str] issue identifier.
    • enabled - [boolean] if the issue is enabled or not.
    • parameters - [object] the issue setting parameters:
      • type - [enumerated string] the parameter type (one of UNARY, BINARY or TERNARY).
      • severity - [enumerated string] the parameter setting for UNARY types (one of WARNING or ALARM).
      • warning - [object] the warning threshold settings for BINARY and TERNARY types:
        • value - [string] the value of the warning threshold.
      • alarm - [object] the alarm threshold settings for BINARY and TERNARY types:
        • value - [string] the value of the alarm threshold.
      • sharedParam - [object] the shared parameter settings for TERNARY types:
        • value - [string] the value of the shared parameter threshold.
  • timePeriodAlerts - [array] an array of time periods:
    • daysOfWeek - [array of enumerated string] the days of the week the time period applies on (one of MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY).
    • startTime - [object] the start time of the period:
      • hourOfDay - [number] the hour of the day, between 0 and 23.
      • minuteOfHour - [number] the minute of the hour, between 0 and 59.
    • endTime - [object] the end time of the period:
      • hourOfDay - [number] the hour of the day, between 0 and 23.
      • minuteOfHour - [number] the minute of the hour, between 0 and 59.
    • alerts - [array] an array of issues, see atAllTimesAlerts for the format.
Example... 
{
"atAllTimesAlerts":
  [
    {
      "id": 268828674,
      "alertName": "Web Service Retrying",
      "alertMnemonic": "WEB_SERVICE_RETRYING",
      "enabled": true,
      "parameters": {
        "severity": "ALARM",
        "type": "UNARY"
      }
    }{...}
  ],
  "timePeriodAlerts":
  [
    {
      "daysOfWeek":["MONDAY"],
      "startTime":{"hourOfDay":2,"minuteOfHour":0},
      "endTime":{"hourOfDay":3,"minuteOfHour":0},
      "alerts":
      [
         {
           "id": 134610947,
           "alertName": "Web Service Connector Restarted",
           "alertMnemonic": "WEB_SERVICE_CONNECTOR_RESTARTED",
           "enabled": true,
           "parameters": {
             "severity": "ALARM",
             "type": "UNARY"
           }
         }{...}
      ]
    }{...}
  ]
}
Response Status 204 No Content - operation successful.
Response Body No value is returned.
Access Rights 'View web services REST API'.
'View notification settings REST API'.

DELETE/api/webservice/<id>/alerts/customsettings

URI DELETE /api/webservice/<id>/alerts/customsettings
Description

Removes the custom web service alert settings and all time period settings.

This method replaces DELETE /api/webservice/<id>/alerts/settings which has been deprecated as of Rhapsody 6.5.
Request Header CSRF Protection Enabled
Request Body Empty.
Response Status 204 No Content - operation successful.
Response Body No value is returned.
Access Rights 'View web services REST API'.
'Change notification settings REST API'.

PUT /api/webservice/<id>/alerts/suspend

URI PUT /api/webservice/<id>/alerts/suspend
Description Suspends or resumes the notifications for the specified web service.
Request Header Content-Type: application/json
CSRF Protection Enabled
Content-Type: application/vnd.orchestral.rhapsody.6_4+json
CSRF Protection Enabled
Request Body

The response body has the following structure:

  • action - [enumerated string] the action to perform (one of SUSPEND orRESUME).
  • duration - [number] the period of time to suspend for in minutes.
Examples... 
{"action":"SUSPEND", "duration":10}
{"action":"RESUME"}
Response Status 204 No Content - operation successful.
Response Body No value is returned.
Access Rights

'Suspend/resume component and issue notifications REST API'.
'View web services REST API'.

Folders and Lockers

PUT /api/folder/<id>/state

URI PUT /api/folder/<id>/state
Description Accepts the new state of the communication points and routes in the folder. Applies the state to all sub-folders. Can be called on the root folder.
Request Header

Content-Type: text/plain
 CSRF Protection Enabled
Content-Type: text/vnd.orchestral.rhapsody.6_2+plain
 CSRF Protection Enabled
Request Body The action to perform on the state of the folder's components (for example: START, STOP or RESTART).
Response Status 204 No Content - new state accepted for all communication points and routes.
403 Forbidden - missing the required access rights on the folder.
500 Internal Server Error - one or more communication points or routes did not accept the new state.
Response Body

A list of all components which did not accept the new state and an error message explaining the reason the new state was not accepted. If this is called on the root folder, the response may also include a list of lockers that were skipped due to missing access rights.

Example... 
{
    "failedComponents": [
      {
         "id": 351,
         "name": "Timer",
         "type": "ROUTE",
         "errorMessage": "The user has insufficient permissions to change the state of communication point 'Timer' in 'Folder 5'."
      },
      {
        "id": 352,
        "name": "Sink",
        "type": "ROUTE",
        "errorMessage": "The user has insufficient permissions to change the state of communication point 'Sink' in 'Folder 5'."
      }
    ],
    "skippedLockers": [
      {
         "id": 326,
         "name": "New Locker 6"
      },
      {
          "id": 305,
          "name": "New Locker 4"
      }
    ]
}
Access Rights 'Start/stop communication points REST API'.
'Start/stop routes REST API'.
'View locker' (for the folder).
'Start/stop communication points' (for the folder).
'Start/stop routes' (for the folder).

PUT /api/locker/<id>/state

URI PUT /api/locker/<id>/state
Description Accepts the new state of the communication points and routes in the locker. Applies the state to all sub-folders.
Request Header Content-Type: text/plain
 CSRF Protection Enabled
Content-Type: text/vnd.orchestral.rhapsody.6_2+plain
CSRF Protection Enabled
Request Body The action to perform on the state of the locker's components (for example START, STOP or RESTART).
Response Status 204 No Content - new state accepted for all communication points and routes.
403 Forbidden - missing the required access rights on the locker.
500 Internal Server Error - one or more communication points or routes did not accept the new state.
Response Body

A list of all components which did not accept the new state and an error message explaining the reason the new state was not accepted.

Example... 



{
    "failedComponents": [
      {
         "id": 351,
         "name": "Timer",
         "type": "ROUTE",
         "errorMessage": "The user has insufficient permissions to change the state of communication point 'Timer' in 'Locker 5'."
      },
      {
        "id": 352,
        "name": "Sink",
        "type": "ROUTE",
        "errorMessage": "The user has insufficient permissions to change the state of communication point 'Sink' in 'Locker 5'."
      }
    ]
}
Access Rights 'Start/stop communication points REST API'.
'Start/stop routes REST API'.
'View locker' (for the folder).
'Start/stop communication points' (for the folder).
'Start/stop routes' (for the folder).

Watchlists

GET /api/watchlists/<name>/alerts/active

URI

GET /api/watchlists/<name>/alerts/active

The <name> parameter is the URL-escaped name of the watchlist.

Description

Retrieves a list of all active alerts that are associated with components on the specified watchlist. This allows the system administrator to group components as required, and so report the alerts separately. The response body is in the same format as when retrieving alerts for the entire engine.

Request Header

Accept: application/json, text/html
Accept: application/vnd.orchestral.rhapsody.6_0+json

Request Body

Empty.
Response Status

200 OK - operation successful.

Response Body

The response body has the same JSON format as when retrieving all alerts. Refer to GET /api/alerts/active for details.

Example...

Access Rights

'View notifications REST API'.