Jump to

• Request
• Response

View a Project Rank

get

/api/restapi/projectRank/{projectRankId}

This endpoint returns a project rank that meet the following requirements:

• The object has an ID that matches the value of the {projectRankId} path parameter.

Request

Path Parameters

• projectRankId(required): integer(int64)
  ID of the Project Rank that has to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityProjectRank

Type: object

Title: ApiEntityProjectRank

Show Source

• categoryScore: number (double)
  Category score.
• evaluationCategoryId: integer (int64)
  Evaluation category ID.
• evaluationRankId: integer (int64)
  The ranking for the evaluation category.
• evaluationSubCategoryId: integer (int64)
  Evaluation subcategory ID.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectId: integer (int64)
  The system-generated identifier of the project.
• projectRankId: integer (int64)
  The system-generated identifier of the project rank.
• subCategoryScore: number (double)
  The evaluation score of a project per category and sub-category.
  The sub-category score formula is calculated as the selected Rank Weight % multiplied by the given sub-category Weight % divided by 100.
  The category score formula is calculated as the sum of the sub-category Scores. If a given sub-category does not have a score, its score is 0.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityProjectRank",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRankId":{
            "type":"integer",
            "description":"The system-generated identifier of the project rank.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "evaluationCategoryId":{
            "type":"integer",
            "description":"Evaluation category ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "evaluationSubCategoryId":{
            "type":"integer",
            "description":"Evaluation subcategory ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "evaluationRankId":{
            "type":"integer",
            "description":"The ranking for the evaluation category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "categoryScore":{
            "type":"number",
            "description":"Category score.",
            "format":"double",
            "exampleSetFlag":false
        },
        "subCategoryScore":{
            "type":"number",
            "description":"The evaluation score of a project per category and sub-category. <br />The sub-category score formula is calculated as the selected Rank Weight % multiplied by the given sub-category Weight % divided by 100. <br />The category score formula is calculated as the sum of the sub-category Scores. If a given sub-category does not have a score, its score is 0.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested project rank does not exist, or you do not have access to it.

Back to Top