openapi: 3.0.3 info: title: Factset Analytics Datastore About Composite 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: Composite paths: /account-composite: post: operationId: createAccountComposite description: Create a new account composite tags: - Composite parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/createAccountCompositeRequest' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/createAccountCompositeResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '406': $ref: '#/components/responses/NotAcceptableErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '415': $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '501': $ref: '#/components/responses/NotImplementedErrorResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: listAccountComposite description: List account composite tags: - Composite parameters: - name: path in: query required: false schema: type: string default: 'Client:' example: string description: Directory to list - name: name in: query required: false schema: type: string example: string description: Return only files whose name includes this query - name: description in: query required: false schema: type: string example: string description: Return only files whose name includes this query - name: _paginationLimit in: query required: false schema: type: number default: 100 example: 0 description: Number of directory items to return - name: _paginationCursor in: query required: false schema: type: string example: string description: Cursor used for paging. Fetch items after the specified cursor responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/listAccountCompositeResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '406': $ref: '#/components/responses/NotAcceptableErrorResponse' '415': $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '501': $ref: '#/components/responses/NotImplementedErrorResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK /account-composite/{id}: delete: operationId: deleteAccountComposite description: Remove a account composite tags: - Composite parameters: - name: id in: path required: true schema: type: string example: 270c2fa8-9110-444b-9101-17e10132fe0a description: Unique identifier for the account composite to be deleted example: 270c2fa8-9110-444b-9101-17e10132fe0a - name: reason in: query required: false schema: type: string example: string description: User auditable reason that the account composite is being removed responses: '204': description: Success '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '406': $ref: '#/components/responses/NotAcceptableErrorResponse' '409': $ref: '#/components/responses/ConflictErrorResponse' '415': $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '501': $ref: '#/components/responses/NotImplementedErrorResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: readAccountComposite description: Read a account composite tags: - Composite parameters: - name: id in: path required: true schema: type: string example: 270c2fa8-9110-444b-9101-17e10132fe0a description: Unique identifier of the account composite to be read example: 270c2fa8-9110-444b-9101-17e10132fe0a responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/readAccountCompositeResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '406': $ref: '#/components/responses/NotAcceptableErrorResponse' '415': $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '501': $ref: '#/components/responses/NotImplementedErrorResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: updateAccountComposite description: Modify a account composite tags: - Composite parameters: - name: id in: path required: true schema: type: string example: 270c2fa8-9110-444b-9101-17e10132fe0a description: Unique identifier for the account composite to be updated example: 270c2fa8-9110-444b-9101-17e10132fe0a requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountCompositeRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/updateAccountCompositeResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '406': $ref: '#/components/responses/NotAcceptableErrorResponse' '415': $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '501': $ref: '#/components/responses/NotImplementedErrorResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK /holdings-composite/{id}: get: operationId: readHoldingsComposite description: Read a holdings composite tags: - Composite parameters: - name: id in: path required: true schema: type: string example: 270c2fa8-9110-444b-9101-17e10132fe0a description: Unique identifier of the holdings composite to be read example: 270c2fa8-9110-444b-9101-17e10132fe0a responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/readHoldingsCompositeResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '406': $ref: '#/components/responses/NotAcceptableErrorResponse' '415': $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '501': $ref: '#/components/responses/NotImplementedErrorResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK /returns-composite/{id}: get: operationId: readReturnsComposite description: Read a returns composite tags: - Composite parameters: - name: id in: path required: true schema: type: string example: 270c2fa8-9110-444b-9101-17e10132fe0a description: Unique identifier of the returns composite to be read example: 270c2fa8-9110-444b-9101-17e10132fe0a responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/readReturnsCompositeResponse' '400': $ref: '#/components/responses/BadRequestErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '406': $ref: '#/components/responses/NotAcceptableErrorResponse' '415': $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '501': $ref: '#/components/responses/NotImplementedErrorResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/composite/get: get: tags: - Composite operationId: get/instrument/composite/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 Composite Instrument and Its Components. description: Composite instrument and its components. parameters: - name: identifier in: query schema: type: string 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]$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - 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. - 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/GetInstrumentCompositeGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /stock/composite/profile/getByNotation: get: tags: - Composite operationId: get/stock/composite/profile/getByNotation 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: Provides key elements of a stock profile together with the profile of the issuing company. description: Provides key elements of a stock profile together with the profile of the issuing company. parameters: - name: identifier in: query schema: type: string pattern: ^([B-DF-HJ-NP-TV-Z0-9]{6}-[LR])|([A-Z0-9.]{1,47}-[A-Z0-9]{2,4})|([0-9]{3,20})$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - 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. - 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/GetStockCompositeProfileGetByNotation200Response' components: schemas: readHoldingsCompositeResponse: type: object properties: data: type: object properties: type: type: string enum: - Account - AccountComposite - ExchangeRate - GlobalAccountProperties - Holdings - HoldingsComposite - PortfolioGroup - Returns - ReturnsComposite - SecurityMaster - TradeData - VendorReturnSeries nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: f132625b-1506-4cc3-b2e8-2c75de39c79c display: type: string nullable: false description: The GUI path of this file, including the name and extension. example: SP50 path: type: string nullable: false description: The GUI path to this object. example: 'Client:' name: type: string nullable: false description: Name of this file object including the extension. example: SP50 description: type: string nullable: true description: User provided description of this file. example: Meaningful description of vendor returns nullable: true description: Read a metadata file by its id. example: example_value nullable: true readAccountCompositeResponse: type: object properties: data: type: object properties: type: type: string enum: - AccountComposite nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: 9a030822-d1ee-4fc0-a598-75e65d1512fd display: type: string nullable: false description: The GUI path of this file, including the name and extension. example: Client:EXAMPLE.ACTM path: type: string nullable: false description: The GUI path to this object. example: 'Client:' name: type: string nullable: false description: Name of this file object including the extension. example: EXAMPLE.ACTM description: type: string nullable: true description: User provided description of this file. example: Domestic equity composite dataCatalog: type: object properties: holdings: type: object properties: type: type: string enum: - BLENDED - FIXED_DOLLAR - FLOATING - GIPS - SIMPLE nullable: false description: The type of composite. Determines how component weights are interpreted methodology: type: string enum: - BUY_AND_HOLD - ORDER_MANAGMENT_SYSTEM - TRANSACTIONS nullable: false description: The holdings methodology to apply when reading this account's holdings data. rebalance: type: object properties: frequency: type: string enum: - ANNUALLY - BUY_AND_HOLD - WEEKLY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - CONSTANTLY - DAILY nullable: false start: type: string enum: - SPECIFIC_POINT - LATEST_FREQUENCY_END - REPORT_START_DATE nullable: false month: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER nullable: false dayOfMonth: type: string nullable: false date: type: string nullable: false quarters: type: string enum: - FEBRUARY_MAY_AUGUST_NOVEMBER - JANUARY_APRIL_JULY_OCTOBER - MARCH_JUNE_SEPTEMBER_DECEMBER nullable: false useActualFrequencies: type: boolean nullable: false periods: type: string enum: - APRIL_OCTOBER - FEBRUARY_AUGUST - JANUARY_JULY - JUNE_DECEMBER - MARCH_SEPTEMBER - MAY_NOVEMBER nullable: false dayOfWeek: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY nullable: false nullable: false description: Settings used to determine how a composite's components are rebalanced. example: frequency: DAILY components: type: object properties: all: type: array items: type: object properties: startDate: type: string nullable: false description: 'First date the data is valid. If using the EARLIEST date in the report, this will be set to 0000-01-01' example: '2022-01-01' endDate: type: string nullable: false description: 'Last date the data is valid. If using the LATEST date in the report, this will be set to 9999-12-31' example: '2022-01-31' weight: type: number nullable: false example: 10 isSpar: type: boolean nullable: false portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - HoldingsComposite - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: false description: Raw component, time range list nullable: false description: 'A holdings portfolio or vendor benchmark to use as this accounts''s holdings data.' nullable: true description: Describes the location of the account's holdings data containers. returns: type: object properties: primaryType: type: string enum: - CAPITAL - GROSS - NET - NET_AFTER_TAX - NET_INCOME - OTHER_1 - OTHER_2 - OTHER_3 - OTHER_4 - PRIVATE_EQUITY_GROSS - PRIVATE_EQUITY_NET - REAL_ESTATE_TOTAL nullable: false description: The type of the default return series portfolio used for this account. example: NET net: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the NET returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' gross: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the GROSS returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' other1: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the OTHER1 returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' other2: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the OTHER2 returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' other3: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the OTHER3 returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' other4: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the OTHER4 returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' netAfterTax: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the NET_AFTER_TAX returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' netIncome: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the NET_INCOME returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' capital: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the CAPITAL returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' realEstateTotal: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the REAL_ESTATE_TOTAL returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' privateEquityGross: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the PRIVATE_EQUITY_GROSS returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' privateEquityNet: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: false nullable: true description: 'Reference to the PRIVATE_EQUITY_NET returns portfolio directly. NOTE: this portfolio is included in the portfolios field above as well.' nullable: true description: Describes the location of the account's returns data containers. nullable: false description: 'Contains references to data containers for this account composite, and settings related to interpretting that data correctly.' benchmarks: type: object properties: holdings: type: object properties: primary: type: object properties: startDate: type: string nullable: false description: 'First date the data is valid. If using the EARLIEST date in the report, this will be set to 0000-01-01' example: '2022-01-01' endDate: type: string nullable: false description: 'Last date the data is valid. If using the LATEST date in the report, this will be set to 9999-12-31' example: '2022-01-31' portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Holdings - HoldingsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: true description: 'A reference to the portfolio or vendor benchmark that contains the data this account should be benchmarked against' nullable: true nullable: true returns: type: object properties: primary: type: object properties: startDate: type: string nullable: false description: 'First date the data is valid. If using the EARLIEST date in the report, this will be set to 0000-01-01' example: '2022-01-01' endDate: type: string nullable: false description: 'Last date the data is valid. If using the LATEST date in the report, this will be set to 9999-12-31' example: '2022-01-31' portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Returns - ReturnsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: true description: 'A reference to the portfolio or vendor benchmark that contains the data this account should be benchmarked against' nullable: true nullable: false nullable: false description: 'Contains references to benchmarks used in this account and settings related to interpretting them correctly.' publisher: type: object properties: benchmarks: type: object properties: holdings: type: array items: type: object properties: display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.ACCT portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Holdings - HoldingsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: true nullable: false returns: type: array items: type: object properties: display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.ACCT portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Forbidden - Holdings - HoldingsComposite - Vendor nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: BENCH:SP50 display: type: string nullable: false description: String suitable for display in a UI. example: Client:EXAMPLE.CSTM nullable: true nullable: false nullable: false description: Contains references to benchmarks used in Publisher. nullable: false description: Contains default settings for this account when used within the Publisher application. analytics: type: object properties: currency: type: object properties: iso: type: string nullable: false description: ISO 4217 Currency code. example: USD display: type: string nullable: false description: ISO 4217 Currency name example: US Dollar nullable: false userDefinedValues: type: array items: type: object properties: field: type: object properties: type: type: string enum: - UserDefinedField nullable: false id: type: string nullable: false example: b1c36b19-1417-4e8c-8d0a-416cf6a92a6a display: type: string nullable: false description: String suitable for display in a UI. example: MY_VALUE group: type: object properties: type: type: string enum: - UserDefinedFieldGroup nullable: false id: type: string nullable: false example: MDpEZWZhdWx0IEdyb3Vw display: type: string nullable: false description: String suitable for display in a UI. example: MY_GROUP nullable: false nullable: false value: type: string nullable: false example: A user defined value nullable: false nullable: false description: Contains default settings used when running analytics on this account. risk: type: object properties: model: type: object properties: id: type: string nullable: false example: AXIOMA:AP21_MH_FUND nullable: true nullable: false description: Contains default settings used when running risk analytics on this account. nullable: true description: Read a metadata file by its id. example: example_value nullable: true StatusObject_2: 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). description: The status member contains the status code of the response. required: - code createAccountCompositeResponse: type: object properties: data: type: object properties: type: type: string enum: - AccountComposite nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: 9a030822-d1ee-4fc0-a598-75e65d1512fd display: type: string nullable: false description: The GUI path of this file, including the name and extension. example: Client:EXAMPLE.ACTM path: type: string nullable: false description: The GUI path to this object. example: 'Client:' name: type: string nullable: false description: Name of this file object including the extension. example: EXAMPLE.ACTM nullable: false example: example_value nullable: true updateAccountCompositeRequest: type: object properties: data: type: object properties: reason: type: string example: string description: User auditable reason for the change being made publisher: type: object description: Field used to update the settings used for this account in Publisher. properties: benchmarks: type: object description: Field used to update the set of benchmarks used in Publisher. properties: returns: type: array items: type: object properties: portfolio: type: object description: 'A reference to the portfolio or vendor benchmark that contains the data this account should be benchmarked against' properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isComposite: type: boolean comment: type: string required: - portfolio holdings: type: array items: type: object properties: portfolio: type: object description: 'A reference to the portfolio or vendor benchmark that contains the data this account should be benchmarked against' properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isSpar: type: boolean description: 'Used to signal that the returns data from the provided portfolio should be used to benchmark this account.' isComposite: type: boolean comment: type: string required: - portfolio description: type: string description: 'Account composite description. This should be meaningful to the end user and will often be used in reports generated from this account composite.' dataCatalog: type: object description: Field used to make changes to the account's data container references. properties: returns: type: object description: Set the account composite's returns data containers. properties: realEstateTotal: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio privateEquityNet: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio privateEquityGross: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio primaryType: type: string enum: - CAPITAL - GROSS - NET - NET_AFTER_TAX - NET_INCOME - OTHER_1 - OTHER_2 - OTHER_3 - OTHER_4 - PRIVATE_EQUITY_GROSS - PRIVATE_EQUITY_NET - REAL_ESTATE_TOTAL description: 'Select the default returns series type for this account. Will throw an error if the selected return series type is not specified in the account.' other4: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio other3: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio other2: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio other1: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio netIncome: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio netAfterTax: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio net: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio gross: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio capital: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio holdings: type: object description: Set the account composite's holdings data containers. properties: type: type: string enum: - BLENDED - FIXED_DOLLAR - FLOATING - GIPS - SIMPLE rebalance: type: object properties: useActualFrequencies: type: boolean start: type: string enum: - LATEST_FREQUENCY_END - REPORT_START_DATE - SPECIFIC_POINT quarters: type: string enum: - FEBRUARY_MAY_AUGUST_NOVEMBER - JANUARY_APRIL_JULY_OCTOBER - MARCH_JUNE_SEPTEMBER_DECEMBER periods: type: string enum: - APRIL_OCTOBER - FEBRUARY_AUGUST - JANUARY_JULY - JUNE_DECEMBER - MARCH_SEPTEMBER - MAY_NOVEMBER month: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER frequency: type: string enum: - ANNUALLY - BUY_AND_HOLD - CONSTANTLY - DAILY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - WEEKLY dayOfWeek: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY dayOfMonth: type: string date: type: string required: - frequency methodology: type: string enum: - BUY_AND_HOLD - ORDER_MANAGMENT_SYSTEM - TRANSACTIONS components: type: array items: type: object properties: weight: type: number startDate: type: string portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - HoldingsComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id isSpar: type: boolean endDate: type: string required: - weight - startDate - portfolio - endDate required: - components benchmarks: type: object description: Field used to update the set of benchmarks used for this account. properties: returns: type: object properties: listOfIterated: type: array items: type: object properties: primary: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isComposite: type: boolean comment: type: string iterated: type: array items: type: object properties: startDate: type: string portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isComposite: type: boolean comment: type: string required: - startDate historicalTreatment: type: string enum: - COMBINED_AS_SINGLE_SERIES - LATEST_TAKES_PRECEDENCE required: - listOfIterated holdings: type: object properties: primary: type: object description: 'You may specify either primary or iterated, but not both. primary is a convinence for calling iterated with a single member starting from EARLIEST.' properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isSpar: type: boolean isComposite: type: boolean comment: type: string iterated: type: array items: type: object properties: startDate: type: string portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isSpar: type: boolean isComposite: type: boolean comment: type: string required: - startDate description: Specify a time iterated list of benchmarks historicalTreatment: type: string enum: - COMBINED_AS_SINGLE_SERIES - LATEST_TAKES_PRECEDENCE analytics: type: object description: Field used to update the default analytics settings for this account. properties: userDefinedValues: type: array items: type: object properties: value: type: string field: type: object properties: type: type: string enum: - UserDefinedField id: type: string required: - type - id required: - value - field currency: type: object properties: iso: type: string description: ISO 4217 Currency code. required: - iso required: - reason - dataCatalog example: reason: string publisher: benchmarks: returns: - portfolio: type: Account id: 6e16cf84-3733-4382-93e1-f88066b4239a modifier: BUY_AND_HOLD isComposite: false comment: Changed benchmark for reason holdings: - portfolio: type: Account id: 6e16cf84-3733-4382-93e1-f88066b4239a modifier: BUY_AND_HOLD isSpar: false isComposite: false comment: Changed benchmark for reason description: Domestic equity composite dataCatalog: returns: primaryType: NET net: portfolio: type: Account id: c80f9bac-6850-4c8e-99d1-e8f7bfd44955 field: RETURN holdings: type: BLENDED rebalance: frequency: DAILY methodology: BUY_AND_HOLD components: - weight: 10 startDate: '2022-01-01' portfolio: type: Account id: d5616607-cc1c-4f76-a040-77badf133356 isSpar: false endDate: '2022-01-31' benchmarks: returns: listOfIterated: - primary: portfolio: type: Account id: 872bc07e-aafd-4da2-afc5-978d59fab362 modifier: BUY_AND_HOLD isComposite: false comment: Changed benchmark for reason historicalTreatment: COMBINED_AS_SINGLE_SERIES holdings: primary: portfolio: type: Account id: 6e16cf84-3733-4382-93e1-f88066b4239a modifier: BUY_AND_HOLD isSpar: false isComposite: false comment: Changed benchmark for reason historicalTreatment: COMBINED_AS_SINGLE_SERIES analytics: userDefinedValues: - value: A user defined value field: type: UserDefinedField id: 948a076c-b7da-46f7-a476-a61c2d85241d currency: iso: USD required: - data readReturnsCompositeResponse: type: object properties: data: type: object properties: type: type: string enum: - Account - AccountComposite - ExchangeRate - GlobalAccountProperties - Holdings - HoldingsComposite - PortfolioGroup - Returns - ReturnsComposite - SecurityMaster - TradeData - VendorReturnSeries nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: f132625b-1506-4cc3-b2e8-2c75de39c79c display: type: string nullable: false description: The GUI path of this file, including the name and extension. example: SP50 path: type: string nullable: false description: The GUI path to this object. example: 'Client:' name: type: string nullable: false description: Name of this file object including the extension. example: SP50 description: type: string nullable: true description: User provided description of this file. example: Meaningful description of vendor returns nullable: true description: Read a metadata file by its id. example: example_value nullable: true 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 createAccountCompositeRequest: type: object properties: data: type: object properties: path: type: string example: string description: Directory where account composite should be created name: type: string example: string description: Name of the account composite including its extension reason: type: string example: string description: User auditable reason for the account composite's creation publisher: type: object description: Field used to update the settings used for this account in Publisher. properties: benchmarks: type: object description: Field used to update the set of benchmarks used in Publisher. properties: returns: type: array items: type: object properties: portfolio: type: object description: 'A reference to the portfolio or vendor benchmark that contains the data this account should be benchmarked against' properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isComposite: type: boolean comment: type: string required: - portfolio holdings: type: array items: type: object properties: portfolio: type: object description: 'A reference to the portfolio or vendor benchmark that contains the data this account should be benchmarked against' properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isSpar: type: boolean description: 'Used to signal that the returns data from the provided portfolio should be used to benchmark this account.' isComposite: type: boolean comment: type: string required: - portfolio description: type: string description: 'Account composite description. This should be meaningful to the end user and will often be used in reports generated from this account composite.' dataCatalog: type: object description: Field used to make changes to the account's data container references. properties: returns: type: object description: Set the account composite's returns data containers. properties: realEstateTotal: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio privateEquityNet: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio privateEquityGross: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio primaryType: type: string enum: - CAPITAL - GROSS - NET - NET_AFTER_TAX - NET_INCOME - OTHER_1 - OTHER_2 - OTHER_3 - OTHER_4 - PRIVATE_EQUITY_GROSS - PRIVATE_EQUITY_NET - REAL_ESTATE_TOTAL description: 'Select the default returns series type for this account. Will throw an error if the selected return series type is not specified in the account.' other4: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio other3: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio other2: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio other1: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio netIncome: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio netAfterTax: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio net: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio gross: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio capital: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id field: type: string required: - portfolio holdings: type: object description: Set the account composite's holdings data containers. properties: type: type: string enum: - BLENDED - FIXED_DOLLAR - FLOATING - GIPS - SIMPLE rebalance: type: object properties: useActualFrequencies: type: boolean start: type: string enum: - LATEST_FREQUENCY_END - REPORT_START_DATE - SPECIFIC_POINT quarters: type: string enum: - FEBRUARY_MAY_AUGUST_NOVEMBER - JANUARY_APRIL_JULY_OCTOBER - MARCH_JUNE_SEPTEMBER_DECEMBER periods: type: string enum: - APRIL_OCTOBER - FEBRUARY_AUGUST - JANUARY_JULY - JUNE_DECEMBER - MARCH_SEPTEMBER - MAY_NOVEMBER month: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER frequency: type: string enum: - ANNUALLY - BUY_AND_HOLD - CONSTANTLY - DAILY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - WEEKLY dayOfWeek: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY dayOfMonth: type: string date: type: string required: - frequency methodology: type: string enum: - BUY_AND_HOLD - ORDER_MANAGMENT_SYSTEM - TRANSACTIONS components: type: array items: type: object properties: weight: type: number startDate: type: string portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - HoldingsComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id isSpar: type: boolean endDate: type: string required: - weight - startDate - portfolio - endDate required: - components benchmarks: type: object description: Field used to update the set of benchmarks used for this account. properties: returns: type: object properties: listOfIterated: type: array items: type: object properties: primary: type: object properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isComposite: type: boolean comment: type: string iterated: type: array items: type: object properties: startDate: type: string portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Returns - ReturnsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isComposite: type: boolean comment: type: string required: - startDate historicalTreatment: type: string enum: - COMBINED_AS_SINGLE_SERIES - LATEST_TAKES_PRECEDENCE required: - listOfIterated holdings: type: object properties: primary: type: object description: 'You may specify either primary or iterated, but not both. primary is a convinence for calling iterated with a single member starting from EARLIEST.' properties: portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isSpar: type: boolean isComposite: type: boolean comment: type: string iterated: type: array items: type: object properties: startDate: type: string portfolio: type: object properties: type: type: string enum: - Account - AccountComposite - Holdings - HoldingsComposite - Vendor id: type: string required: - type - id modifier: type: string enum: - BUY_AND_HOLD - EXTERNAL - ITERATED_BENCHMARK - LONG_ONLY - NONE - PASSIVE_PORTFOLIO - PASSIVE_WEIGHT - SHORT_ONLY - STYLE_BENCHMARK isSpar: type: boolean isComposite: type: boolean comment: type: string required: - startDate description: Specify a time iterated list of benchmarks historicalTreatment: type: string enum: - COMBINED_AS_SINGLE_SERIES - LATEST_TAKES_PRECEDENCE analytics: type: object description: Field used to update the default analytics settings for this account. properties: userDefinedValues: type: array items: type: object properties: value: type: string field: type: object properties: type: type: string enum: - UserDefinedField id: type: string required: - type - id required: - value - field currency: type: object properties: iso: type: string description: ISO 4217 Currency code. required: - iso required: - path - name - reason - dataCatalog example: path: Client:/examples/ name: EXAMPLE.ACTM reason: Making changes for project X publisher: benchmarks: returns: - portfolio: type: Account id: 6e16cf84-3733-4382-93e1-f88066b4239a modifier: BUY_AND_HOLD isComposite: false comment: Changed benchmark for reason holdings: - portfolio: type: Account id: 6e16cf84-3733-4382-93e1-f88066b4239a modifier: BUY_AND_HOLD isSpar: false isComposite: false comment: Changed benchmark for reason description: Domestic equity composite dataCatalog: returns: primaryType: NET net: portfolio: type: Account id: c80f9bac-6850-4c8e-99d1-e8f7bfd44955 field: RETURN holdings: type: BLENDED rebalance: frequency: DAILY methodology: BUY_AND_HOLD components: - weight: 10 startDate: '2022-01-01' portfolio: type: Account id: d5616607-cc1c-4f76-a040-77badf133356 isSpar: false endDate: '2022-01-31' benchmarks: returns: listOfIterated: - primary: portfolio: type: Account id: 872bc07e-aafd-4da2-afc5-978d59fab362 modifier: BUY_AND_HOLD isComposite: false comment: Changed benchmark for reason historicalTreatment: COMBINED_AS_SINGLE_SERIES holdings: primary: portfolio: type: Account id: 6e16cf84-3733-4382-93e1-f88066b4239a modifier: BUY_AND_HOLD isSpar: false isComposite: false comment: Changed benchmark for reason historicalTreatment: COMBINED_AS_SINGLE_SERIES analytics: userDefinedValues: - value: A user defined value field: type: UserDefinedField id: 948a076c-b7da-46f7-a476-a61c2d85241d currency: iso: USD required: - data Errors: type: object description: Information about one or more errors properties: errors: type: array description: List of errors items: type: object properties: id: type: string description: Unique identifier for this error instance. Used to reference this error in logging. example: 270c2fa8-9110-444b-9101-17e10132fe0a code: type: string description: Error code for this error enum: - BadRequestError - UnauthorizedError - ForbiddenError - NotFoundError - NotAcceptableError - ConflictError - UnsupportedMediaTypeError - InternalServerError - NotImplementedError title: type: string description: HTTP reason phrase associcated with this error enum: - Bad Request - Unauthorized - Forbidden - Not Found - Not Acceptable - Conflict - Unsupported Media Type - Internal Server Error - Not Implemented detail: type: string description: Detailed description of the error that occurred example: [] required: - errors listAccountCompositeResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - AccountComposite nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: 9a030822-d1ee-4fc0-a598-75e65d1512fd display: type: string nullable: false description: The GUI path of this file, including the name and extension. example: Client:EXAMPLE.ACTM path: type: string nullable: false description: The GUI path to this object. example: 'Client:' name: type: string nullable: false description: Name of this file object including the extension. example: EXAMPLE.ACTM description: type: string nullable: true description: User provided description of this file. example: Domestic equity composite nullable: false example: [] meta: type: object properties: pagination: type: object properties: next: type: string nullable: true example: YwAAAA== previous: type: string nullable: true example: AAAAAA== nullable: false example: example_value nullable: true updateAccountCompositeResponse: type: object properties: data: type: object properties: type: type: string enum: - AccountComposite nullable: false description: Metadata file type formatted for consistency with the REST api id: type: string nullable: false description: Unique identifier for this metadata file. example: 9a030822-d1ee-4fc0-a598-75e65d1512fd display: type: string nullable: false description: The GUI path of this file, including the name and extension. example: Client:EXAMPLE.ACTM path: type: string nullable: false description: The GUI path to this object. example: 'Client:' name: type: string nullable: false description: Name of this file object including the extension. example: EXAMPLE.ACTM nullable: false example: example_value nullable: true responses: GetStockCompositeProfileGetByNotation200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: Description missing nullable: false type: object x-property-sort: - idNotation - sourceIdentifier - description - CEO - industry - headquarters - symbol 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. description: nullable: true type: string format: localizedString description: Body of the background text for the description of the company. CEO: nullable: true type: string description: Full name of the CEO officer. industry: nullable: true type: string format: localizedString description: Name of the industry category. headquarters: nullable: true type: string format: localizedString description: Postal address and name of the country for theheadquarters of the company symbol: nullable: true type: string 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 notations, no symbol will be set for the notations of that market. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject_2' x-property-sort: - status BadRequestErrorResponse: description: The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing). content: application/json: schema: $ref: '#/components/schemas/Errors' GetInstrumentCompositeGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idInstrument: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the instrument. sourceIdentifier: nullable: true type: string description: Identifier used in the request. typeComposite: nullable: true type: string description: Type of the composite instrument. x-enum-description: - A basket is a composite instrument which consists of several components. Its value is calculated as the weighted combination of the levels of the components. All weights are positive. - An alpha structure is a composite instrument which consists of two components. Its value is calculated as the difference of the performances of the components. The performances are measured starting at the date specified in the conditions of the securitized derivative. - 'A futures spread is a composite instrument which is built of two or more different futures contracts as its components. ' - A factor index is a composite instrument that reflects the day-to-day performance of its component, multiplied with a constant factor. The related capital costs and fees for calculation and administration are not represented. enum: - basket - alphaStructure - futuresSpread - factorIndex activeManagement: nullable: true type: boolean description: If set to true, the composite instrument is actively managed. managementFee: nullable: true type: number format: relativeValue description: Management fee p.a. of the composite instrument. components: nullable: false description: Information regarding the components of the composite instrument. type: array items: type: object nullable: false x-property-sort: - name - valueUnit - notation - participation - numberShares - initialWeight - referenceLevel - constantLeverage properties: name: nullable: true type: string format: localizedString description: Name of the component, provided also if there is no notation for the component. valueUnit: nullable: false type: object x-property-sort: - id - code description: 'Value unit of the component, provided also if there is no notation for the component. See endpoint `/basic/valueUnit/list` for possible values.' properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. code: nullable: true type: string description: Code of the value unit. notation: nullable: false type: object x-property-sort: - id - fsym - instrument - operatingMIC description: Notation of the component. If there is no notation for the component, the object is null. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. 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 type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. 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). tickerRegion: 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 type: object x-property-sort: - id - fsym description: Instrument of the component. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. 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). operatingMIC: nullable: false type: object x-property-sort: - id - isoCode - name description: The operating MIC of the component. See endpoint `/basic/mic/operating/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the operating MIC. isoCode: nullable: true type: string description: ISO 10383 code of the operating MIC. name: nullable: true type: string description: English name of the operating MIC. participation: nullable: true type: string description: Indicates whether the level of the composite instrument rises or falls with a rising level of the component. The level of a basket always rises with rising level of its components and vice versa; therefore, for those the attribute is not set. The level of an alpha structure or a futures spread is calculated by subtracting the performance (price) of the short component from that of the long one. The level of a factor index rises with rising level of its component if the latter is long, and falls if it is short. For the type of composite instrument, see attribute `typeComposite`. x-enum-description: - The composite instrument's level rises with a rising level of the component. - The composite instrument's level falls with a rising level of the component. enum: - long - short numberShares: nullable: true type: number format: real description: 'Absolute number of shares of the component contained in the composite instrument. The absolute number of shares can be subject to change due to corporate actions or active management of the composite instrument (see attribute `activeManagement`). If the component is an index, the number of shares is a factor which applies to the level of the index.' initialWeight: nullable: true type: number format: relativeValue description: "Weighting of the component, valid only at initial fixing\n\n (see attribute `initialFixing` in endpoint `/securitizedDerivative/get`). " referenceLevel: nullable: true type: number format: real description: 'Level of the component on the issue date of the derivative product. For the value unit, see attribute `valueUnit`.' constantLeverage: nullable: true type: number format: real description: For a leveraged component, e.g. a component of a factor index, day-to-day leverage factor of the component's performance. nullable: false x-property-sort: - idInstrument - sourceIdentifier - typeComposite - activeManagement - managementFee - components description: Composite instrument and its components. 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 ForbiddenErrorResponse: description: The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action. content: application/json: schema: $ref: '#/components/schemas/Errors' NotFoundErrorResponse: description: The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. content: application/json: schema: $ref: '#/components/schemas/Errors' UnauthorizedErrorResponse: description: Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. content: application/json: schema: $ref: '#/components/schemas/Errors' UnsupportedMediaTypeErrorResponse: description: The request entity has a media type which the server or resource does not support. content: application/json: schema: $ref: '#/components/schemas/Errors' NotImplementedErrorResponse: description: '' content: application/json: schema: $ref: '#/components/schemas/Errors' NotAcceptableErrorResponse: description: The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. content: application/json: schema: $ref: '#/components/schemas/Errors' ConflictErrorResponse: description: Indicates that the request could not be processed because of conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates. content: application/json: schema: $ref: '#/components/schemas/Errors' InternalServerErrorResponse: description: '' content: application/json: schema: $ref: '#/components/schemas/Errors' securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation