{
  "opencollection": "1.0.0",
  "info": {
    "name": "Queue API",
    "version": "20210201"
  },
  "items": [
    {
      "info": {
        "name": "queue",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets the list of IDs of non-empty channels.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/queues/:queueId/channels",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              },
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify a consumer group."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
              },
              {
                "name": "channelFilter",
                "value": "",
                "type": "query",
                "description": "Optional parameter to filter the channels."
              }
            ]
          },
          "docs": "Gets the list of IDs of non-empty channels.\nIt will return an approximate list of IDs of non-empty channels. That information is based on the queue level statistics. \nAPI supports optional channelFilter parameter which will filter the returned results according to the specified filter.\nList of channel IDs is approximate, because statistics is refreshed once per-second, and that list represents a snapshot of the past information. API is paginated.\n"
        },
        {
          "info": {
            "name": "Consumes message from the queue.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/queues/:queueId/messages",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              },
              {
                "name": "visibilityInSeconds",
                "value": "",
                "type": "query",
                "description": "If the `visibilityInSeconds` parameter is set, messages will be hidden for `visibilityInSeconds` seconds and won't be consumable by other consumers during that time.\nIf it isn't set it defaults to the value set at the queue level.\n\nUsing a `visibilityInSeconds` value of 0 effectively acts as a peek functionality.\nMessages retrieved that way aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one.\n"
              },
              {
                "name": "timeoutInSeconds",
                "value": "",
                "type": "query",
                "description": "If the `timeoutInSeconds parameter` isn't set or it is set to a value greater than 0, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after `timeoutInSeconds` seconds (in which case it will return an empty response), whichever comes first.\n\nIf the parameter is set to 0, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not.\nIn same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The limit parameter controls how many messages is returned at-most.\n"
              },
              {
                "name": "channelFilter",
                "value": "",
                "type": "query",
                "description": "Optional parameter to filter the channels."
              },
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify a consumer group."
              }
            ]
          },
          "docs": "Consumes messages from the queue.\nYou must use the [messages endpoint](/iaas/Content/queue/messages.htm#messages__messages-endpoint) to consume messages.\nThe messages endpoint may be different for different queues. Use [`GetQueue`](#/en/queue/latest/Queue/GetQueue/) to find the queue's `messagesEndpoint`.\nGetMessages accepts optional channelFilter query parameter that can filter source channels of the messages.\nWhen channelFilter is present, service will return available messages from the channe"
        },
        {
          "info": {
            "name": "Puts messages in the queue.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20210201/queues/:queueId/messages",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Puts messages into the queue.\nYou must use the [messages endpoint](/iaas/Content/queue/messages.htm#messages__messages-endpoint) to produce messages.\nThe messages endpoint may be different for different queues. Use [`GetQueue`](#/en/queue/latest/Queue/GetQueue/) to find the queue's `messagesEndpoint`.\n"
        },
        {
          "info": {
            "name": "Deletes multiple messages from the queue.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20210201/queues/:queueId/messages/actions/deleteMessages",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              },
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify a consumer group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes multiple messages from the queue or the consumer group. Only messages from the same queue/consumer group can be deleted at once.\nYou must use the [messages endpoint](/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages.\nThe messages endpoint may be different for different queues. Use [`GetQueue`](#/en/queue/latest/Queue/GetQueue/) to find the queue's `messagesEndpoint`.\n"
        },
        {
          "info": {
            "name": "Updates multiple messages in the queue.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20210201/queues/:queueId/messages/actions/updateMessages",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              },
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify a consumer group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates multiple messages in the queue or the consumer group. Only messages from the same queue/consumer group can be updated at once.\nYou must use the [messages endpoint](/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages.\nThe messages endpoint may be different for different queues. Use [`GetQueue`](#/en/queue/latest/Queue/GetQueue/) to find the queue's `messagesEndpoint`.\n"
        },
        {
          "info": {
            "name": "Updates the visibility of a message to extend (or reduce) it.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20210201/queues/:queueId/messages/:messageReceipt",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              },
              {
                "name": "messageReceipt",
                "value": "",
                "type": "path",
                "description": "The receipt of the message retrieved from a GetMessages call."
              },
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify a consumer group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the visibility of the message represented by the receipt.\nYou must use the [messages endpoint](/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages.\nThe messages endpoint may be different for different queues. Use [`GetQueue`](#/en/queue/latest/Queue/GetQueue/) to find the queue's `messagesEndpoint`.\n"
        },
        {
          "info": {
            "name": "Deletes a message from the queue.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20210201/queues/:queueId/messages/:messageReceipt",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              },
              {
                "name": "messageReceipt",
                "value": "",
                "type": "path",
                "description": "The receipt of the message retrieved from a GetMessages call."
              },
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify a consumer group."
              }
            ]
          },
          "docs": "Deletes the message represented by the receipt from the queue.\nYou must use the [messages endpoint](/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages.\nThe messages endpoint may be different for different queues. Use [`GetQueue`](#/en/queue/latest/Queue/GetQueue/) to find the queue's `messagesEndpoint`.\n"
        },
        {
          "info": {
            "name": "Gets the statistics for the queue and its dead letter queue.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/queues/:queueId/stats",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              },
              {
                "name": "channelId",
                "value": "",
                "type": "query",
                "description": "Id to specify channel."
              },
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify a consumer group."
              }
            ]
          },
          "docs": "Gets the statistics for the queue and its dead letter queue.\nYou must use the [messages endpoint](/iaas/Content/queue/messages.htm#messages__messages-endpoint) to get a queue's statistics.\nThe messages endpoint may be different for different queues. Use [`GetQueue`](#/en/queue/latest/Queue/GetQueue/) to find the queue's `messagesEndpoint`.\n"
        }
      ]
    }
  ],
  "bundled": true
}