Create a box label
post
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels
Request
Path Parameters
-
analyticTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AnalyticTypeId and BusinessGroupId ---for the Analytic Types resource and used to uniquely identify an instance of Analytic Types. The client should not generate the hash key value. Instead, the client should query on the Analytic Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Analytic Types.
For example: analyticTypes?q=AnalyticTypeId=<value1>;BusinessGroupId=<value2> -
talentReviewMeetingTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- DashboardTemplateId and BusinessGroupId ---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 with a filter on the primary key values in order to navigate to a specific instance of Talent Review Meeting Templates.
For example: talentReviewMeetingTemplates?q=DashboardTemplateId=<value1>;BusinessGroupId=<value2>
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
Root Schema : schema
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.
-
DisplaySequence: integer
Display sequence for the box cell label.
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.
Root 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.