PortfolioFit

{
  "type": "object",
  "$defs": {
    "ExposureFilter": {
      "type": "object",
      "title": "ExposureFilter",
      "required": [
        "dimension",
        "match",
        "values"
      ],
      "properties": {
        "match": {
          "enum": [
            "equals",
            "not_equals",
            "in",
            "not_in"
          ],
          "type": "string",
          "title": "Match"
        },
        "values": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "title": "Values",
          "maxItems": 100,
          "minItems": 1
        },
        "dimension": {
          "enum": [
            "denomination_currency",
            "country",
            "domicile",
            "issuer_country",
            "listing_country",
            "asset_class",
            "rating",
            "sector"
          ],
          "type": "string",
          "title": "Dimension"
        }
      },
      "additionalProperties": false
    },
    "AlignmentHolding": {
      "type": "object",
      "title": "AlignmentHolding",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "maxLength": 120,
          "minLength": 1
        },
        "name": {
          "type": "string",
          "title": "Name",
          "maxLength": 500,
          "minLength": 1
        },
        "value": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Value",
          "default": null
        },
        "weight": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Weight",
          "default": null,
          "description": "Portfolio weight. Prefer a decimal share such as 0.24 for 24%. Percentage-point inputs such as 24 are also accepted and normalized when the supplied holdings use that convention."
        },
        "currency": {
          "type": "string",
          "title": "Currency",
          "default": "",
          "maxLength": 16
        },
        "attributes": {
          "type": "object",
          "title": "Attributes",
          "maxProperties": 100,
          "additionalProperties": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "source_reference": {
          "type": "string",
          "title": "Source Reference",
          "default": "",
          "maxLength": 500
        }
      },
      "additionalProperties": false
    },
    "DeterministicConstraint": {
      "type": "object",
      "title": "DeterministicConstraint",
      "required": [
        "id",
        "metric",
        "operator"
      ],
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "maxLength": 120,
          "minLength": 1
        },
        "top_n": {
          "anyOf": [
            {
              "type": "integer",
              "maximum": 1000,
              "minimum": 1
            },
            {
              "type": "null"
            }
          ],
          "title": "Top N",
          "default": null
        },
        "metric": {
          "enum": [
            "single_holding_weight",
            "selected_holdings_weight",
            "filtered_holdings_weight",
            "top_n_holdings_weight",
            "holding_count",
            "total_weight"
          ],
          "type": "string",
          "title": "Metric"
        },
        "operator": {
          "enum": [
            "<",
            "<=",
            "=",
            "!=",
            ">=",
            ">",
            "range"
          ],
          "type": "string",
          "title": "Operator"
        },
        "max_value": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Max Value",
          "default": null
        },
        "min_value": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Min Value",
          "default": null
        },
        "threshold": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Threshold",
          "default": null
        },
        "holding_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "title": "Holding Ids",
          "maxItems": 1000
        },
        "exposure_filter": {
          "anyOf": [
            {
              "$ref": "#/$defs/ExposureFilter"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "additionalProperties": false
    }
  },
  "title": "calculate_portfolio_constraintsArguments",
  "required": [
    "holdings",
    "constraints",
    "idempotency_key"
  ],
  "properties": {
    "holdings": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AlignmentHolding"
      },
      "title": "Holdings",
      "maxItems": 1000,
      "minItems": 1
    },
    "constraints": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DeterministicConstraint"
      },
      "title": "Constraints",
      "maxItems": 250,
      "minItems": 1
    },
    "analysis_name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Analysis Name",
      "default": null,
      "description": "Optional private grouping name. The same case-sensitive name, after trimming outer whitespace, reuses one group for this user. Omit it for an independent operation. Keep the name on retries; each calculation still needs its own idempotency_key."
    },
    "base_currency": {
      "type": "string",
      "title": "Base Currency",
      "default": "USD",
      "maxLength": 16,
      "minLength": 1
    },
    "idempotency_key": {
      "type": "string",
      "title": "Idempotency Key",
      "maxLength": 255,
      "minLength": 1
    },
    "source_warnings": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 2000,
            "minLength": 1
          },
          "maxItems": 100
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Warnings",
      "default": null
    },
    "composition_scope": {
      "enum": [
        "complete",
        "partial",
        "unknown"
      ],
      "type": "string",
      "title": "Composition Scope",
      "default": "unknown"
    }
  }
}

