Jump to

• Request
• Response

Update a Portfolio Measure

put

/api/restapi/portfolioMeasure

Send a request to this endpoint to update a portfolio measure. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root 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 Update an Portfolio Measure Using Codes Update an Portfolio Measure

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for a baseline portfolio measure.

Back to Top