{
  "opencollection": "1.0.0",
  "info": {
    "name": "Announcements Service Announcement API",
    "version": "0.0.1"
  },
  "items": [
    {
      "info": {
        "name": "announcement",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists announcements for the tenancy.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20180904/announcements",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return in a paginated \"List\" call."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The value of the `opc-next-page` response header from the previous \"List\" call."
              },
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment.\n"
              },
              {
                "name": "announcementType",
                "value": "",
                "type": "query",
                "description": "The type of announcement."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "The announcement's current lifecycle state."
              },
              {
                "name": "isBanner",
                "value": "",
                "type": "query",
                "description": "Whether the announcement is displayed as a console banner."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The criteria to sort by. You can specify only one sort order.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use. (Sorting by `announcementType` orders the announcements list according to importance.)\n"
              },
              {
                "name": "timeOneEarliestTime",
                "value": "",
                "type": "query",
                "description": "The boundary for the earliest `timeOneValue` date on announcements that you want to see."
              },
              {
                "name": "timeOneLatestTime",
                "value": "",
                "type": "query",
                "description": "The boundary for the latest `timeOneValue` date on announcements that you want to see."
              },
              {
                "name": "environmentName",
                "value": "",
                "type": "query",
                "description": "A filter to return only announcements that match a specific environment name."
              },
              {
                "name": "service",
                "value": "",
                "type": "query",
                "description": "A filter to return only announcements affecting a specific service."
              },
              {
                "name": "platformType",
                "value": "",
                "type": "query",
                "description": "A filter to return only announcements affecting a specific platform."
              },
              {
                "name": "excludeAnnouncementTypes",
                "value": "",
                "type": "query",
                "description": "Exclude The type of announcement."
              },
              {
                "name": "shouldShowOnlyLatestInChain",
                "value": "",
                "type": "query",
                "description": "A filter to display only the latest announcement in a chain."
              },
              {
                "name": "chainId",
                "value": "",
                "type": "query",
                "description": "A filter to return only announcements belonging to the specified announcement chain ID."
              }
            ]
          },
          "docs": "Gets a list of announcements for the current tenancy.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given "
        },
        {
          "info": {
            "name": "Gets information about an announcement.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20180904/announcements/:announcementId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "announcementId",
                "value": "",
                "type": "path",
                "description": "The OCID of the announcement."
              }
            ]
          },
          "docs": "Gets the details of a specific announcement.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.\n"
        },
        {
          "info": {
            "name": "Gets the compartment details of an announcement.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20180904/announcements/:announcementId/compartment",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "announcementId",
                "value": "",
                "type": "path",
                "description": "The OCID of the announcement."
              }
            ]
          },
          "docs": "Gets the compartment details of an announcement.\n"
        },
        {
          "info": {
            "name": "Gets the read status of an announcement.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20180904/announcements/:announcementId/userStatus",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "announcementId",
                "value": "",
                "type": "path",
                "description": "The OCID of the announcement."
              }
            ]
          },
          "docs": "Gets information about whether a specific announcement was acknowledged by a user.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 req"
        },
        {
          "info": {
            "name": "Updates the read status of an announcement.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20180904/announcements/:announcementId/userStatus",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "announcementId",
                "value": "",
                "type": "path",
                "description": "The OCID of the announcement."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the status of the specified announcement with regard to whether it has been marked as read.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operation"
        }
      ]
    }
  ],
  "bundled": true
}