{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference Accounting Codes Data Queries API",
    "version": "2023-12-15"
  },
  "items": [
    {
      "info": {
        "name": "Data Queries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List data query jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/query/jobs",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "queryStatus",
                "value": "",
                "type": "query",
                "description": "Filters the list of query jobs by status.\n"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of records returned per page in the response.\n"
              }
            ]
          },
          "docs": "Returns a list of [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) jobs that have been created in your Zuora tenant. You can filter the list by status.\n\nIf you are an administrator, you can retrieve all the query jobs in your tenant. Otherwise, you can only retrieve your own query jobs.\n"
        },
        {
          "info": {
            "name": "Submit a data query",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/query/jobs",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              },
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ]
          },
          "docs": "Submits a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to be performed by Zuora and creates a query job. You can use [Retrieve a data query job](#operation/GET_DataQueryJob) to track the status of the query job and obtain the URL of the query results.\n"
        },
        {
          "info": {
            "name": "Retrieve a data query job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/query/jobs/:job-id",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "job-id",
                "value": "",
                "type": "path",
                "description": "Internal identifier of the query job.\n"
              }
            ]
          },
          "docs": "Retrieves a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job. You can use this operation to track the status of the query job and obtain the URL of the query results.\n\nIf you are an administrator, you can retrieve every query job in your tenant. \n\nIf you are a non-admin user and try to retrieve a query job that you are not the owner of, you will get a 403 response indicating that you are forbidden from viewing this job. As a non-admin user, you can only retrieve yo"
        },
        {
          "info": {
            "name": "Cancel a data query job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/query/jobs/:job-id",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "job-id",
                "value": "",
                "type": "path",
                "description": "Internal identifier of the query job.\n"
              }
            ]
          },
          "docs": "Cancels a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is `accepted` or `in_progress`.\n"
        }
      ]
    }
  ],
  "bundled": true
}