{
  "opencollection": "1.0.0",
  "info": {
    "name": "Factset Analytics Datastore About Fields API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Fields",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "listUserDefinedFieldGroups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/user-defined-field-group",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Return only files whose name includes this query"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Number of groups to return"
              },
              {
                "name": "_paginationCursor",
                "value": "",
                "type": "query",
                "description": "Cursor used for paging.  Fetch items after the specified cursor"
              }
            ]
          },
          "docs": "List user defined groups"
        },
        {
          "info": {
            "name": "readUserDefinedGroup",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/user-defined-field-group/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique identifer for the group to be read."
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Number of fields to list from this group"
              },
              {
                "name": "_paginationCursor",
                "value": "",
                "type": "query",
                "description": "Cursor used for paging.  Fetch fields after the specified cursor"
              }
            ]
          },
          "docs": "Read a specific user defined field group and list its fields."
        },
        {
          "info": {
            "name": "listUserDefinedFields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/user-defined-field",
            "params": [
              {
                "name": "database",
                "value": "",
                "type": "query",
                "description": "Database where the fields are defined."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Return only fields whose name includes this query"
              },
              {
                "name": "group",
                "value": "",
                "type": "query",
                "description": "Return only fields whose group includes this query"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Number of fields to return"
              },
              {
                "name": "_paginationCursor",
                "value": "",
                "type": "query",
                "description": "Cursor used for paging.  Fetch items after the specified cursor"
              }
            ]
          },
          "docs": "List user defined fields"
        },
        {
          "info": {
            "name": "readUserDefinedField",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/user-defined-field/:id",
            "params": [
              {
                "name": "id",
                "value": "270c2fa8-9110-444b-9101-17e10132fe0a",
                "type": "path",
                "description": "Unique identifier of the user defined field to be read"
              }
            ]
          },
          "docs": "Read a user defined field"
        },
        {
          "info": {
            "name": "Factset Available Private Company Fields, Metrics, and Ratios.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/factset-private-markets/v1/fields",
            "params": [
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Filters the list of available fields per endpoint  -\n  * **FINANCIALS** = Financials endpoint data items, such as Assets, Liabilities, and EBITDA.\n  * **NON_PERIODIC** = Non-Periodic endpoint data items, such as ISO Currency, Current CEO, and Investor List.\n"
              }
            ]
          },
          "docs": "Returns list of available Private Company fields that can be used in the `fields` parameter of related endpoints. These are related to FactSet Private Company standardized data.\n"
        },
        {
          "info": {
            "name": "Factset Available Fields for /terms-and-conditions Endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/factset-terms-and-conditions/v1/fields",
            "params": [
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Filters the list of Fixed Income metrics by major category -\n  * **SECURITY_DETAILS** = Detailed information about the security.\n  * **COUPON_DETAILS** = Coupon details.\n  * **CONVERTIBLE_FEATURES** = Features of convertible instruments.\n  * **REDEMPTION_OPTIONS** = Redemption options.\n"
              }
            ]
          },
          "docs": "Returns a list of available fields that can be used in the `fields`\nparameter of the **/terms-and-conditions** endpoint.\nLeave _category_ blank to request all available items.\nMake Note, this does not represent all available fields within the Terms and Conditions API and all other endpoints.\n"
        }
      ]
    }
  ],
  "bundled": true
}