{
  "opencollection": "1.0.0",
  "info": {
    "name": "Factset Analytics Datastore About Groups API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Factset Gets an Object Given an Id. in This Case Id Retrieved From Mapping Location Header, Object Data in Response Body.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/pub-datastore/cargo/v1/groups/:groupId/objects/:objectId",
            "params": [
              {
                "name": "groupId",
                "value": "a4186c50f8e74f979d271dd22298c901",
                "type": "path",
                "description": "The ID of the group"
              },
              {
                "name": "objectId",
                "value": "fe875bc4150542dea6bc237663a01a0d",
                "type": "path",
                "description": "The ID of the object"
              }
            ]
          },
          "docs": "Raw object data can be found in the response body. This can be either the mapped PDF/PPT or STACH json, depending on the mapping. https://pages.github.factset.com/analytics-reporting/stachschema/#/ \r\n\nOptional request header \"accept-encoding\", with allowed values of \"br\" and \"gzip\". If accept-encoding is passed, the response is compressed."
        },
        {
          "info": {
            "name": "Factset Retrieve a Specific Attributes Group Record.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/ofs/v2/attributes/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Globally unique identifier (GUID) of an Attributes Group record"
              }
            ]
          },
          "docs": "Factset Retrieve a Specific Attributes Group Record."
        },
        {
          "info": {
            "name": "Factset Retrieve a Collection of Attributes Group Records.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/ofs/v2/attributes/groups",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the amount of records per page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Select which page to show"
              }
            ]
          },
          "docs": "Factset Retrieve a Collection of Attributes Group Records."
        },
        {
          "info": {
            "name": "Factset Retrieve a Collection of Attributes Group Records in Use.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/ofs/v2/attributes/groups/used",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the amount of records per page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Select which page to show"
              }
            ]
          },
          "docs": "Factset Retrieve a Collection of Attributes Group Records in Use."
        },
        {
          "info": {
            "name": "Factset Retrieve a Collection of Attributes Group Records.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/ofs/v2/attributes/groups/search"
          },
          "docs": "Factset Retrieve a Collection of Attributes Group Records."
        },
        {
          "info": {
            "name": "Factset Get Pa Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/engines/pa/v3/groups"
          },
          "docs": "This endpoint lists all the PA groups that can be applied to a PA calculation."
        },
        {
          "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": "Factset Get a List of Groups.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/Groups",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Resource filter string. See [RFC 7644 section 3.4.2.2](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) for syntax. Note this API implementation also supports a non-standard \"re\" operator for regular expression matching against strings."
              },
              {
                "name": "startIndex",
                "value": "",
                "type": "query",
                "description": "Result start index. The one-based index of the first result to be returned in the list of resources. For example, to exclude the first two resources, use a *startIndex* value of 3. This parameter has a default value of 1. This index applies *after* any resource filtration has been applied as specified by the *filter* argument."
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Maximum resource count. The server will not return more resources than this value, although it may return fewer."
              },
              {
                "name": "attributes",
                "value": "",
                "type": "query",
                "description": "Attribute whitelist filter string. A comma-separated list of resource attribute names to be returned in the response, overriding the set of attributes that would be returned by default. Attribute names must be specified in standard attribute notation (see [RFC 7644 section 3.10](https://datatracker.ietf.org/doc/html/rfc7644#section-3.10).) This parameter cannot be used with the *excludedAttributes* parameter."
              },
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "Attribute blacklist filter string. A comma-separated list of resource attribute names to be excluded in the response, overriding the set of attributes that would be returned by default. Attribute names must be specified in standard attribute notation (see [RFC 7644 section 3.10](https://datatracker.ietf.org/doc/html/rfc7644#section-3.10).) This parameter cannot be used with the *attributes* parameter."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Factset Get a List of Groups."
        },
        {
          "info": {
            "name": "Factset Get a Group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/Group/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of resource."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Factset Get a Group."
        },
        {
          "info": {
            "name": "Factset Replace a Group.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.factset.com/Group/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Factset Replace a Group."
        },
        {
          "info": {
            "name": "Factset Patch a Group (add, Replace, or Remove Attributes of a Group.)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.factset.com/Group/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Factset Patch a Group (add, Replace, or Remove Attributes of a Group.)"
        },
        {
          "info": {
            "name": "Factset List of Market Groups.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/basic/market/group/list",
            "params": [
              {
                "name": "_attributes",
                "value": "",
                "type": "query",
                "description": "Limit the attributes returned in the response to the specified set."
              },
              {
                "name": "_language",
                "value": "",
                "type": "query"
              },
              {
                "name": "_sort",
                "value": "",
                "type": "query",
                "description": "Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 2 (possibly prefixed) attribute name(s) is allowed."
              }
            ]
          },
          "docs": "List of market groups."
        },
        {
          "info": {
            "name": "Factset Retrieves a List of Vrs Role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/scim/v2/Groups",
            "params": [
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Non-negative maximum number of entries to return"
              },
              {
                "name": "startIndex",
                "value": "",
                "type": "query",
                "description": "The 1-based index of the first query result"
              }
            ]
          },
          "docs": "Retrieves a VRS roles"
        },
        {
          "info": {
            "name": "Factset Creates a Role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/scim/v2/Groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a VRS role"
        },
        {
          "info": {
            "name": "Factset Retrieves a Vrs Role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/scim/v2/Groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ]
          },
          "docs": "Retrieves a VRS role based on the ID"
        },
        {
          "info": {
            "name": "Factset Updates a Vrs Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.factset.com/scim/v2/Groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The ID of the group"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates (replaces) a VRS Group with the properties in the JSON"
        },
        {
          "info": {
            "name": "Factset Add or Remove a User To/from a Group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.factset.com/scim/v2/Groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The ID of the role"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds or removes a VRS user to/from a VRS role"
        },
        {
          "info": {
            "name": "Factset Deletes a Vrs Role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.factset.com/scim/v2/Groups/:groupId",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The ID of the group"
              }
            ]
          },
          "docs": "Deletes a VRS role"
        }
      ]
    }
  ],
  "bundled": true
}