{
  "type": "object",
  "title": "cancel_portfolio_series_uploadArguments",
  "required": [
    "upload_id"
  ],
  "properties": {
    "upload_id": {
      "type": "string",
      "title": "Upload Id",
      "format": "uuid"
    },
    "analysis_name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Analysis Name",
      "default": null,
      "description": "Optional private grouping name. The same case-sensitive name, after trimming outer whitespace, reuses one group for this user. Omit it for an independent operation. Keep the name on retries; each calculation still needs its own idempotency_key."
    }
  }
}

{
  "type": "object",
  "$defs": {
    "AlignmentRule": {
      "type": "object",
      "title": "AlignmentRule",
      "required": [
        "target",
        "operator"
      ],
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Id",
          "default": null
        },
        "unit": {
          "type": "string",
          "title": "Unit",
          "default": "percent",
          "maxLength": 64
        },
        "title": {
          "type": "string",
          "title": "Title",
          "default": "",
          "maxLength": 200
        },
        "target": {
          "type": "string",
          "title": "Target",
          "maxLength": 500,
          "minLength": 1
        },
        "enabled": {
          "type": "boolean",
          "title": "Enabled",
          "default": true
        },
        "operator": {
          "enum": [
            "<",
            "<=",
            "=",
            "!=",
            ">=",
            ">",
            "range"
          ],
          "type": "string",
          "title": "Operator"
        },
        "max_value": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Max Value",
          "default": null
        },
        "min_value": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Min Value",
          "default": null
        },
        "threshold": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Threshold",
          "default": null
        },
        "explanation": {
          "type": "string",
          "title": "Explanation",
          "default": "",
          "maxLength": 2000
        },
        "exposure_filter": {
          "anyOf": [
            {
              "$ref": "#/$defs/ExposureFilter"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "additionalProperties": false
    },
    "ExposureFilter": {
      "type": "object",
      "title": "ExposureFilter",
      "required": [
        "dimension",
        "match",
        "values"
      ],
      "properties": {
        "match": {
          "enum": [
            "equals",
            "not_equals",
            "in",
            "not_in"
          ],
          "type": "string",
          "title": "Match"
        },
        "values": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "title": "Values",
          "maxItems": 100,
          "minItems": 1
        },
        "dimension": {
          "enum": [
            "denomination_currency",
            "country",
            "domicile",
            "issuer_country",
            "listing_country",
            "asset_class",
            "rating",
            "sector"
          ],
          "type": "string",
          "title": "Dimension"
        }
      },
      "additionalProperties": false
    },
    "AlignmentHolding": {
      "type": "object",
      "title": "AlignmentHolding",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "maxLength": 120,
          "minLength": 1
        },
        "name": {
          "type": "string",
          "title": "Name",
          "maxLength": 500,
          "minLength": 1
        },
        "value": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Value",
          "default": null
        },
        "weight": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Weight",
          "default": null,
          "description": "Portfolio weight. Prefer a decimal share such as 0.24 for 24%. Percentage-point inputs such as 24 are also accepted and normalized when the supplied holdings use that convention."
        },
        "currency": {
          "type": "string",
          "title": "Currency",
          "default": "",
          "maxLength": 16
        },
        "attributes": {
          "type": "object",
          "title": "Attributes",
          "maxProperties": 100,
          "additionalProperties": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "source_reference": {
          "type": "string",
          "title": "Source Reference",
          "default": "",
          "maxLength": 500
        }
      },
      "additionalProperties": false
    }
  },
  "title": "evaluate_portfolio_alignmentArguments",
  "required": [
    "holdings",
    "idempotency_key"
  ],
  "properties": {
    "rules": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AlignmentRule"
          },
          "maxItems": 250
        },
        {
          "type": "null"
        }
      ],
      "title": "Rules",
      "default": null
    },
    "mandate": {
      "type": "string",
      "title": "Mandate",
      "default": "",
      "maxLength": 50000
    },
    "holdings": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AlignmentHolding"
      },
      "title": "Holdings",
      "maxItems": 1000,
      "minItems": 1
    },
    "analysis_name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Analysis Name",
      "default": null,
      "description": "Optional private grouping name. The same case-sensitive name, after trimming outer whitespace, reuses one group for this user. Omit it for an independent operation. Keep the name on retries; each calculation still needs its own idempotency_key."
    },
    "base_currency": {
      "type": "string",
      "title": "Base Currency",
      "default": "USD",
      "maxLength": 16,
      "minLength": 1
    },
    "portfolio_name": {
      "type": "string",
      "title": "Portfolio Name",
      "default": "Portfolio",
      "maxLength": 255
    },
    "idempotency_key": {
      "type": "string",
      "title": "Idempotency Key",
      "maxLength": 255,
      "minLength": 1
    },
    "source_warnings": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 2000,
            "minLength": 1
          },
          "maxItems": 100
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Warnings",
      "default": null
    },
    "composition_scope": {
      "enum": [
        "complete",
        "partial",
        "unknown"
      ],
      "type": "string",
      "title": "Composition Scope",
      "default": "unknown"
    }
  }
}

