{
  "opencollection": "1.0.0",
  "info": {
    "name": "Queue Queue Admin API",
    "version": "20210201"
  },
  "items": [
    {
      "info": {
        "name": "queueAdmin",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a list of all consumer groups in a queue",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/consumerGroups",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources their lifecycleState matches the given lifecycleState."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The unique consumer group identifier."
              },
              {
                "name": "queueId",
                "value": "",
                "type": "query",
                "description": "The unique queue identifier."
              },
              {
                "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": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
              }
            ]
          },
          "docs": "Returns a list of consumer groups.\n"
        },
        {
          "info": {
            "name": "Creates a new consumer group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20210201/consumerGroups",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new consumer group.\n"
        },
        {
          "info": {
            "name": "Get the consumer group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/consumerGroups/:consumerGroupId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "path",
                "description": "The unique consumer group identifier."
              }
            ]
          },
          "docs": "Gets a consumer group by identifier."
        },
        {
          "info": {
            "name": "Update the consumer group identified by the id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20210201/consumerGroups/:consumerGroupId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "path",
                "description": "The unique consumer group identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified consumer group."
        },
        {
          "info": {
            "name": "Deletes a consumer group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20210201/consumerGroups/:consumerGroupId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumerGroupId",
                "value": "",
                "type": "path",
                "description": "The unique consumer group identifier."
              }
            ]
          },
          "docs": "Deletes a consumer group resource by identifier."
        },
        {
          "info": {
            "name": "Gets a list of all Queues in a compartment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/queues",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources their lifecycleState matches the given lifecycleState."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The unique queue identifier."
              },
              {
                "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": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
              }
            ]
          },
          "docs": "Returns a list of queues.\n"
        },
        {
          "info": {
            "name": "Creates a new Queue",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20210201/queues",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new queue.\n"
        },
        {
          "info": {
            "name": "Get Queue",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/queues/:queueId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              }
            ]
          },
          "docs": "Gets a queue by identifier."
        },
        {
          "info": {
            "name": "Update the Queue identified by the id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20210201/queues/:queueId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified queue."
        },
        {
          "info": {
            "name": "Delete a provisioned Queue",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20210201/queues/:queueId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              }
            ]
          },
          "docs": "Deletes a queue resource by identifier."
        },
        {
          "info": {
            "name": "Moves a resource into a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20210201/queues/:queueId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource."
        },
        {
          "info": {
            "name": "Deletes all messages present in the queue at the time of invocation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20210201/queues/:queueId/actions/purge",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "The unique queue identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes all messages present in the queue or in the specified consumer group, or deletes all the messages in the specific channel at the time of invocation. \nOnly one concurrent purge operation is supported for any given queue. \nHowever multiple concurrent purge operations are supported for different queues.\nPurge request without specification of target channels will clean up all messages in the queue and in the child channels.    \nPurge request without specification of consumer group will eithe"
        },
        {
          "info": {
            "name": "List Work Requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/workRequests",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
              },
              {
                "name": "workRequestId",
                "value": "",
                "type": "query",
                "description": "The ID of the asynchronous work request."
              },
              {
                "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": "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)."
              }
            ]
          },
          "docs": "Lists the work requests in a compartment.\n"
        },
        {
          "info": {
            "name": "GET Work Request Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/workRequests/:workRequestId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              }
            ]
          },
          "docs": "Gets the status of the work request with the given ID."
        },
        {
          "info": {
            "name": "Lists work request errors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/workRequests/:workRequestId/errors",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              },
              {
                "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": "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)."
              }
            ]
          },
          "docs": "Return a (paginated) list of errors for a given work request.\n"
        },
        {
          "info": {
            "name": "Lists work request logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20210201/workRequests/:workRequestId/logs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              },
              {
                "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": "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)."
              }
            ]
          },
          "docs": "Return a (paginated) list of logs for a given work request.\n"
        }
      ]
    }
  ],
  "bundled": true
}