Jump to

• Request
• Response

Get a performance cycle

get

/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}

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=

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 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 : perfCycles-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

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

  Date the performance cycle was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• perfCycleGroups: array Performance Cycle Groups
  Title: Performance Cycle Groups

  The perfCycleGroups resource is a child of the perfCycles resource and provides all the groups associated with the performance cycle. A group can be a group of goal plans or a group of check-ins.
• PerfCycleId: integer (int64)
  Unique identifier for the performance cycle.
• PerfCycleName: string
  Maximum Length: 400

  Name of the performance cycle.
• ReviewPeriodId: integer (int64)
  Unique identifier for the review period associated with the performance cycle.
• Status: string
  Maximum Length: 30

  Status of the performance cycle.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the performance cycle.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the performance cycle was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReviewPeriodId":{
            "type":"integer",
            "description":"Unique identifier for the review period associated with the performance cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PerfCycleName":{
            "maxLength":"400",
            "type":"string",
            "description":"Name of the performance cycle.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PerfCycleId":{
            "type":"integer",
            "description":"Unique identifier for the performance cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "perfCycleGroups":{
            "title":"Performance Cycle Groups",
            "type":"array",
            "description":"The perfCycleGroups resource is a child of the perfCycles resource and provides all the groups associated with the performance cycle. A group can be a group of goal plans or a group of check-ins.",
            "items":{
                "$ref":"#/components/schemas/perfCycles-perfCycleGroups-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the performance cycle 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 : Performance Cycle Groups

Type: array

Title: Performance Cycle Groups

The perfCycleGroups resource is a child of the perfCycles resource and provides all the groups associated with the performance cycle. A group can be a group of goal plans or a group of check-ins.

Show Source

• Array of: object perfCycles-perfCycleGroups-item-response

{
    "title":"Performance Cycle Groups",
    "type":"array",
    "description":"The perfCycleGroups resource is a child of the perfCycles resource and provides all the groups associated with the performance cycle. A group can be a group of goal plans or a group of check-ins.",
    "items":{
        "$ref":"#/components/schemas/perfCycles-perfCycleGroups-item-response"
    }
}

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 : perfCycles-perfCycleGroups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date the performance cycle group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"Object type associated with the performance cycle group.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "perfCycleGroupObjects":{
            "title":"Performance Cycle Group Objects",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/perfCycles-perfCycleGroups-perfCycleGroupObjects-item-response"
            }
        },
        "perfCycleGroupPhases":{
            "title":"Performance Cycle Group Phases",
            "type":"array",
            "description":"The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group.",
            "items":{
                "$ref":"#/components/schemas/perfCycles-perfCycleGroups-perfCycleGroupPhases-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PerfCycleGroupId":{
            "type":"integer",
            "description":"Unique identifier for the performance cycle group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerfCycleId":{
            "type":"integer",
            "description":"Unique identifier for the performance cycle to which the performance cycle group belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the performance cycle group 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 : 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

• Array of: object perfCycles-perfCycleGroups-perfCycleGroupObjects-item-response

{
    "title":"Performance Cycle Group Objects",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/perfCycles-perfCycleGroups-perfCycleGroupObjects-item-response"
    }
}

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

• Array of: object perfCycles-perfCycleGroups-perfCycleGroupPhases-item-response

{
    "title":"Performance Cycle Group Phases",
    "type":"array",
    "description":"The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group.",
    "items":{
        "$ref":"#/components/schemas/perfCycles-perfCycleGroups-perfCycleGroupPhases-item-response"
    }
}

Nested Schema : perfCycles-perfCycleGroups-perfCycleGroupObjects-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date the performance cycle group object was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerfCycleObjectId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Unique identifier for the performance cycle group object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "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 associated with the performance cycle group object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerfCycleGroupId":{
            "type":"integer",
            "description":"Unique identifier for the performance cycle group to which the performance cycle group object belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the performance cycle group object 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 : perfCycles-perfCycleGroups-perfCycleGroupPhases-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date the performance cycle group phase was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerfCyclePhaseId":{
            "type":"integer",
            "description":"Unique identifier for the performance cycle phase to which the performance cycle group phase belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhaseEndDate":{
            "type":"string",
            "description":"End date of the performance cycle group phase.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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 associated with the performance cycle group phase.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerfCycleGroupId":{
            "type":"integer",
            "description":"Unique identifier for the performance cycle group to which the performance cycle group phase belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhaseStartDate":{
            "type":"string",
            "description":"Start date of the performance cycle group phase.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PhaseCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the performance cycle group phase.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the performance cycle group phase 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

perfCycleGroups

Operation: /hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups

Parameters:

• PerfCycleId: $request.path.PerfCycleId

The perfCycleGroups resource is a child of the perfCycles resource and provides all the groups associated with the performance cycle. A group can be a group of goal plans or a group of check-ins.

Back to Top