Jump to

• Request
• Response

Batch Create Portfolio Measures

post

/api/restapi/portfolioMeasure/batch

Send a request to this endpoint to create one or more portfolio measures. An application object will be created for each JSON object provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityPortfolioMeasureInput>

Type: array

Title: List<ApiEntityPortfolioMeasureInput>

Show Source

• Array of: object ApiEntityPortfolioMeasureInput
  Title: ApiEntityPortfolioMeasureInput

  This entity represents a PortfolioMeasure object, a unique PortfolioMeasure object can be identified by the following combinations of the fields.

  • portfolioMeasureId
  • measureId,portfolioId
  • measureName,portfolioId,workspaceCode
  • measureName,portfolioName,workspaceCode
  • measureId,portfolioName,workspaceCode

{
    "title":"List<ApiEntityPortfolioMeasureInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityPortfolioMeasureInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityPortfolioMeasureInput

Type: object

Title: ApiEntityPortfolioMeasureInput

This entity represents a PortfolioMeasure object, a unique PortfolioMeasure object can be identified by the following combinations of the fields.

• portfolioMeasureId
• measureId,portfolioId
• measureName,portfolioId,workspaceCode
• measureName,portfolioName,workspaceCode
• measureId,portfolioName,workspaceCode

Show Source

• enabledFlag(required): boolean
  Indicates the state of the measure. Enabled measures can be associated with portfolios.
• lastCalculatedDate: string (date-time)
  The date on which the measure was last calculated.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• measureId(required): integer (int64)
  The unique identifier of a portfolio measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioId(required): integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• portfolioMeasureId: integer (int64)
  The unique identifier of a portfolio measure.
• portfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityPortfolioMeasureInput",
    "required":[
        "enabledFlag",
        "measureId",
        "portfolioId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "enabledFlag":{
            "type":"boolean",
            "description":"Indicates the state of the measure. Enabled measures can be associated with portfolios.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "lastCalculatedDate":{
            "type":"string",
            "description":"The date on which the measure was last calculated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a PortfolioMeasure object, a unique PortfolioMeasure object can be identified by the following combinations of the fields.<ul><li>portfolioMeasureId</li><li>measureId,portfolioId</li><li>measureName,portfolioId,workspaceCode</li><li>measureName,portfolioName,workspaceCode</li><li>measureId,portfolioName,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Portfolio Measures

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityPortfolioMeasure>

Type: array

Title: List<ApiEntityPortfolioMeasure>

Show Source

• Array of: object ApiEntityPortfolioMeasure
  Title: ApiEntityPortfolioMeasure

{
    "title":"List<ApiEntityPortfolioMeasure>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityPortfolioMeasure",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityPortfolioMeasure

Type: object

Title: ApiEntityPortfolioMeasure

Show Source

• enabledFlag: boolean
  Indicates the state of the measure. Enabled measures can be associated with portfolios.
• lastCalculatedDate: string (date-time)
  The date on which the measure was last calculated.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• measureId: integer (int64)
  The unique identifier of a portfolio measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioId: integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• portfolioMeasureId: integer (int64)
  The unique identifier of a portfolio measure.
• portfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityPortfolioMeasure",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "enabledFlag":{
            "type":"boolean",
            "description":"Indicates the state of the measure. Enabled measures can be associated with portfolios.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "lastCalculatedDate":{
            "type":"string",
            "description":"The date on which the measure was last calculated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for a baseline portfolio measure.

Back to Top