Jump to

• Request
• Response

Create an analytic option

post

/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes

Request

Path Parameters

• talentReviewMeetingTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Talent Review Meeting Templates resource and used to uniquely identify an instance of Talent Review Meeting Templates. The client should not generate the hash key value. Instead, the client should query on the Talent Review Meeting Templates collection resource in order to navigate to a specific instance of Talent Review Meeting Templates to get the hash key.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AnalyticTypeId: integer (int64)
  Unique identifier for the box chart view.
• AnalyticViewMode(required): string
  Maximum Length: 30

  Indicates if the box chart view is an XY view or a single rating view.
• AnalyticViewName(required): string
  Maximum Length: 240

  Name of the box chart view created in the talent review meeting template.
• boxLabels: array Box Labels
  Title: Box Labels

  The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.
• boxRatings: array Box Ratings
  Title: Box Ratings

  The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.
• BusinessGroupId(required): integer (int64)
  Unique identifier for the business group for which the talent review meeting template will be used.
• ColorSchemeCode: string
  Title: Color Scheme

  Maximum Length: 30

  Code that identifies the color scheme used for the box chart view.
• DefaultViewFlag: boolean
  Maximum Length: 30

  Indicates if the box chart view is the default view.
• HorizontalAxisCode: string
  Maximum Length: 30

  Code for the rating used on the X-Axis of the box chart or for the single rating view.
• MetricCode: string
  Maximum Length: 30

  Code for the rating used in the talent review meeting template.
• SubmitBoxAsgnmntFlag: boolean
  Maximum Length: 30

  Indicates if the box assignment is submitted.
• VerticalAxisCode: string
  Title: Vertical Axis Value

  Maximum Length: 30

  Code for the rating used on the Y-Axis of the box chart.
• ViewColumnCount: string
  Maximum Length: 30

  Number of columns used in the box chart view.
• ViewRowCount: string
  Maximum Length: 30

  Number of rows used in the box chart view.

{
    "required":[
        "AnalyticViewMode",
        "AnalyticViewName",
        "BusinessGroupId"
    ],
    "type":"object",
    "properties":{
        "boxRatings":{
            "title":"Box Ratings",
            "type":"array",
            "description":"The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.",
            "items":{
                "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxRatings-item-post-request"
            }
        },
        "VerticalAxisCode":{
            "title":"Vertical Axis Value",
            "maxLength":30,
            "type":"string",
            "description":"Code for the rating used on the Y-Axis of the box chart.",
            "nullable":true
        },
        "AnalyticViewName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the box chart view created in the talent review meeting template.",
            "nullable":false
        },
        "SubmitBoxAsgnmntFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the box assignment is submitted.",
            "nullable":true
        },
        "HorizontalAxisCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the rating used on the X-Axis of the box chart or for the single rating view.",
            "nullable":true
        },
        "ColorSchemeCode":{
            "title":"Color Scheme",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the color scheme used for the box chart view.",
            "nullable":true
        },
        "ViewRowCount":{
            "maxLength":30,
            "type":"string",
            "description":"Number of rows used in the box chart view.",
            "nullable":true
        },
        "MetricCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the rating used in the talent review meeting template.",
            "nullable":true
        },
        "DefaultViewFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the box chart view is the default view.",
            "nullable":true
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier for the business group for which the talent review meeting template will be used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ViewColumnCount":{
            "maxLength":30,
            "type":"string",
            "description":"Number of columns used in the box chart view.",
            "nullable":true
        },
        "AnalyticTypeId":{
            "type":"integer",
            "description":"Unique identifier for the box chart view.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AnalyticViewMode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the box chart view is an XY view or a single rating view.",
            "nullable":false
        },
        "boxLabels":{
            "title":"Box Labels",
            "type":"array",
            "description":"The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.",
            "items":{
                "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxLabels-item-post-request"
            }
        }
    }
}

Nested Schema : Box Labels

Type: array

Title: Box Labels

The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.

Show Source

• Array of: object schema

{
    "title":"Box Labels",
    "type":"array",
    "description":"The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.",
    "items":{
        "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxLabels-item-post-request"
    }
}

Nested Schema : Box Ratings

Type: array

Title: Box Ratings

The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.

Show Source

• Array of: object talentReviewMeetingTemplates-analyticTypes-boxRatings-item-post-request

