Jump to

• Request
• Response

Batch Create Project Ranks

post

/api/restapi/projectRank/batch

Send a request to this endpoint to create one or more project ranks. 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<ApiEntityProjectRankInput>

Type: array

Title: List<ApiEntityProjectRankInput>

Show Source

• Array of: object ApiEntityProjectRankInput
  Title: ApiEntityProjectRankInput

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

  • projectRankId

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

Nested Schema : ApiEntityProjectRankInput

Type: object

Title: ApiEntityProjectRankInput

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

• projectRankId

Show Source

• evaluationCategoryId(required): integer (int64)
  Evaluation category ID.
• evaluationRankId(required): integer (int64)
  The ranking for the evaluation category.
• evaluationSubCategoryId(required): integer (int64)
  Evaluation subcategory ID.
• projectId(required): integer (int64)
  The system-generated identifier of the project.
• projectRankId: integer (int64)
  The system-generated identifier of the project rank.

{
    "title":"ApiEntityProjectRankInput",
    "required":[
        "evaluationCategoryId",
        "evaluationRankId",
        "evaluationSubCategoryId",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a ProjectRank object, a unique ProjectRank object can be identified by the following combinations of the fields.<ul><li>projectRankId</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Project Ranks

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityProjectRank>

Type: array

Title: List<ApiEntityProjectRank>

Show Source

• Array of: object ApiEntityProjectRank
  Title: ApiEntityProjectRank

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

Nested 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)
  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)
  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",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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
        },
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input.

Back to Top