{
  "type": "object",
  "title": "get_analysisArguments",
  "required": [
    "analysis_id"
  ],
  "properties": {
    "analysis_id": {
      "type": "string",
      "title": "Analysis Id",
      "format": "uuid"
    }
  }
}

{
  "type": "object",
  "title": "list_analysesArguments",
  "properties": {
    "kind": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kind",
      "default": null
    },
    "page": {
      "type": "integer",
      "title": "Page",
      "default": 1,
      "minimum": 1
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Status",
      "default": null
    },
    "date_to": {
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "null"
        }
      ],
      "title": "Date To",
      "default": null
    },
    "date_from": {
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "null"
        }
      ],
      "title": "Date From",
      "default": null
    },
    "page_size": {
      "type": "integer",
      "title": "Page Size",
      "default": 20,
      "maximum": 100,
      "minimum": 1
    },
    "portfolio_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Portfolio Id",
      "default": null
    }
  }
}

{
  "type": "object",
  "title": "list_analysis_portfoliosArguments",
  "properties": {}
}

{
  "type": "object",
  "title": "list_portfolio_seriesArguments",
  "properties": {
    "cursor": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Cursor",
      "default": null
    },
    "statuses": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "enum": [
              "proposed",
              "confirmed"
            ],
            "type": "string"
          },
          "maxItems": 2
        },
        {
          "type": "null"
        }
      ],
      "title": "Statuses",
      "default": null
    },
    "page_size": {
      "type": "integer",
      "title": "Page Size",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "portfolio_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Portfolio Id",
      "default": null
    }
  }
}

{
  "type": "object",
  "title": "review_portfolio_series_profileArguments",
  "required": [
    "profile_id",
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "revise",
        "confirm"
      ],
      "type": "string",
      "title": "Action"
    },
    "revisions": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "title": "Revisions",
      "default": null
    },
    "profile_id": {
      "type": "string",
      "title": "Profile Id",
      "format": "uuid"
    },
    "confirmation": {
      "type": "boolean",
      "title": "Confirmation",
      "default": false
    },
    "analysis_name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Analysis Name",
      "default": null,
      "description": "Optional private grouping name. The same case-sensitive name, after trimming outer whitespace, reuses one group for this user. Omit it for an independent operation. Keep the name on retries; each calculation still needs its own idempotency_key."
    }
  }
}