openapi: 3.0.3 info: title: Factset Analytics Datastore About Unit 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: Unit paths: /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result: get: tags: - Unit summary: Factset Get Pa Calculation Result by Id description: "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in JSON." operationId: getCalculationUnitResultById parameters: - name: id in: path description: from url, provided from the location header in the Get PA calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get PA calculation status by id endpoint - name: unitId in: path description: from url, provided from the location header in the Get PA calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get PA calculation status by id endpoint responses: '200': description: Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. 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/ObjectRoot' application/x-protobuf: schema: $ref: '#/components/schemas/ObjectRoot' '400': description: Invalid identifier provided. 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' application/x-protobuf: 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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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' application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' '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/pub/v3/calculations/{id}/units/{unitId}/result: get: tags: - Unit summary: Factset Get Pub Calculation Result by Id description: "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in the specified format." operationId: getCalculationUnitResultById parameters: - name: id in: path description: from url, provided from the location header in the Get Pub calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get Pub calculation status by id endpoint - name: unitId in: path description: from url, provided from the location header in the Get Pub calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get Pub calculation status by id endpoint - name: Accept in: header description: Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * schema: type: string responses: '200': description: Expected response once calculation is completed, returns result in the format specified in the Calculation parameters. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. 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/ObjectRoot_2' application/x-protobuf: schema: $ref: '#/components/schemas/ObjectRoot_2' application/pdf: schema: $ref: '#/components/schemas/ObjectRoot_2' '400': description: Invalid identifier provided. 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_2' application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse_2' application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse_2' '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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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_2' application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse_2' application/pdf: schema: $ref: '#/components/schemas/ClientErrorResponse_2' '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 /calculations/{id}/units/{unitId}/result: get: tags: - Unit summary: Factset Get Quant Engine Calculation Result by Id description: "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in JSON." operationId: getCalculationUnitResultById parameters: - name: id in: path description: from url, provided from the location header in the Get Quant Engine calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get Quant Engine calculation status by id endpoint - name: unitId in: path description: from url, provided from the location header in the Get Quant Engine calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get Quant Engine calculation status by id endpoint responses: '200': description: Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. 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: type: string format: binary application/x-protobuf: schema: type: string format: binary application/octet-stream: schema: type: string format: binary '400': description: Invalid identifier provided. 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' application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' application/octet-stream: 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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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' application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' application/octet-stream: schema: $ref: '#/components/schemas/ClientErrorResponse' '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 /calculations/{id}/units/{unitId}/info: get: tags: - Unit summary: Factset Get Quant Engine Calculation Metadata Information by Id description: This is the endpoint to get the metadata information of a previously requested calculation. operationId: getCalculationUnitInfoById parameters: - name: id in: path description: from url, provided from the location header in the Get Quant calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get Quant calculation status by id endpoint - name: unitId in: path description: from url, provided from the location header in the Get Quant calculation status by id endpoint required: true schema: type: string description: from url, provided from the location header in the Get Quant calculation status by id endpoint responses: '200': description: Expected response once calculation is completed. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. 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: type: string format: binary application/x-protobuf: schema: type: string format: binary application/octet-stream: schema: type: string format: binary '400': description: Invalid identifier provided. 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' application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' application/octet-stream: 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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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' application/x-protobuf: schema: $ref: '#/components/schemas/ClientErrorResponse' application/octet-stream: schema: $ref: '#/components/schemas/ClientErrorResponse' '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 /basic/valueUnit/get: get: tags: - Unit operationId: get/basic/valueUnit/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Details of a Value Unit. description: Details of a value unit. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a value unit. required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false responses: '200': $ref: '#/components/responses/GetBasicValueUnitGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/valueUnit/list: post: tags: - Unit operationId: post/basic/valueUnit/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 1 x-supportsPermissionDeniedResponse: false summary: Factset List of Value Units. description: List of value units. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicValueUnitListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicValueUnitList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/valueUnit/alternative/list: get: tags: - Unit operationId: get/basic/valueUnit/alternative/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 1 x-supportsPermissionDeniedResponse: false description: List of alternative units. summary: Factset List of Alternative Units. responses: '200': $ref: '#/components/responses/GetBasicValueUnitAlternativeList200Response' parameters: - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false - 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 1 (possibly prefixed) attribute name(s) is allowed. schema: type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name style: form explode: false name: _sort in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/valueUnit/currency/list: post: tags: - Unit operationId: post/basic/valueUnit/currency/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 1 x-supportsPermissionDeniedResponse: false summary: Factset List of Currencies. description: List of currencies. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicValueUnitCurrencyListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicValueUnitCurrencyList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/valueUnit/currency/fractional/get: get: tags: - Unit operationId: get/basic/valueUnit/currency/fractional/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Details of a Fractional Currency. description: Details of a fractional currency. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a fractional currency. required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false responses: '200': $ref: '#/components/responses/GetBasicValueUnitCurrencyFractionalGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/valueUnit/currency/fractional/list: get: tags: - Unit operationId: get/basic/valueUnit/currency/fractional/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 1 x-supportsPermissionDeniedResponse: false summary: Factset List of Fractional Currencies. description: List of fractional currencies. responses: '200': $ref: '#/components/responses/GetBasicValueUnitCurrencyFractionalList200Response' parameters: - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false - 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 1 (possibly prefixed) attribute name(s) is allowed. schema: type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name style: form explode: false name: _sort in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/valueUnit/currency/main/list: post: tags: - Unit operationId: post/basic/valueUnit/currency/main/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 1 x-supportsPermissionDeniedResponse: false summary: Factset List of Main Currencies. description: List of main currencies. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicValueUnitCurrencyMainListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicValueUnitCurrencyMainList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: LanguageMember: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false ClientErrorResponse_2: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_2' example: [] PostBasicValueUnitCurrencyMainListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - filter description: The data member contains the request's primary data. properties: filter: type: object x-property-sort: - status description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: status: type: string description: Filter for the status. default: active x-enum-description: - Show all main currencies. - Show only active main currencies. - Show only inactive main currencies. enum: - all - active - inactive example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: 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 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort example: example_value AttributesMember: type: array description: Limit the attributes returned in the response to the specified set. items: type: string maxLength: 100 exclusiveMaximum: false maxItems: 50 uniqueItems: true PostBasicValueUnitCurrencyListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - filter description: The data member contains the request's primary data. properties: filter: type: object x-property-sort: - status description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: status: type: string description: Filter for the status. default: active x-enum-description: - Show all currencies. - Show only active currencies. - Show only inactive currencies. enum: - all - active - inactive example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: 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 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort example: example_value Error_2: type: object properties: id: type: string example: abc123 detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource_2' PostBasicValueUnitListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - filter description: The data member contains the request's primary data. properties: filter: type: object x-property-sort: - status description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: status: type: string description: Filter for the status. default: active x-enum-description: - Show all currencies. - Show only active currencies. - Show only inactive currencies. enum: - all - active - inactive example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: 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 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort example: example_value 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' StatusObject: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). example: 42.5 description: The status member contains the status code of the response. required: - code ObjectRoot_2: type: object properties: data: type: object example: example_value ClientErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' nullable: true example: [] ErrorSource_2: type: object properties: pointer: type: string example: example_value parameter: type: string example: example_value ObjectRoot: required: - data type: object properties: data: example: example_value 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 responses: PostBasicValueUnitCurrencyList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of currencies. nullable: false items: type: object nullable: false x-property-sort: - id - code - isoCode - name - type - active properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a currency. code: nullable: true type: string description: 'Code of the currency: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency.' isoCode: nullable: true type: string description: ISO 4217 code of the value unit. Empty if the ISO 4217 standard does not define a code for the currency. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the currency. type: nullable: true type: string description: Type of the currency. x-enum-description: - Currency that is a main currency. - Currency that is a fractional currency. enum: - main - fractional active: nullable: true type: boolean description: Indicates whether the currency is active. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetBasicValueUnitGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' isoCode: nullable: true type: string description: ISO 4217 code of the value unit. Empty if the ISO 4217 standard does not define a code for the currency. name: nullable: true type: string format: localizedString description: Name of the value unit. type: nullable: true type: string description: Type of the value unit. x-enum-description: - Main currency. - Fractional currency. - Alternative value unit. enum: - main - fractional - alternative active: nullable: true type: boolean description: Indicates whether the value unit is active. description: Details of a value unit. nullable: false x-property-sort: - code - isoCode - name - type - active meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetBasicValueUnitCurrencyFractionalGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: Code of the fractional currency such as GBp (for British pence), USc (for U.S. cents), EUc for (Euro cent). name: nullable: true type: string format: localizedString description: Name of the fractional currency. factor: nullable: true type: number format: real description: Conversion factor between the fractional and its main currency. For example, the value 100 indicates that 100 US cents are equivalent to one US dollar. mainCurrency: nullable: false type: object x-property-sort: - id - code - isoCode - name - active description: Main currency corresponding to the fractional currency. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the main currency. code: nullable: true type: string description: 'Code of the currency: If assigned, a code according to ISO 4217, otherwise a local code.' isoCode: nullable: true type: string description: ISO 4217 code of the currency. name: nullable: true type: string format: localizedString description: Name of the main currency. active: nullable: true type: boolean description: Indicates whether the currency is active. description: Details of a fractional currency. nullable: false x-property-sort: - code - name - factor - mainCurrency meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetBasicValueUnitCurrencyFractionalList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of fractional currencies. nullable: false items: type: object nullable: false x-property-sort: - id - code - name - factor - mainCurrency properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the fractional currency, which is a value unit. code: nullable: true type: string description: Code of the fractional currency such as GBp (for British pence), USc (for U.S. cents), EUc for (Euro cent). name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the fractional currency. factor: nullable: true type: number format: real description: Conversion factor between the fractional and its main currency. For example, the value 100 indicates that 100 US cents are equivalent to one US dollar. mainCurrency: nullable: false type: object x-property-sort: - id - code - isoCode - name - active description: Main currency corresponding to the fractional currency. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the main currency of the fractional currency. code: nullable: true type: string description: 'Code of the currency: If assigned, a code according to ISO 4217, otherwise a local code.' isoCode: nullable: true type: string description: ISO 4217 code of the currency. name: nullable: true type: string format: localizedString description: Name of the main currency. active: nullable: true type: boolean description: Indicates whether the currency is active. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta PostBasicValueUnitCurrencyMainList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of main currencies. nullable: false items: type: object nullable: false x-property-sort: - id - code - isoCode - name - active properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a currency. code: nullable: true type: string description: 'Code of the currency: If assigned, a code according to ISO 4217, otherwise a local code.' isoCode: nullable: true type: string description: ISO 4217 code of the currency. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the currency. active: nullable: true type: boolean description: Indicates whether the currency is active. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta PostBasicValueUnitList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of value units. nullable: false items: type: object nullable: false x-property-sort: - id - code - isoCode - name - type - active properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a value unit. code: nullable: true type: string description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' isoCode: nullable: true type: string description: ISO 4217 code of the value unit. Empty if the ISO 4217 standard does not define a code for the currency. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the value unit. type: nullable: true type: string description: Type of the value unit. x-enum-description: - Main currency. - Fractional currency. - Alternative value unit. enum: - main - fractional - alternative active: nullable: true type: boolean description: Indicates whether the currency is active. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetBasicValueUnitAlternativeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of alternative units. nullable: false items: type: object nullable: false x-property-sort: - id - code - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of an alternative unit. code: nullable: true type: string description: Code of the alternative unit. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the alternative unit. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation