openapi: 3.0.3 info: title: Factset Analytics Datastore About Selections 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: Selections paths: /instrument/selectionList/list: get: tags: - Selections operationId: get/instrument/selectionList/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: 10 x-supportsPermissionDeniedResponse: false description: Set of custom instrument-level selection lists. summary: Factset Set of Custom Instrument-level Selection Lists. responses: '200': $ref: '#/components/responses/GetInstrumentSelectionListList200Response' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/selectionList/listByInstrument: get: tags: - Selections operationId: get/instrument/selectionList/listByInstrument 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 description: For each given instrument, returns the instrument-level selection lists of which the instrument is a member. summary: Factset for Each Given Instrument, Returns the Instrument-level Selection Lists of Which the Instrument Is a Member. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[SLR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$|^[B-DF-HJ-NP-TV-Z0-9]{6}[0-9]$|^[A-Z]{2}[A-Z0-9]{9}[0-9]$|^[A-Z1-9][A-Z0-9]{5}$|^[0-9]{1,9}$|^[A-Z0-9]{8}[0-9]$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of an instrument. - MDG identifier of a listing. - FactSet Permanent Identifier on security level. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier. - FactSet market symbol of a listing. - Regional FactSet ticker symbol. - SEDOL or IDII of a listing. - ISIN of an instrument. - WKN of an instrument. - Valor number of an instrument. - CUSIP or CINS identifier of an instrument enum: - idInstrument - idNotation - fdsPermanentIdentifierSecurity - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional - tickerExchange - tickerRegion - sedol - isin - wkn - valor - cusip 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. responses: '200': $ref: '#/components/responses/GetInstrumentSelectionListListByInstrument200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/selectionList/members/list: post: tags: - Selections operationId: post/instrument/selectionList/members/list x-supportsOffsetBasedPaging: true 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: 4 x-supportsPermissionDeniedResponse: false summary: Factset List of Instruments Belonging to an Instrument-level Selection List. description: List of instruments belonging to an instrument-level selection list. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentSelectionListMembersListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentSelectionListMembersList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/selectionList/list: get: tags: - Selections operationId: get/notation/selectionList/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: 10 x-supportsPermissionDeniedResponse: false description: Set of custom notation-level selection lists. summary: Factset Set of Custom Notation-level Selection Lists. responses: '200': $ref: '#/components/responses/GetNotationSelectionListList200Response' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/selectionList/listByNotation: get: tags: - Selections operationId: get/notation/selectionList/listByNotation 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 description: For each given notation, returns the notation-level selection lists of which the notation is a member. summary: Factset for Each Given Notation, Returns the Notation-level Selection Lists of Which the Notation Is a Member. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional 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. responses: '200': $ref: '#/components/responses/GetNotationSelectionListListByNotation200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/selectionList/members/list: post: tags: - Selections operationId: post/notation/selectionList/members/list x-supportsOffsetBasedPaging: true 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: 6 x-supportsPermissionDeniedResponse: false summary: Factset List of Notations Belonging to a Notation-level Selection List. description: List of notations belonging to a notation-level selection list. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationSelectionListMembersListRequest' required: false responses: '200': $ref: '#/components/responses/PostNotationSelectionListMembersList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: PartialOutputObject: type: object properties: isPartial: type: boolean description: Flag indicating that the response is a possibly incomplete array or an object containing a possibly incomplete array, due to hitting a processing time limit. If `true`, some matching results might be missing from the array, or elements for matching results might be incorrectly included (for example, when priority sorting would have removed the element). Depending on the use case, such a response may be unsuitable. example: true description: Object denoting that the endpoint response is possibly incomplete. required: - isPartial x-property-sort: - isPartial PostNotationSelectionListMembersListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - id - filter description: The data member contains the request's primary data. properties: id: type: number format: id32 x-positive: true description: Identifier of a selection list. filter: type: object x-property-sort: - market - valueUnit - assetClass - instrumentCategory description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: market: type: object x-property-sort: - restrict - exclude description: Market-related parameters. See endpoint `/basic/market/list` for valid values. x-atMostOne: true properties: restrict: type: object x-property-sort: - ids description: Specifies the markets from which a notation may originate. properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: type: object x-property-sort: - ids description: Specifies the markets from which a notation may not originate. properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 valueUnit: type: object x-property-sort: - restrict - exclude description: Value unit-related parameters. See endpoint `/basic/valueUnit/list` for valid values. x-atMostOne: true properties: restrict: type: object x-property-sort: - ids description: Specifies the value units a notation may have. properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: type: object x-property-sort: - ids description: Specifies the value units a notation may not have. properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 assetClass: type: object x-property-sort: - ids description: Asset class restriction. properties: ids: description: Set of asset class identifiers. See endpoint `/basic/assetClass/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 12 instrumentCategory: type: object x-property-sort: - restrict - exclude description: Category selection. Identifiers from all entitled category systems can be used, see endpoint `/category/system/list` with `idType=1` for the list of category systems. x-atMostOne: true properties: restrict: type: object x-property-sort: - ids description: Specifies the instrument categories that the instruments of the notations may have. properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 exclude: type: object x-property-sort: - ids description: Specifies the instrument categories that the instruments of the notations may not have. properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 required: - id 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 6 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - market.name - -market.name - valueUnit.name - -valueUnit.name - instrument.name.default.long - -instrument.name.default.long - instrument.name.default.short - -instrument.name.default.short - instrument.name.assetClassSpecific.long - -instrument.name.assetClassSpecific.long - instrument.name.assetClassSpecific.short - -instrument.name.assetClassSpecific.short maxItems: 6 uniqueItems: true default: - instrument.name.default.long pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination 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 LanguageMember: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false OffsetBasedPaginationOutputObject: type: object description: Pagination attributes for the offset-based pagination strategy. properties: total: type: number format: int32 description: Total number of entries in the result set. example: 42.5 isEstimatedTotal: type: boolean description: Flag indicating that the value of "total" is estimated. example: true required: - total - isEstimatedTotal x-property-sort: - total - isEstimatedTotal 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 PostInstrumentSelectionListMembersListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - id - filter description: The data member contains the request's primary data. properties: id: type: number format: id32 x-positive: true description: Identifier of a selection list. filter: type: object x-property-sort: - assetClass - category description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: assetClass: type: object x-property-sort: - ids description: Asset class restriction. properties: ids: description: Set of asset class identifiers. See endpoint `/basic/assetClass/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 12 category: type: object x-property-sort: - restrict - exclude description: Category selection. Identifiers from all entitled category systems can be used, see endpoint `/category/system/list` with `idType=1` for the list of category systems. x-atMostOne: true properties: restrict: type: object x-property-sort: - ids description: Specifies the categories that the instruments may have. properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 exclude: type: object x-property-sort: - ids description: Specifies the categories that the instruments may not have. properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 required: - id 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 4 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name.default.long - -name.default.long - name.default.short - -name.default.short - name.assetClassSpecific.long - -name.assetClassSpecific.long - name.assetClassSpecific.short - -name.assetClassSpecific.short maxItems: 4 uniqueItems: true default: - name.default.long pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination example: example_value responses: GetNotationSelectionListList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Unsorted set of selection lists. nullable: false items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true description: Identifier of a selection list. type: number format: id32 x-positive: true name: nullable: true description: Name of the selection list, as provided by the customer. type: string description: nullable: true description: Description of the selection list in English. type: string 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 GetInstrumentSelectionListList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Unsorted set of selection lists. nullable: false items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true description: Identifier of a selection list. type: number format: id32 x-positive: true name: nullable: true description: Name of the selection list, as provided by the customer. type: string description: nullable: true description: Description of the selection list in English. type: string 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 GetNotationSelectionListListByNotation200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Set of notation-level selection lists for each given notation. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - selectionList - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. selectionList: nullable: false description: Set of selection lists. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a selection list. name: nullable: true type: string description: Name of the selection list, as provided by the customer. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid listing level identifier. - Not entitled to see data for the identifier. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. 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 PostNotationSelectionListMembersList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of notations. nullable: false items: type: object nullable: false x-property-sort: - id - market - valueUnit - symbol - nsin - fsym - instrument properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of a notation. market: nullable: false description: Market of the notation. See endpoint `/basic/market/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true x-sortable: true description: Name of the market. type: string format: localizedString valueUnit: nullable: false description: Value unit of the notation such as a main or fractional currency for equities, a percentage for debt instruments, or points for indices. See endpoint `/basic/valueUnit/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. name: nullable: true x-sortable: true type: string format: localizedString 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.' symbol: nullable: true description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. type: string nsin: nullable: false type: object x-property-sort: - sedol description: NSIN data of the instrument. properties: sedol: nullable: true type: string description: The SEDOL or IDII for the notation. fsym: nullable: false description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. type: object x-property-sort: - listing - regional properties: listing: nullable: false description: Listing-level identifiers. type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false description: Regional-level identifiers. type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerExchange: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). instrument: nullable: false description: Instrument data of the notation. type: object x-property-sort: - id - name - isin - nsin - fsym - assetClass - instrumentCategory properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: false description: Instrument names. type: object x-property-sort: - default - assetClassSpecific properties: default: nullable: false description: Default instrument names. Sorting does not require an asset class selection, see parameter `assetClass.ids`. type: object x-property-sort: - long - short properties: long: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. assetClassSpecific: nullable: false description: Asset class-specific instrument names. Sorting requires that a single asset-class has been selected, see parameter `assetClass.ids`. type: object x-property-sort: - long - short properties: long: nullable: true x-sortable: true type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. isin: nullable: true type: string description: International Securities Identification Number of the instrument. nsin: nullable: false description: NSIN data of the instrument. type: object x-property-sort: - wkn - valor - cusip properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is aninteger number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. fsym: nullable: false description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. type: object x-property-sort: - security properties: security: nullable: false description: Security-level identifier. type: object x-property-sort: - permanentIdentifier properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: false description: Asset class of the instrument. See endpoint `/basic/assetClass/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the asset class. type: number format: id32 x-positive: true name: nullable: true description: English name of the asset class. type: string format: localizedString instrumentCategory: nullable: false description: Set of categories assigned to the instrument. The set of returned categories is limited to the values provided in the request parameter `category.restrict.ids.` Empty, if `category.restrict.ids` has not been used. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true description: Identifier of a category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. type: string format: localizedString x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial x-property-sort: - data - meta GetInstrumentSelectionListListByInstrument200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Set of instrument-level selection lists for each given instrument. nullable: false items: type: object nullable: false x-property-sort: - idInstrument - sourceIdentifier - selectionList - status properties: idInstrument: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the index instrument. sourceIdentifier: nullable: true type: string description: Identifier used in the request. selectionList: nullable: false description: Set of selection lists. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a selection list. name: nullable: true type: string description: Name of the selection list, as provided by the customer. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid instrument level identifier. - Not entitled to see data for the identifier. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. 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 PostInstrumentSelectionListMembersList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - name - isin - nsin - fsym - assetClass - category properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of an instrument. name: nullable: false description: Instrument names. type: object x-property-sort: - default - assetClassSpecific properties: default: nullable: false description: Default instrument names. Sorting does not require an asset class selection, see parameter `assetClass.ids`. type: object x-property-sort: - long - short properties: long: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. assetClassSpecific: nullable: false description: Asset class-specific instrument names. Sorting requires that a single asset-class has been selected, see parameter `assetClass.ids`. type: object x-property-sort: - long - short properties: long: nullable: true x-sortable: true type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. isin: nullable: true type: string description: International Securities Identification Number of the instrument. nsin: nullable: false description: NSIN data of the instrument. type: object x-property-sort: - wkn - valor - cusip properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. fsym: nullable: false description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. type: object x-property-sort: - security properties: security: nullable: false description: Security-level identifier. type: object x-property-sort: - permanentIdentifier properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: false description: Asset class of the instrument. See endpoint `/basic/assetClass/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the asset class. type: number format: id32 x-positive: true name: nullable: true description: English name of the asset class. type: string format: localizedString category: nullable: false description: Set of categories assigned to the instrument. The set of returned categories is limited to the values provided in the request parameter `category.restrict.ids.` Empty, if `category.restrict.ids` has not been used. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true description: Identifier of a category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. type: string format: localizedString x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial 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