Jump to

• Request
• Response

Create a Portfolio Measure Manual Value

post

/api/restapi/portfolioMeasureManualValue

Send a request to this endpoint to create a portfolio measure manual value. An application object will be created using the JSON data 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 : ApiEntityPortfolioMeasureManualValueInput

Type: object

Title: ApiEntityPortfolioMeasureManualValueInput

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

• portfolioMeasureManualValueId
• measureId,capitalPortfolioId,beginDate,endDate
• measureName,capitalPortfolioId,beginDate,endDate,workspaceCode
• measureId,portfolioName,beginDate,endDate,workspaceCode
• measureName,portfolioName,beginDate,endDate,workspaceCode

Show Source

• actualValue: number (double)
  The actual value for the measure.
• beginDate(required): string (date-time)
  The start date of a portfolio.
• capitalPortfolioId(required): integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• endDate(required): string (date-time)
  The end date of the portfolio.
• 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 measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioMeasureManualValueId: integer (int64)
  The unique identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• portfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• targetValue: number (double)
  The target value for the measure.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.
• varValue: number (double)
  The variance of a portfolio.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityPortfolioMeasureManualValueInput",
    "required":[
        "beginDate",
        "capitalPortfolioId",
        "endDate",
        "measureId"
    ],
    "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"
            ]
        },
        "capitalPortfolioId":{
            "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"
            ]
        },
        "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 measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureManualValueId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "beginDate":{
            "type":"string",
            "description":"The start date of a portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The end date of the portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetValue":{
            "type":"number",
            "description":"The target value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualValue":{
            "type":"number",
            "description":"The actual value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "varValue":{
            "type":"number",
            "description":"The variance of a portfolio.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        }
    },
    "description":"This entity represents a PortfolioMeasureManualValue object, a unique PortfolioMeasureManualValue object can be identified by the following combinations of the fields.<ul><li>portfolioMeasureManualValueId</li><li>measureId,capitalPortfolioId,beginDate,endDate</li><li>measureName,capitalPortfolioId,beginDate,endDate,workspaceCode</li><li>measureId,portfolioName,beginDate,endDate,workspaceCode</li><li>measureName,portfolioName,beginDate,endDate,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create a Portfolio Measure Manual Value Create a Portfolio Measure Manual Value Using Codes

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityPortfolioMeasureManualValue

Type: object

Title: ApiEntityPortfolioMeasureManualValue

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

• portfolioMeasureManualValueId
• measureId,capitalPortfolioId,beginDate,endDate
• measureName,capitalPortfolioId,beginDate,endDate,workspaceCode
• measureId,portfolioName,beginDate,endDate,workspaceCode
• measureName,portfolioName,beginDate,endDate,workspaceCode

Show Source

• actualValue: number (double)
  The actual value for the measure.
• beginDate: string (date-time)
  The start date of a portfolio.
• capitalPortfolioId: integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• endDate: string (date-time)
  The end date of the portfolio.
• 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 measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioMeasureManualValueId: integer (int64)
  The unique identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• portfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• targetValue: number (double)
  The target value for the measure.
• updateDate: string (date-time)
  Date when the record was last updated.
• varValue: number (double)
  The variance of a portfolio.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityPortfolioMeasureManualValue",
    "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"
            ]
        },
        "capitalPortfolioId":{
            "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"
            ]
        },
        "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 measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureManualValueId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "beginDate":{
            "type":"string",
            "description":"The start date of a portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The end date of the portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetValue":{
            "type":"number",
            "description":"The target value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualValue":{
            "type":"number",
            "description":"The actual value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "varValue":{
            "type":"number",
            "description":"The variance of a portfolio.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a PortfolioMeasureManualValue object, a unique PortfolioMeasureManualValue object can be identified by the following combinations of the fields.<ul><li>portfolioMeasureManualValueId</li><li>measureId,capitalPortfolioId,beginDate,endDate</li><li>measureName,capitalPortfolioId,beginDate,endDate,workspaceCode</li><li>measureId,portfolioName,beginDate,endDate,workspaceCode</li><li>measureName,portfolioName,beginDate,endDate,workspaceCode</li>",
    "exampleSetFlag":false
}

400 Response

Invalid input for a baseline portfolio measure.

Back to Top