openapi: 3.0.3 info: title: Factset Analytics Datastore About Region 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: Region paths: /basic/region/get: get: tags: - Region operationId: get/basic/region/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 for a Region. description: Details for a geographic, political, or economic region. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a region. 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/GetBasicRegionGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/region/list: get: tags: - Region operationId: get/basic/region/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: 2 x-supportsPermissionDeniedResponse: false summary: Factset List of Regions. description: List of geographic, political, and economic regions. responses: '200': $ref: '#/components/responses/GetBasicRegionList200Response' 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 2 (possibly prefixed) attribute name(s) is allowed. schema: type: array items: type: string enum: - code - -code - name - -name maxItems: 2 uniqueItems: true default: - name style: form explode: false name: _sort in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/region/continent/get: get: tags: - Region operationId: get/basic/region/continent/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 for a Continent. description: Details for a continent. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a continent. 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/GetBasicRegionContinentGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/region/continent/list: get: tags: - Region operationId: get/basic/region/continent/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 Continents. description: List of continents. responses: '200': $ref: '#/components/responses/GetBasicRegionContinentList200Response' 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/region/country/get: get: tags: - Region operationId: get/basic/region/country/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 for a Country. description: Details for a country. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a country. 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/GetBasicRegionCountryGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/region/country/getByCode: get: tags: - Region operationId: get/basic/region/country/getByCode 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 for a Country Identified by Code. description: Details for a country identified by code. parameters: - name: code in: query schema: type: string maxLength: 2 exclusiveMaximum: false description: ISO 3166-1 alpha-2 code of a country. 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/GetBasicRegionCountryGetByCode200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /basic/region/country/list: get: tags: - Region operationId: get/basic/region/country/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: 2 x-supportsPermissionDeniedResponse: false summary: Factset List of Countries. description: List of countries. responses: '200': $ref: '#/components/responses/GetBasicRegionCountryList200Response' 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 2 (possibly prefixed) attribute name(s) is allowed. schema: type: array items: type: string enum: - code - -code - name - -name maxItems: 2 uniqueItems: true default: - name style: form explode: false name: _sort in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK components: responses: GetBasicRegionContinentGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: name: nullable: true type: string format: localizedString description: Name of the continent. countries: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name description: Countries of this continent. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country. name: nullable: true type: string format: localizedString description: Name of a country. description: Details for a continent. nullable: false x-property-sort: - name - countries 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 GetBasicRegionGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: ISO 3166-1 alpha-2 code of the country. This attribute is set for each country, may be set for miscellaneous regions and is empty for regions of other types. name: nullable: true type: string format: localizedString description: Name of the region. type: nullable: true type: string description: Type of the region. x-enum-description: - Regions that are considered to be a continent in the context of the Market Data Gateway. - A region that represents a country that has been assigned an official ISO 3166-1 code. - A region that represents a subdivision of a country that has been assigned an official ISO 3166-2 code. - A miscellaneous region represents a region that is neither a continent, nor a country, nor a subdivision of a country. - A compound miscellaneous region consists of member regions which are uniquely and undoubtedly defined. enum: - continent - country - subdivision - misc - compound nestedRegions: nullable: false type: array items: type: object nullable: false x-property-sort: - id - code - name - type properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a region. code: nullable: true type: string description: ISO 3166-1 alpha-2 code of the country. This attribute is set for each country, may be set for miscellaneous regions and is empty for regions of other types. name: nullable: true type: string format: localizedString description: Name of the region. type: nullable: true type: string description: Type of the region. x-enum-description: - Regions that are considered to be a continent in the context of the Market Data Gateway. - A region that represents a country that has been assigned an official ISO 3166-1 code. - A region that represents a subdivision of a country that has been assigned an official ISO 3166-2 code. - A miscellaneous region represents a region that is neither a continent, nor a country, nor a subdivision of a country. - A compound miscellaneous region consists of member regions which are uniquely and undoubtedly defined. enum: - continent - country - subdivision - misc - compound description: Nested regions of this region. description: Details of a region. nullable: false x-property-sort: - code - name - type - nestedRegions 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 GetBasicRegionCountryGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: ISO 3166-1 alpha-2 code of the country. name: nullable: true type: string format: localizedString description: Name of the country. subdivisions: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name description: Subdivisions of a country in unspecified order. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country subdivision. name: nullable: true type: string format: localizedString description: Name of the country subdivision. description: Details of a country. nullable: false x-property-sort: - code - name - subdivisions 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 GetBasicRegionList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of regions. nullable: false items: type: object nullable: false x-property-sort: - id - code - name - type properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a region. code: nullable: true x-sortable: true type: string description: ISO 3166-1 alpha-2 code of the country. This attribute is set for each country, may be set for miscellaneous regions and is empty for regions of other types. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the region. type: nullable: true type: string description: Type of the region. x-enum-description: - Regions that are considered to be a continent in the context of the Market Data Gateway. - A region that represents a country that has been assigned an official ISO 3166-1 code. - A region that represents a subdivision of a country that has been assigned an official ISO 3166-2 code. - A miscellaneous region represents a region that is neither a continent, nor a country, nor a subdivision of a country. - A compound miscellaneous region consists of member regions which are uniquely and undoubtedly defined. enum: - continent - country - subdivision - misc - compound 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 GetBasicRegionCountryList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of countries. 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 a country. code: nullable: true x-sortable: true type: string description: ISO 3166-1 alpha-2 code of the country. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the country. 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 GetBasicRegionContinentList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of continents. nullable: false 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 continent. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the continent. 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 GetBasicRegionCountryGetByCode200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country. name: nullable: true type: string format: localizedString description: Name of the country. subdivisions: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name description: Subdivisions of this country in unspecified order. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country subdivision. name: nullable: true type: string format: localizedString description: Name of the country subdivision. description: Details of a country. nullable: false x-property-sort: - id - name - subdivisions 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 schemas: 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 securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation