Jump to

• Request
• Response

View Evaluation Matrix by Workspace

get

/api/restapi/evaluationMatrix/workspace/{workspaceId}

This endpoint returns evaluation Matrix that meet the following requirements:

• The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.

Request

Path Parameters

• workspaceId(required): integer(int64)
  ID of the workspace for which Evaluation Matrix 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 : ApiEntityEvaluationMatrix

Type: object

Title: ApiEntityEvaluationMatrix

Show Source

• associationType: string
  Read Only: true

  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the evaluation matrix and the workspace. Possible values are Owned and Inherited.
• categories: array categories
  The evaluation categories of an evaluation matrix.
• description: string
  Maximum Length: 4000

  Details describing the evaluation matrix.
• evaluationMatrixId: integer (int64)
  The unique identifier for the evaluation matrix.
• evaluationMatrixName: string
  Maximum Length: 255

  The name of the evaluation matrix.
• isActive: boolean
  The status of Evaluation Matrix.
  Active: The Evaluation Matrix is in an usable state.
  Inactive: The Evaluation Matrix is not in an usable state.
• lastEvaluationChange: string (date-time)
  The time stamp of the most recent change to a category, sub-category, or rank of the evaluation matrix.
• 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.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  How data is shared between parent and child workspaces.
  Manual: Data can be pulled down by child workspaces. This is the default option.
  Automatic: Data is automatically shared with all child workspaces.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The workspace the evaluation matrix is associated with.