{
    "title":"Box Ratings",
    "type":"array",
    "description":"The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.",
    "items":{
        "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxRatings-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AnalyticBoxLabelId: integer (int64)
  Unique identifier for the box label.
• BoxcellBackgroundColor: string
  Maximum Length: 2000

  Background color for the box of the box chart.
• BoxLabel: string
  Maximum Length: 400

  Label for the box of the box chart.
• BoxSequence: integer (int64)
  Sequence for the box of the box chart.
• BusinessGroupId: integer (int64)
  Unique identifier for the business group for which the box cell labels will be used.
• DisplaySequence: integer
  Display sequence for the box cell label.

{
    "type":"object",
    "properties":{
        "BoxSequence":{
            "type":"integer",
            "description":"Sequence for the box of the box chart.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BoxcellBackgroundColor":{
            "maxLength":2000,
            "type":"string",
            "description":"Background color for the box of the box chart.",
            "nullable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence for the box cell label.",
            "nullable":true,
            "x-queryable":false
        },
        "AnalyticBoxLabelId":{
            "type":"integer",
            "description":"Unique identifier for the box label.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier for the business group for which the box cell labels will be used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BoxLabel":{
            "maxLength":400,
            "type":"string",
            "description":"Label for the box of the box chart.",
            "nullable":true
        }
    }
}

Nested Schema : talentReviewMeetingTemplates-analyticTypes-boxRatings-item-post-request

Type: object

Show Source

• BoxRatingMappingId: integer (int64)
  Unique identifier for the box rating mapping.
• BusinessGroupId: integer (int64)
  Unique identifier for the business group for which the box rating applies.
• MetricRatingModelId: integer (int64)
  Unique identifier for the rating model used for the rating included in the talent review meeting template.
• RatingLevelId: integer (int64)
  Unique identifier for the rating level.

{
    "type":"object",
    "properties":{
        "RatingLevelId":{
            "type":"integer",
            "description":"Unique identifier for the rating level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier for the business group for which the box rating applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BoxRatingMappingId":{
            "type":"integer",
            "description":"Unique identifier for the box rating mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MetricRatingModelId":{
            "type":"integer",
            "description":"Unique identifier for the rating model used for the rating included in the talent review meeting template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : talentReviewMeetingTemplates-analyticTypes-item-response

Type: object

Show Source

• AnalyticTypeId: integer (int64)
  Unique identifier for the box chart view.
• AnalyticViewMode: string
  Maximum Length: 30

  Indicates if the box chart view is an XY view or a single rating view.
• AnalyticViewName: string
  Maximum Length: 240

  Name of the box chart view created in the talent review meeting template.
• boxLabels: array Box Labels
  Title: Box Labels

  The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.
• boxRatings: array Box Ratings
  Title: Box Ratings

  The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.
• BusinessGroupId: integer (int64)
  Unique identifier for the business group for which the talent review meeting template will be used.
• ColorSchemeCode: string
  Title: Color Scheme

  Maximum Length: 30

  Code that identifies the color scheme used for the box chart view.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the rating.
• CreationDate: string (date-time)
  Read Only: true

  Date the rating was created.
• DefaultViewFlag: boolean
  Maximum Length: 30

  Indicates if the box chart view is the default view.
• HorizontalAxisCode: string
  Maximum Length: 30

  Code for the rating used on the X-Axis of the box chart or for the single rating view.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the rating was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the rating.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricCode: string
  Maximum Length: 30

  Code for the rating used in the talent review meeting template.
• SubmitBoxAsgnmntFlag: boolean
  Maximum Length: 30

  Indicates if the box assignment is submitted.
• VerticalAxisCode: string
  Title: Vertical Axis Value

  Maximum Length: 30

  Code for the rating used on the Y-Axis of the box chart.
• ViewColumnCount: string
  Maximum Length: 30

  Number of columns used in the box chart view.
• ViewRowCount: string
  Maximum Length: 30

  Number of rows used in the box chart view.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the rating.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the rating was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the rating.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "boxRatings":{
            "title":"Box Ratings",
            "type":"array",
            "description":"The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.",
            "items":{
                "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxRatings-item-response"
            }
        },
        "VerticalAxisCode":{
            "title":"Vertical Axis Value",
            "maxLength":30,
            "type":"string",
            "description":"Code for the rating used on the Y-Axis of the box chart.",
            "nullable":true,
            "x-queryable":true
        },
        "AnalyticViewName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the box chart view created in the talent review meeting template.",
            "nullable":false,
            "x-queryable":true
        },
        "SubmitBoxAsgnmntFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the box assignment is submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "HorizontalAxisCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the rating used on the X-Axis of the box chart or for the single rating view.",
            "nullable":true,
            "x-queryable":true
        },
        "ColorSchemeCode":{
            "title":"Color Scheme",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the color scheme used for the box chart view.",
            "nullable":true,
            "x-queryable":true
        },
        "ViewRowCount":{
            "maxLength":30,
            "type":"string",
            "description":"Number of rows used in the box chart view.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the rating used in the talent review meeting template.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultViewFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the box chart view is the default view.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier for the business group for which the talent review meeting template will be used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ViewColumnCount":{
            "maxLength":30,
            "type":"string",
            "description":"Number of columns used in the box chart view.",
            "nullable":true,
            "x-queryable":true
        },
        "AnalyticTypeId":{
            "type":"integer",
            "description":"Unique identifier for the box chart view.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AnalyticViewMode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the box chart view is an XY view or a single rating view.",
            "nullable":false,
            "x-queryable":true
        },
        "boxLabels":{
            "title":"Box Labels",
            "type":"array",
            "description":"The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.",
            "items":{
                "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the rating was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Box Labels

Type: array

Title: Box Labels

The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.

Show Source

• Array of: object talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response

{
    "title":"Box Labels",
    "type":"array",
    "description":"The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.",
    "items":{
        "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response"
    }
}

Nested Schema : Box Ratings

Type: array

Title: Box Ratings

The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.

Show Source

• Array of: object talentReviewMeetingTemplates-analyticTypes-boxRatings-item-response

{
    "title":"Box Ratings",
    "type":"array",
    "description":"The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.",
    "items":{
        "$ref":"#/components/schemas/talentReviewMeetingTemplates-analyticTypes-boxRatings-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response

Type: object

Show Source

• AnalyticBoxLabelId: integer (int64)
  Unique identifier for the box label.
• BoxcellBackgroundColor: string
  Maximum Length: 2000

  Background color for the box of the box chart.
• BoxLabel: string
  Maximum Length: 400

  Label for the box of the box chart.
• BoxSequence: integer (int64)
  Sequence for the box of the box chart.
• BusinessGroupId: integer (int64)
  Unique identifier for the business group for which the box cell labels will be used.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the box cell label.
• CreationDate: string (date-time)
  Read Only: true

  Date the box cell label was created.
• DisplaySequence: integer
  Display sequence for the box cell label.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the box cell label was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the box cell label.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the box cell label.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the box cell label was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BoxSequence":{
            "type":"integer",
            "description":"Sequence for the box of the box chart.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BoxcellBackgroundColor":{
            "maxLength":2000,
            "type":"string",
            "description":"Background color for the box of the box chart.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the box cell label.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence for the box cell label.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AnalyticBoxLabelId":{
            "type":"integer",
            "description":"Unique identifier for the box label.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier for the business group for which the box cell labels will be used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BoxLabel":{
            "maxLength":400,
            "type":"string",
            "description":"Label for the box of the box chart.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the box cell label was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : talentReviewMeetingTemplates-analyticTypes-boxRatings-item-response

Type: object

Show Source

• BoxRatingMappingId: integer (int64)
  Unique identifier for the box rating mapping.
• BusinessGroupId: integer (int64)
  Unique identifier for the business group for which the box rating applies.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the box rating.
• CreationDate: string (date-time)
  Read Only: true

  Date the box rating was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the box rating was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the box rating.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricRatingModelId: integer (int64)
  Unique identifier for the rating model used for the rating included in the talent review meeting template.
• RatingLevelId: integer (int64)
  Unique identifier for the rating level.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the box rating.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the box rating was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the box rating.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricRatingModelId":{
            "type":"integer",
            "description":"Unique identifier for the rating model used for the rating included in the talent review meeting template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RatingLevelId":{
            "type":"integer",
            "description":"Unique identifier for the rating level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier for the business group for which the box rating applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BoxRatingMappingId":{
            "type":"integer",
            "description":"Unique identifier for the box rating mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the box rating was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

boxLabels

Operation: /hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels

Parameters:

• analyticTypesUniqID: $request.path.analyticTypesUniqID
• talentReviewMeetingTemplatesUniqID: $request.path.talentReviewMeetingTemplatesUniqID

The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.

boxRatings

Operation: /hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxRatings

Parameters:

• analyticTypesUniqID: $request.path.analyticTypesUniqID
• talentReviewMeetingTemplatesUniqID: $request.path.talentReviewMeetingTemplatesUniqID

The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.

Back to Top