openapi: 3.0.3 info: title: Factset Analytics Datastore About Configurations API description: Allow clients to fetch precalculated Analytics through predeterministic URLs. contact: name: FactSet Research Systems url: https://developer.factset.com/contact email: api@factset.com license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.0.0 servers: - url: https://api.factset.com description: Production - url: https://api-sandbox.factset.com description: Sandbox security: - basicAuth: [] tags: - name: Configurations paths: /ServiceProviderConfig: get: tags: - Configurations summary: Factset Get Server Configuration. security: - basicAuth: [] responses: '200': $ref: '#/components/responses/serviceProviderConfigSuccess' '401': $ref: '#/components/responses/unauthorizedError' '500': $ref: '#/components/responses/internalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/vault/v3/configurations: get: tags: - Configurations summary: Factset Get Vault Configurations description: This endpoint returns all the Vault configurations saved in the provided account. operationId: getVaultConfigurations parameters: - name: account in: query description: Required account query parameter to filter configurations for a specific account required: true schema: type: string description: Required account query parameter to filter configurations for a specific account responses: '200': description: Expected response, returns a dictionary of Vault configurations. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/VaultConfigurationSummaryRoot' '400': description: Invalid account. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Account not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/vault/v3/configurations/{id}: get: tags: - Configurations summary: Factset Get Vault Configuration by Id description: This endpoint returns details for a Vault configuration as well as a list of accounts it is used in. operationId: getVaultConfigurationById parameters: - name: id in: path description: Vault configuration id to get the details of required: true schema: type: string description: Vault configuration id to get the details of responses: '200': description: Expected response, returns details for a Vault configuration. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/VaultConfigurationRoot' '400': description: Invalid vault configuration code. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: Vault configuration id not found. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: ClientErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' nullable: true example: [] VaultConfigurationSummaryRoot: required: - data type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/VaultConfigurationSummary' example: example_value meta: nullable: true example: example_value VaultConfiguration: type: object properties: name: type: string description: Configuration name. nullable: true example: Example Title accounts: type: object additionalProperties: $ref: '#/components/schemas/ConfigurationAccount' nullable: true example: example_value VaultConfigurationRoot: required: - data type: object properties: data: $ref: '#/components/schemas/VaultConfiguration' meta: nullable: true example: example_value ErrorSource: type: object properties: pointer: type: string nullable: true example: example_value parameter: type: string nullable: true example: example_value VaultConfigurationSummary: type: object properties: name: type: string description: Configuration name. nullable: true example: Example Title Error: type: object properties: id: type: string nullable: true example: abc123 code: type: string nullable: true example: example_value title: type: string nullable: true example: Example Title detail: type: string nullable: true example: example_value source: $ref: '#/components/schemas/ErrorSource' ConfigurationAccount: type: object properties: benchmarkCode: type: string description: Benchmark code. nullable: true example: example_value benchmarkName: type: string description: Benchmark name. nullable: true example: example_value maxEndDate: type: string description: Maximum end date. nullable: true example: example_value minStartDate: type: string description: Minimum start date. nullable: true example: example_value lockingDate: type: string description: Locking date. nullable: true example: example_value name: type: string description: Account name. nullable: true example: Example Title ServiceProviderConfig: type: object properties: schemas: type: array items: type: string example: - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig documentationUri: type: string description: An HTTP-addressable URL pointing to the service provider's human-consumable help documentation. readOnly: true example: https://developer-staging.factset.com/api-catalog/scim-api patch: type: object description: A complex type that specifies PATCH configuration options. properties: supported: type: boolean description: A Boolean value specifying whether or not the operation is supported. readOnly: true example: false required: - supported readOnly: true example: example_value bulk: type: object description: A complex type that specifies bulk configuration options. properties: supported: type: boolean description: A Boolean value specifying whether or not the operation is supported. readOnly: true example: false maxOperations: type: integer description: An integer value specifying the maximum number of operations. readOnly: true example: 0 maxPayloadSize: type: integer description: An integer value specifying the maximum payload size in bytes. readOnly: true example: 0 required: - supported - maxOperations - maxPayloadSize example: example_value filter: type: object description: A complex type that specifies FILTER options. properties: supported: type: boolean description: A Boolean value specifying whether or not the operation is supported. readOnly: true example: false maxResults: type: integer description: An integer value specifying the maximum number of resources returned in a response. readOnly: true example: 0 required: - supported - maxResults example: example_value changePassword: type: object description: A complex type that specifies configuration options related to changing a password. properties: supported: type: boolean description: A Boolean value specifying whether or not the operation is supported. readOnly: true example: false required: - supported example: example_value sort: type: object description: A complex type that specifies sort result options. properties: supported: type: boolean description: A Boolean value specifying whether or not the operation is supported. readOnly: true example: false required: - supported example: example_value etag: type: object description: A complex type that specifies ETag configuration options. properties: supported: type: boolean description: A Boolean value specifying whether or not the operation is supported. readOnly: true example: false required: - supported example: example_value authenticationSchemes: type: object description: A complex type that specifies supported authentication scheme properties. properties: type: type: string description: The authentication scheme. readOnly: true example: httpbasic name: type: string description: The common authentication scheme name, e.g., HTTP Basic. readOnly: true example: HTTP Basic description: type: string description: A description of the authentication scheme. readOnly: true example: FactSet API key authentication. specUri: type: string description: An HTTP-addressable URL pointing to the authentication scheme's specification. readOnly: true example: https://datatracker.ietf.org/doc/rfc7617/ documentationUri: type: string description: An HTTP-addressable URL pointing to the authentication scheme's usage documentation. readOnly: true example: https://developer.factset.com/authentication required: - type - name - description example: example_value required: - patch - bulk - filter - changePassword - sort - etag - authenticationSchemes responses: unauthorizedError: description: User has not been authenticated. content: application/scim+json: schema: $ref: '#/components/schemas/Error' example: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: FactSet.net credentials are missing or invalid. status: '401' serviceProviderConfigSuccess: description: Success. content: application/scim+json: schema: $ref: '#/components/schemas/ServiceProviderConfig' internalServerError: description: Internal server error. content: application/scim+json: schema: $ref: '#/components/schemas/Error' securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation