GET /api/alerts

Returns information about alerts for the specified resource, in the form of an RSS channel.

Authorization Roles/Permissions: Login is not required, but the results returned are restricted according to the visibility permissions of the user performing the operation.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/alerts

Sample Request

The example below shows a request for alert information, with a specific Alert ID, with comments included.

Sample Request URL

https://{hostname}/api/alerts?ItemID=alert10805.acmepaymentscorp&IncludeComments=true

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Request Parameters

Response

If successful, this operation returns HTTP status code 200, with the requested information about alerts

Sample Response

The sample response below shows successful completion of this operation. This example is the response to the sample request above.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Wed, 13 May 2015 13:56:28 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "",
    "link" : "../acmepaymentscorp#/forum/alerts",
    "description" : "",
    "startIndex" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "title" : "Scheduled outage",
      "description" : "There will be a scheduled outage for 1 hour, **Sun 26 July 2015 3am to 4am EST**. Please plan accordingly.",
      "category" : [ {
        "value" : "ALERT",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "outage",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "July",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "Critical",
        "domain" : "uddi:soa.com:alertpriority"
      }, {
        "value" : "Production",
        "domain" : "uddi:soa.com:alertenvironment"
      }, {
        "value" : "text/markdown",
        "domain" : "uddi:soa.com:descriptionmediatype"
      }, {
        "value" : "com.soa.board.item.closed",
        "domain" : "uddi:soa.com:state"
      } ],
      "guid" : {
        "value" : "alert10805.acmepaymentscorp"
      },
      "pubDate" : "Wed, 13 May 2015 18:54:35 +0000",
      "BoardItemArtifacts" : {
        "BoardItemArtifact" : [ ]
      },
      "AuthoringUser" : {
        "ID" : "c11635de-8403-4567-a26d-8824517bdde1.acmepaymentscorp",
        "Name" : "adminacmepaymentscorp",
        "Image" : {
          "Url" : "http://{hostname}/api/users/c11635de-8403-4567-a26d-8824517bdde1.acmepaymentscorp/avatar",
          "Title" : "adminacmepaymentscorp",
          "Link" : "#/users/c11635de-8403-4567-a26d-8824517bdde1.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "http://{hostname}/api/users/c11635de-8403-4567-a26d-8824517bdde1.acmepaymentscorp/avatar"
      },
      "CreatedDate" : "Wed, 13 May 2015 18:48:19 +0000",
      "Marks" : {
        "Count" : 2,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 1,
        "Comment" : [ {
          "CommentID" : "c85134ed-48c0-489b-8ef3-e7ef1cb02038.acmepaymentscorp",
          "CommentSubjectID" : "alert10805.acmepaymentscorp",
          "Content" : "Thanks for letting us know!",
          "Created" : "2015-05-13T18:50:43Z",
          "Marks" : 1,
          "IsMarked" : false,
          "UserID" : "f2bfb3d7-02cb-49dc-ac9a-c82b192c476a.acmepaymentscorp",
          "UserName" : "JaneMead",
          "AvatarURL" : "http://{hostname}/api/users/f2bfb3d7-02cb-49dc-ac9a-c82b192c476a.acmepaymentscorp/avatar",
          "Published" : true,
          "MediaType" : "text/plain",
          "BoardItemArtifacts" : {
            "BoardItemArtifact" : [ ]
          }
        } ]
      },
      "EntityReference" : [ {
        "Title" : "ACME Payments API",
        "Guid" : "2548b53b-e947-4d49-9467-ecb76d52f42c.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "1.0",
        "Guid" : "b6e256f7-1af5-42d1-bcbe-81b33affe2ef.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The channel includes paging values: StartIndex, TotalResults, and ItemsPerPage. Each item in the channel represents an alert, and includes the information listed below.

"value" : "outage",
"domain" : "uddi:soa.com:tag"

"value" : "text/markdown",
"domain" : "uddi:soa.com:descriptionmediatype"

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

More information about Akana API Platform API error messages.

Related Topics