Create a performance cycle group
post
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups
Request
Path Parameters
-
PerfCycleId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
ObjectType(required): string
Maximum Length:
30
Object type associated with the performance cycle group. -
PerfCycleGroupId(required): integer
(int64)
Unique identifier for the performance cycle group.
-
perfCycleGroupObjects: array
Performance Cycle Group Objects
Title:
Performance Cycle Group Objects
The perfCycleGroupObjects resource is a child of the perfCycleGroups resource and provides all the objects associated with the performance cycle group. The objects can be individual goal plans of a group or individual check-ins of a group. -
perfCycleGroupPhases: array
Performance Cycle Group Phases
Title:
Performance Cycle Group Phases
The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group. -
PerfCycleId(required): integer
(int64)
Unique identifier for the performance cycle to which the performance cycle group belongs.
Nested Schema : Performance Cycle Group Objects
Type:
array
Title:
Performance Cycle Group Objects
The perfCycleGroupObjects resource is a child of the perfCycleGroups resource and provides all the objects associated with the performance cycle group. The objects can be individual goal plans of a group or individual check-ins of a group.
Show Source
Nested Schema : Performance Cycle Group Phases
Type:
array
Title:
Performance Cycle Group Phases
The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group.
Show Source
Nested Schema : perfCycles-perfCycleGroups-perfCycleGroupObjects-item-post-request
Type:
Show Source
object
-
BusinessGroupId: integer
(int64)
Unique identifier for the business group associated with the performance cycle group object.
-
ObjectId: integer
(int64)
Unique identifier for the performance cycle group object.
-
PerfCycleGroupId: integer
(int64)
Unique identifier for the performance cycle group to which the performance cycle group object belongs.
-
PerfCycleObjectId: integer
(int64)
Unique identifier for the individual object that's part of the performance cycle group object. The identifier can be a goal plan ID or a check-in ID.
Nested Schema : perfCycles-perfCycleGroups-perfCycleGroupPhases-item-post-request
Type:
Show Source
object
-
BusinessGroupId: integer
(int64)
Unique identifier for the business group associated with the performance cycle group phase.
-
PerfCycleGroupId: integer
(int64)
Unique identifier for the performance cycle group to which the performance cycle group phase belongs.
-
PerfCyclePhaseId: integer
(int64)
Unique identifier for the performance cycle phase to which the performance cycle group phase belongs.
-
PhaseCode: string
Maximum Length:
30
Code that identifies the performance cycle group phase. -
PhaseEndDate: string
(date)
End date of the performance cycle group phase.
-
PhaseStartDate: string
(date)
Start date of the performance cycle group phase.
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 : perfCycles-perfCycleGroups-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date the performance cycle group was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the performance cycle group was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectType: string
Maximum Length:
30
Object type associated with the performance cycle group. -
PerfCycleGroupId: integer
(int64)
Unique identifier for the performance cycle group.
-
perfCycleGroupObjects: array
Performance Cycle Group Objects
Title:
Performance Cycle Group Objects
The perfCycleGroupObjects resource is a child of the perfCycleGroups resource and provides all the objects associated with the performance cycle group. The objects can be individual goal plans of a group or individual check-ins of a group. -
perfCycleGroupPhases: array
Performance Cycle Group Phases
Title:
Performance Cycle Group Phases
The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group. -
PerfCycleId: integer
(int64)
Unique identifier for the performance cycle to which the performance cycle group belongs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Performance Cycle Group Objects
Type:
array
Title:
Performance Cycle Group Objects
The perfCycleGroupObjects resource is a child of the perfCycleGroups resource and provides all the objects associated with the performance cycle group. The objects can be individual goal plans of a group or individual check-ins of a group.
Show Source
Nested Schema : Performance Cycle Group Phases
Type:
array
Title:
Performance Cycle Group Phases
The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group.
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 : perfCycles-perfCycleGroups-perfCycleGroupObjects-item-response
Type:
Show Source
object
-
BusinessGroupId: integer
(int64)
Unique identifier for the business group associated with the performance cycle group object.
-
CreationDate: string
(date-time)
Read Only:
true
Date the performance cycle group object was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the performance cycle group object was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Unique identifier for the performance cycle group object.
-
PerfCycleGroupId: integer
(int64)
Unique identifier for the performance cycle group to which the performance cycle group object belongs.
-
PerfCycleObjectId: integer
(int64)
Unique identifier for the individual object that's part of the performance cycle group object. The identifier can be a goal plan ID or a check-in ID.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : perfCycles-perfCycleGroups-perfCycleGroupPhases-item-response
Type:
Show Source
object
-
BusinessGroupId: integer
(int64)
Unique identifier for the business group associated with the performance cycle group phase.
-
CreationDate: string
(date-time)
Read Only:
true
Date the performance cycle group phase was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the performance cycle group phase was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerfCycleGroupId: integer
(int64)
Unique identifier for the performance cycle group to which the performance cycle group phase belongs.
-
PerfCyclePhaseId: integer
(int64)
Unique identifier for the performance cycle phase to which the performance cycle group phase belongs.
-
PhaseCode: string
Maximum Length:
30
Code that identifies the performance cycle group phase. -
PhaseEndDate: string
(date)
End date of the performance cycle group phase.
-
PhaseStartDate: string
(date)
Start date of the performance cycle group phase.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- perfCycleGroupObjects
-
Parameters:
- PerfCycleGroupId:
$request.path.PerfCycleGroupId
- PerfCycleId:
$request.path.PerfCycleId
The perfCycleGroupObjects resource is a child of the perfCycleGroups resource and provides all the objects associated with the performance cycle group. The objects can be individual goal plans of a group or individual check-ins of a group. - PerfCycleGroupId:
- perfCycleGroupPhases
-
Parameters:
- PerfCycleGroupId:
$request.path.PerfCycleGroupId
- PerfCycleId:
$request.path.PerfCycleId
The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group. - PerfCycleGroupId: