{
  "opencollection": "1.0.0",
  "info": {
    "name": "Factset Analytics Datastore About Status API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Status",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Factset Retrieve the status of a chat response process.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/status",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns the status of a chat response for a given chat conversation ID (recevied from the `/create` endpoint). Poll the `/status` endpoint with your conversation ID to confirm when your data is ready.\nAnswers may take minutes to generate, depending on the complexity of the query.\n"
        },
        {
          "info": {
            "name": "Factset Get Afi Optimization Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage."
        },
        {
          "info": {
            "name": "Factset Returns the Status for a Batch Request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/batch-status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Batch Request identifier."
              }
            ]
          },
          "docs": "Return the status for the underlying batch request that is specified by the id.\n\n  The Formula API supports Long Running asynchronous requests up to **20 minutes** via the `batch` parameter in the `/time-series` endpoint and up to **10 minutes** in the `/cross-sectional` endpoint.\n\n  *This feature is available to Individual Users subscribed to the Performance Package and Performance Package Plus Performance Tiers and all Production Users. If you are unsure which Performance\nTier you are subscrib"
        },
        {
          "info": {
            "name": "Factset Returns the Status for a Batch Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/v1/batch-status",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Return the status for the underlying batch request that is specified by the id.\n\n  The Formula API supports Long Running asynchronous requests up to **20 minutes** via the `batch` parameter in the `/time-series` endpoint and up to **10 minutes** in the `/cross-sectional` endpoint.\n\n  *This feature is available to Individual Users subscribed to the Performance Package and Performance Package Plus Performance Tiers and all Production Users. If you are unsure which Performance\nTier you are subscrib"
        },
        {
          "info": {
            "name": "Factset Get Fund's Current Status and Database Availability",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/factset-funds/v1/status",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs. <p>***ids limit** =  1000 per request*</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p>*\n"
              }
            ]
          },
          "docs": "Get the funds active status, share class status, and database availability. Most common use is for coverage checks and id resolution checks.\n"
        },
        {
          "info": {
            "name": "Factset Get Fund's Current Status and Database Availability for Large List of Ids.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/factset-funds/v1/status",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get the funds active status, share class status, and database availability. Most common use is for coverage checks and id resolution checks.\n"
        },
        {
          "info": {
            "name": "Factset Returns the Status for a Batch Request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/factset-global-prices/v1/batch-status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Batch Request identifier."
              }
            ]
          },
          "docs": "Return the status for the underlying batch request that is specified by the id."
        },
        {
          "info": {
            "name": "Factset Get Npo Optimization Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage."
        },
        {
          "info": {
            "name": "Factset Get Pa Calculation Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/pa/v3/calculations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run PA calculation endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage."
        },
        {
          "info": {
            "name": "Factset Get Fpo Optimization Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage."
        },
        {
          "info": {
            "name": "Factset Check the Status for a Particular Run Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/runs/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "run id"
              }
            ]
          },
          "docs": "Use this endpoint to check the status of a run using the id from the POST /runs endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Status for a Batch Request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/batch/v1/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Batch Request identifier."
              }
            ]
          },
          "docs": "Return the status for the underlying batch request that is specified by the id."
        },
        {
          "info": {
            "name": "Factset Returns the Status for a Batch Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/batch/v1/status",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Return the status for the underlying batch request that is specified by the id. "
        },
        {
          "info": {
            "name": "Factset Get Pub Calculation Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/pub/v3/calculations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the result field in the response body will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage."
        },
        {
          "info": {
            "name": "Factset Get Quant Engine Calculation Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/calculations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage."
        },
        {
          "info": {
            "name": "Factset Intraday Trading Status of a Notation.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/notation/status/get",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "query"
              },
              {
                "name": "identifierType",
                "value": "",
                "type": "query"
              },
              {
                "name": "quality",
                "value": "",
                "type": "query"
              },
              {
                "name": "_attributes",
                "value": "",
                "type": "query",
                "description": "Limit the attributes returned in the response to the specified set."
              },
              {
                "name": "_subscriptionMinimumInterval",
                "value": "",
                "type": "query",
                "description": "Minimum number of milliseconds at which updates are sent."
              }
            ]
          },
          "docs": "Intraday trading status of a notation.<br>The endpoint is subscribable to provide push updates. See attribute `_subscriptionMinimalInterval` for valid update rates."
        },
        {
          "info": {
            "name": "Factset Get Spar Calculation Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/spar/v3/calculations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url."
        },
        {
          "info": {
            "name": "Factset Returns the Status and Percentage of Completion for the Requested Jobid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/streetaccount/historical/check-status",
            "params": [
              {
                "name": "jobID",
                "value": "",
                "type": "query",
                "description": "jobID returned by the request-files endpoint to know the status and percentDone"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to return per result"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Specifies the starting point for pagination. This parameter is used to identify the   beginning of next set of results"
              }
            ]
          },
          "docs": "Need to plug-in the jobID from /request-files into /check-status endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Status of the Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level1/files/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect status of the query"
              }
            ]
          },
          "docs": "Need to plug-in the id get from /create endpoint into /status endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Status of the Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level1/files/minute-bars/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect status of the query"
              }
            ]
          },
          "docs": "Need to plug-in the id get from /create endpoint into /status endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Status of the Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level2/files/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect status of the query"
              }
            ]
          },
          "docs": "Need to plug-in the id get from /create endpoint into /status endpoint"
        },
        {
          "info": {
            "name": "PollCalculate",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v2/job/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a screen calculation job"
              }
            ]
          },
          "docs": "Polls the job with a given screen ID and returns job status"
        },
        {
          "info": {
            "name": "Factset Get Vault Calculation Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/vault/v3/calculations/:id/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url."
        }
      ]
    }
  ],
  "bundled": true
}