{
    "title":"ApiEntityEvaluationMatrix",
    "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"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Details describing the evaluation matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The workspace the evaluation matrix is associated with.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "isActive":{
            "type":"boolean",
            "description":"The status of Evaluation Matrix. <br/>Active: The Evaluation Matrix is in an usable state. <br/>Inactive: The Evaluation Matrix is not in an usable state.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the evaluation matrix and the workspace. Possible values are Owned and Inherited.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "evaluationMatrixName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the evaluation matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "categories":{
            "type":"array",
            "description":"The evaluation categories of an evaluation matrix.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityEvaluationCategory",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "lastEvaluationChange":{
            "type":"string",
            "description":"The time stamp of the most recent change to a category, sub-category, or rank of the evaluation matrix. ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationMatrixId":{
            "type":"integer",
            "description":"The unique identifier for the evaluation matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : categories

Type: array

The evaluation categories of an evaluation matrix.

Show Source

• Array of: object ApiEntityEvaluationCategory
  Title: ApiEntityEvaluationCategory

{
    "type":"array",
    "description":"The evaluation categories of an evaluation matrix.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityEvaluationCategory",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityEvaluationCategory

Type: object

Title: ApiEntityEvaluationCategory

Show Source

• categoryId: integer (int64)
  The unique identifier for an evaluation category.
• categoryName: string
  Maximum Length: 255

  The name of the evaluation category.
• description: string
  Maximum Length: 4000

  Details describing the evaluation category.
• evaluationMatrixId: integer (int64)
  The unique identifier of the evaluation matrix to which the evaluation category is associated.
• 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.
• sequenceNumber: integer (int32)
  The order in which the evaluation category is displayed.
• subCategories: array subCategories
  The evaluation sub-categories of an evaluation category.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• weight: integer (int64)
  Minimum Value: 1

  Maximum Value: 100

  The relative weight of the sibling evaluation node to indicate contribution of a given node to its parent evaluation node.
• weightPercent: number (double)
  The weight or relative rank of the evaluation node compared to its siblings. This value indicates the percentage that the evaluation node is contributing to the parent strategy. The Weight Percent for all sibling evaluation nodes equals 100. This field is read-only.

{
    "title":"ApiEntityEvaluationCategory",
    "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"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The order in which the evaluation category is displayed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Details describing the evaluation category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "weight":{
            "maximum":"100",
            "minimum":"1",
            "type":"integer",
            "description":"The relative weight of the sibling evaluation node to indicate contribution of a given node to its parent evaluation node.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "subCategories":{
            "type":"array",
            "description":"The evaluation sub-categories of an evaluation category.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityEvaluationSubCategory",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "categoryId":{
            "type":"integer",
            "description":"The unique identifier for an evaluation category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "categoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the evaluation category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "weightPercent":{
            "type":"number",
            "description":"The weight or relative rank of the evaluation node compared to its siblings. This value indicates the percentage that the evaluation node is contributing to the parent strategy. The Weight Percent for all sibling evaluation nodes equals 100. This field is read-only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "evaluationMatrixId":{
            "type":"integer",
            "description":"The unique identifier of the evaluation matrix to which the evaluation category is associated.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : subCategories

Type: array

The evaluation sub-categories of an evaluation category.

Show Source

• Array of: object ApiEntityEvaluationSubCategory
  Title: ApiEntityEvaluationSubCategory

{
    "type":"array",
    "description":"The evaluation sub-categories of an evaluation category.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityEvaluationSubCategory",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityEvaluationSubCategory

Type: object

Title: ApiEntityEvaluationSubCategory

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the Evaluation sub-category and the workspace.
• categoryId: integer (int64)
  The unique identifier of the evaluation category to which the evaluation sub-category is associated.
• description: string
  Maximum Length: 4000

  Details describing the evaluation sub-category.
• enabledFlag: boolean
  The status of Evaluation sub-category.
  Enabled: Evaluation sub-category gets considered for calculating the evaluation score.
  Disabled: Evaluation sub-category does not get considered for calculating the evaluation score.
• 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.
• owningWorkspaceId: integer (int64)
  ID of the workspace for which sub-category has to be found.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the sub-category in evaluation matrix.
• rankLevels: integer (int64)
  The number of options available on the rating scale for the sub-category.
• ranks: array ranks
  The evaluation ranks of an evaluation sub-category.
• sequenceNumber: integer (int32)
  The order in which the evaluation sub-category is displayed within a category.
• subCategoryId: integer (int64)
  The unique identifier for an evaluation sub-category.
• subCategoryName: string
  Maximum Length: 255

  The name of the evaluation sub-category.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• weight: integer (int64)
  Minimum Value: 1

  Maximum Value: 100

  The relative weight of the sibling evaluation sub-category node. This value indicates the contribution of a given node to its parent evaluation node.
• weightPercent: number (double)
  The weight or relative rank of the evaluation sub-category node compared to its siblings. This value indicates the percentage that the evaluation sub-category node is contributing to the parent category. The total Weight Percent for all sibling evaluation sub-category nodes equals 100.

{
    "title":"ApiEntityEvaluationSubCategory",
    "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"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The order in which the evaluation sub-category is displayed within a category.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Details describing the evaluation sub-category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "weight":{
            "maximum":"100",
            "minimum":"1",
            "type":"integer",
            "description":"The relative weight of the sibling evaluation sub-category node. This value indicates the contribution of a given node to its parent evaluation node.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the sub-category in evaluation matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the Evaluation sub-category and the workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "categoryId":{
            "type":"integer",
            "description":"The unique identifier of the evaluation category to which the evaluation sub-category is associated.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "weightPercent":{
            "type":"number",
            "description":"The weight or relative rank of the evaluation sub-category node compared to its siblings. This value indicates the percentage that the evaluation sub-category node is contributing to the parent category. The total Weight Percent for all sibling evaluation sub-category nodes equals 100.",
            "format":"double",
            "exampleSetFlag":false
        },
        "subCategoryId":{
            "type":"integer",
            "description":"The unique identifier for an evaluation sub-category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "ranks":{
            "type":"array",
            "description":"The evaluation ranks of an evaluation sub-category.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityEvaluationRank",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "enabledFlag":{
            "type":"boolean",
            "description":"The status of Evaluation sub-category. <br/>Enabled: Evaluation sub-category gets considered for calculating the evaluation score. <br/>Disabled: Evaluation sub-category does not get considered for calculating the evaluation score.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "subCategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the evaluation sub-category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rankLevels":{
            "type":"integer",
            "description":"The number of options available on the rating scale for the sub-category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "owningWorkspaceId":{
            "type":"integer",
            "description":"ID of the workspace for which sub-category has to be found.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ranks

Type: array

The evaluation ranks of an evaluation sub-category.

Show Source

• Array of: object ApiEntityEvaluationRank
  Title: ApiEntityEvaluationRank

{
    "type":"array",
    "description":"The evaluation ranks of an evaluation sub-category.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityEvaluationRank",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityEvaluationRank

Type: object

Title: ApiEntityEvaluationRank

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)
  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)
  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":"ApiEntityEvaluationRank",
    "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"
            ]
        },
        "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":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested evaluation matrix does not exist, or you do not have access to them.

Back to Top