{
  "opencollection": "1.0.0",
  "info": {
    "name": "Factset Analytics Datastore About Tenant API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Tenant",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Factset Lists All Datasources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/data-sources",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "_sort",
                "value": "",
                "type": "query",
                "description": "The column to sort on. Append - to sort in descending order. If parameter is not given, no sorting will be done"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Non-negative maximum number of entries to return. Default is 25"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Non-negative number of entries to skip. Default is 0"
              }
            ]
          },
          "docs": "List all datasources the user has permission to see"
        },
        {
          "info": {
            "name": "Factset Gets a Datasource",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/data-sources/:dataSourceCode",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "dataSourceCode",
                "value": "",
                "type": "path",
                "description": "The code of the datasource"
              }
            ]
          },
          "docs": "Gets a datasource based on the code passed"
        },
        {
          "info": {
            "name": "Factset Gets the Data for the Datasource",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/data-sources/:dataSourceCode/data",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "dataSourceCode",
                "value": "",
                "type": "path",
                "description": "The code of the datasource"
              },
              {
                "name": "entityCodes",
                "value": "",
                "type": "query",
                "description": "A series of query parameter used to filter the data for a datasource. This represents the entities for the datasource. E.g.: entityCodes=ACCOUNT&entityCodes=FUNDS"
              },
              {
                "name": "entityKeys",
                "value": "",
                "type": "query",
                "description": "A series of query parameter used to filter the data for a datasource. This is the entity key value for an entity selection. E.g.: entityKeys=1&entityKeys=Test2"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Non-negative maximum number of entries to return. Default is 25"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Non-negative number of entries to skip. Default is 0"
              }
            ]
          },
          "docs": "Gets the data for the datasource. There are optional query parameters to filter the data"
        },
        {
          "info": {
            "name": "Factset Gets the Entity Values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/entities/:entityCode/values",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "entityCode",
                "value": "",
                "type": "path",
                "description": "The code of the entity"
              },
              {
                "name": "_sort",
                "value": "",
                "type": "query",
                "description": "The entity field to sort on. Can only be sorted on entity key, description or secondary key fields. Append \"-\" to sort in descending order. If no parameter given, it will be sorted by key field in ascending order by default"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Non-negative maximum number of entries to return. Default is 25"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Non-negative number of entries to skip. Default is 0"
              },
              {
                "name": "showAll",
                "value": "",
                "type": "query",
                "description": "Whether to show all field values for each entity row. Value should either be 1 or 0. Default is 0 (false)"
              }
            ]
          },
          "docs": "Gets the entity values for the specified entity"
        },
        {
          "info": {
            "name": "Factset Gets All Report Definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/reports",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "_sort",
                "value": "",
                "type": "query",
                "description": "The column to sort on. Can add - to sort"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Non-negative maximum number of entries to return"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Non-negative number of entries to skip"
              }
            ]
          },
          "docs": "Gets all report definitions the user has permissions for"
        },
        {
          "info": {
            "name": "Factset Gets a Report Definition",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/reports/:reportDefinitionCode",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "reportDefinitionCode",
                "value": "",
                "type": "path",
                "description": "The code of the report definition"
              }
            ]
          },
          "docs": "Gets a report defintion based on the code specified"
        },
        {
          "info": {
            "name": "Factset Gets a Report Instance Based on the Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/report-instances/:reportInstanceId",
            "params": [
              {
                "name": "reportInstanceId",
                "value": "",
                "type": "path",
                "description": "The ID of the report instance"
              },
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              }
            ]
          },
          "docs": "Gets a report instance object based on the ID passed"
        },
        {
          "info": {
            "name": "Factset Cancels a Report Generation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.factset.com/v1/:tenant/report-instances/:reportInstanceId",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "reportInstanceId",
                "value": "",
                "type": "path",
                "description": "The id of the report instance"
              }
            ]
          },
          "docs": "Sends a request to cancel a report generation based on the report instance id passed"
        },
        {
          "info": {
            "name": "Factset Gets a List of Report Instances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/report-instances",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "reportDefinitionCode",
                "value": "",
                "type": "query",
                "description": "Acts as a filter for the retrieval process. Filters the report instances that match the report definition code"
              },
              {
                "name": "entityCodes",
                "value": "",
                "type": "query",
                "description": "A series of query parameters used to filter the report instances by entity code. E.g: entityCode=DATE&entityCode=SYSTEM_LANG"
              },
              {
                "name": "entityKeys",
                "value": "",
                "type": "query",
                "description": "A series of query parameters used to filter the report instances by entity keys. E.g: entityKey=en-gb"
              },
              {
                "name": "sectionFilter",
                "value": "",
                "type": "query",
                "description": "Acts as a filter for the retrieval process. Filters the report instances that match the section filter"
              },
              {
                "name": "outputFormat",
                "value": "",
                "type": "query",
                "description": "Acts as a filter for the retrieval process. Filters the report instances that match the output format"
              },
              {
                "name": "_sort",
                "value": "",
                "type": "query",
                "description": "The column to sort on. Append - to sort in descending order. If parameter is not given, sorting will be based on the report instance id in descending order"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Non-negative maximum number of entries to return"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Non-negative number of entries to skip"
              }
            ]
          },
          "docs": "Gets a list of report instances. This can be filtered down further by including query parameters in the URL. For example, a report definition id can be added so the only report instances returned are the ones with a matching id"
        },
        {
          "info": {
            "name": "Factset Gets the Generated File",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/report-instances/:reportInstanceId/results/:reportFileName",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "reportInstanceId",
                "value": "",
                "type": "path",
                "description": "Used to validate that report file name belongs to the report instance passed"
              },
              {
                "name": "reportFileName",
                "value": "",
                "type": "path",
                "description": "The report file name that has to be retrieved. report file name. E.g: xyz.pdf"
              }
            ]
          },
          "docs": "Get the generated file for a report instance. Users can fetch the generated report once the genration is finished. The report instance id and the report file name are passed in as path paramters"
        },
        {
          "info": {
            "name": "Factset Gets a List of Logs for the Report Instance Generation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/v1/:tenant/report-instances/:reportInstanceId/logs",
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "path",
                "description": "The code of the tenancy"
              },
              {
                "name": "reportInstanceId",
                "value": "",
                "type": "path",
                "description": "Used to validate that report file name belongs to the report instance passed"
              },
              {
                "name": "errorsOnly",
                "value": "",
                "type": "query",
                "description": "If the parameter is set to true the endpoint should return just errors and warnings E.g: errorsOnly=true"
              },
              {
                "name": "_sort",
                "value": "",
                "type": "query",
                "description": "The column to sort on. Can add - to sort"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Non-negative maximum number of entries to return"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Non-negative number of entries to skip"
              }
            ]
          },
          "docs": "Gets a list of logs for the generated report instance. Allows the user to sort on log message, type and date. Also allows for retrieving of just the errors & warnings'"
        }
      ]
    }
  ],
  "bundled": true
}