Get all analytic options
get
/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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds an analytic option that matches the primary key criteria specified.
Finder Variables- AnalyticTypeId; integer; Unique identifier for the analytic option.
- BusinessGroupId; integer; Unique identifier for the business group for which the analytic option applies.
- PrimaryKey Finds an analytic option that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AnalyticTypeId; integer; Unique identifier for the box chart view.
- AnalyticViewMode; string; Indicates if the box chart view is an XY view or a single rating view.
- AnalyticViewName; string; Name of the box chart view created in the talent review meeting template.
- BusinessGroupId; integer; Unique identifier for the business group for which the talent review meeting template will be used.
- ColorSchemeCode; string; Code that identifies the color scheme used for the box chart view.
- CreatedBy; string; User who created the rating.
- CreationDate; string; Date the rating was created.
- DefaultViewFlag; boolean; Indicates if the box chart view is the default view.
- HorizontalAxisCode; string; Code for the rating used on the X-Axis of the box chart or for the single rating view.
- LastUpdateDate; string; Date the rating was last updated.
- LastUpdatedBy; string; User who last updated the rating.
- MetricCode; string; Code for the rating used in the talent review meeting template.
- SubmitBoxAsgnmntFlag; boolean; Indicates if the box assignment is submitted.
- VerticalAxisCode; string; Code for the rating used on the Y-Axis of the box chart.
- ViewColumnCount; string; Number of columns used in the box chart view.
- ViewRowCount; string; Number of rows used in the box chart view.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : talentReviewMeetingTemplates-analyticTypes
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentReviewMeetingTemplates-analyticTypes-item-response
Type:
Show Source
object
-
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.
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
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : talentReviewMeetingTemplates-analyticTypes-boxRatings-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source