Endpoints

Async Job - Request SDG Revenue Alignments Values for Funds

post
https://api.clarity.ai/clarity/v1/public/funds/sdg-rev/alignment-by-id/async

This endpoint will make a request for an async Job to retrieve the entire universe of Clarity.AI SDG Revenue Alignments for all funds and given Alignment Ids.
Please note: This call will only return the identifier (uuid) for this task. You'll need this value later on further calls to know the status of your job (see Async Job - Get job status) or download your file when ready (see «Async Job - Download result file»)
Check this document for a complete explanation of the flow for these Async jobs endpoints

Body Params
alignmentIds
array of strings

Requested Alignment IDs

alignmentIds
alignmentType
array of strings

Requested Alignment Types. If emtpy or null, all types are requested

alignmentType
optionalColumns
array of strings
enum

Optional columns to return in CSV:

  • FUND_GROUP_ID: Internal ID representing the group fund ID of a group of fund share classes
optionalColumns
boolean

Include only one Fund Share Class for each fund group in the response

idColumns
array of strings
enum
Defaults to ISIN

Allows you to specify a list of fund ID types that will be included in the response. Only the funds that have an identifier type matching 'idColumns' will be returned. If you want to retrieve all funds, you can set 'idColumns' to "ALL" and no funds will be filtered out. Take into account that when using the "ALL" parameter whenever a new fund identifier type is available in the Clarity AI platform it will be included in the response.

idColumns
Responses

Updated 6 days ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 days ago