Jump to

• Request
• Response

Update an Evaluation Rank

put

/api/restapi/evaluationMatrix/evaluationRank

Send a request to this endpoint to update an evaluation Rank. 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 : ApiEntityEvaluationRankInput

Type: object

Title: ApiEntityEvaluationRankInput

Show Source

• color: string
  Maximum Length: 20

  The color representing the evaluation ranking.
• description: string
  Maximum Length: 4000

  Details describing the evaluation ranking.
• level: integer (int64)
  The identifier for the order in which the ranks are displayed.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• rankId: integer (int64)
  The unique identifier for an evaluation rank.
• rankName: string
  Maximum Length: 255

  The name of the evaluation ranking.
• subCategoryId: integer (int64)
  The unique identifier of the evaluation sub-category to which the evaluation rank is associated.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• weightPercent: number (double)
  The weight percentage for the evaluation ranking. This value is automatically calculated based on the number of selected ranks.

{
    "title":"ApiEntityEvaluationRankInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</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"
            ]
        },
        "level":{
            "type":"integer",
            "description":"The identifier for the order in which the ranks are displayed.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "color":{
            "maxLength":"20",
            "type":"string",
            "description":"The color representing the evaluation ranking.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Details describing the evaluation ranking.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "weightPercent":{
            "type":"number",
            "description":"The weight percentage for the evaluation ranking. This value is automatically calculated based on the number of selected ranks.",
            "format":"double",
            "exampleSetFlag":false
        },
        "rankId":{
            "type":"integer",
            "description":"The unique identifier for an evaluation rank.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rankName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the evaluation ranking.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "subCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the evaluation sub-category to which the evaluation rank is associated.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Evaluation Category service. Verify the request contains valid data, then resubmit the request.

Back to Top