Jump to

• Request
• Response

Create a custom talent rating section for a profile

post

/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections

Request

Path Parameters

• talentRatingsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Talent Ratings resource and used to uniquely identify an instance of Talent Ratings. The client should not generate the hash key value. Instead, the client should query on the Talent Ratings collection resource in order to navigate to a specific instance of Talent Ratings 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ProfileSectionId: integer (int64)
  Title: Profile Section ID

  Unique identifier of the user-defined talent rating section associated with the person profile.
• SectionContext: string
  Title: Section Context

  Maximum Length: 300

  Code representing the user-defined talent rating section. Valid values are defined in the profileTypeSectionsLOV.
• SectionId(required): integer (int64)
  Title: Section ID

  Unique identifier of the user-defined talent rating section.
• userDefinedRatings: array User Defined Ratings
  Title: User Defined Ratings

  The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.

{
    "required":[
        "SectionId"
    ],
    "type":"object",
    "properties":{
        "SectionContext":{
            "title":"Section Context",
            "maxLength":"300",
            "type":"string",
            "description":"Code representing the user-defined talent rating section. Valid values are defined in the profileTypeSectionsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "userDefinedRatings":{
            "title":"User Defined Ratings",
            "type":"array",
            "description":"The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.",
            "items":{
                "$ref":"#/components/schemas/talentRatings-userDefinedRatingSections-userDefinedRatings-item-post-request"
            }
        },
        "SectionId":{
            "title":"Section ID",
            "type":"integer",
            "description":"Unique identifier of the user-defined talent rating section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "ProfileSectionId":{
            "title":"Profile Section ID",
            "type":"integer",
            "description":"Unique identifier of the user-defined talent rating section associated with the person profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        }
    }
}

Nested Schema : User Defined Ratings

Type: array

Title: User Defined Ratings

The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.

Show Source

• Array of: object schema

{
    "title":"User Defined Ratings",
    "type":"array",
    "description":"The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.",
    "items":{
        "$ref":"#/components/schemas/talentRatings-userDefinedRatingSections-userDefinedRatings-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string (byte)
  Title: Comments

  Description of the user-defined talent rating item.
• RatingId: integer (int64)
  Title: Rating ID

  Unique identifier of the user-defined talent rating item.
• RatingLevelCode: string
  Title: Rating Level Code

  Maximum Length: 30

  Code representing rating level associated with the user-defined talent rating item.
• RatingLevelId: integer (int64)
  Title: Rating Level ID

  Unique identifier of the rating level associated with the user-defined talent rating item.
• Source: string
  Title: Source

  Maximum Length: 30

  Indicates whether the source of the performance rating item is profile, talent review, or talent review meeting. Valid values are CUSTOMPROFILE, CUSTOMTR, or CUSTOMTRMP.
• SourceType: string
  Maximum Length: 30

  Code associated with source type of the user-defined talent rating item.

{
    "type":"object",
    "properties":{
        "RatingId":{
            "title":"Rating ID",
            "type":"integer",
            "description":"Unique identifier of the user-defined talent rating item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "Description":{
            "title":"Comments",
            "type":"string",
            "description":"Description of the user-defined talent rating item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RatingLevelCode":{
            "title":"Rating Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code representing rating level associated with the user-defined talent rating item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Code associated with source type of the user-defined talent rating item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RatingLevelId":{
            "title":"Rating Level ID",
            "type":"integer",
            "description":"Unique identifier of the rating level associated with the user-defined talent rating item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "Source":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the source of the performance rating item is profile, talent review, or talent review meeting. Valid values are CUSTOMPROFILE, CUSTOMTR, or CUSTOMTRMP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : talentRatings-userDefinedRatingSections-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the user-defined talent rating section.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user-defined talent rating section was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user-defined talent rating section was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the user-defined talent rating section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProfileSectionId: integer (int64)
  Title: Profile Section ID

  Unique identifier of the user-defined talent rating section associated with the person profile.
• RatingModelCode: string
  Title: Rating Model Code

  Read Only: true

  Maximum Length: 30

  Code representing rating model associated with the user-defined talent rating section.
• RatingModelId: integer (int64)
  Title: Rating Model ID

  Read Only: true

  Unique identifier of the rating model associated with the user-defined talent rating section.
• RatingModelName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the rating model associated with the user-defined talent rating section.
• SectionContext: string
  Title: Section Context

  Maximum Length: 300

  Code representing the user-defined talent rating section. Valid values are defined in the profileTypeSectionsLOV.
• SectionId: integer (int64)
  Title: Section ID

  Unique identifier of the user-defined talent rating section.
• SectionName: string
  Title: Section Name

  Read Only: true

  Maximum Length: 240

  Name of the user-defined talent rating section.
• userDefinedRatings: array User Defined Ratings
  Title: User Defined Ratings

  The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the user-defined talent rating section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SectionContext":{
            "title":"Section Context",
            "maxLength":"300",
            "type":"string",
            "description":"Code representing the user-defined talent rating section. Valid values are defined in the profileTypeSectionsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user-defined talent rating section was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RatingModelName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the rating model associated with the user-defined talent rating section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the user-defined talent rating section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RatingModelId":{
            "title":"Rating Model ID",
            "type":"integer",
            "description":"Unique identifier of the rating model associated with the user-defined talent rating section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RatingModelCode":{
            "title":"Rating Model Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code representing rating model associated with the user-defined talent rating section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileSectionId":{
            "title":"Profile Section ID",
            "type":"integer",
            "description":"Unique identifier of the user-defined talent rating section associated with the person profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "userDefinedRatings":{
            "title":"User Defined Ratings",
            "type":"array",
            "description":"The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.",
            "items":{
                "$ref":"#/components/schemas/talentRatings-userDefinedRatingSections-userDefinedRatings-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SectionName":{
            "title":"Section Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the user-defined talent rating section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionId":{
            "title":"Section ID",
            "type":"integer",
            "description":"Unique identifier of the user-defined talent rating section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user-defined talent rating section was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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 : User Defined Ratings

Type: array

Title: User Defined Ratings

The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.

Show Source

• Array of: object talentRatings-userDefinedRatingSections-userDefinedRatings-item-response

{
    "title":"User Defined Ratings",
    "type":"array",
    "description":"The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.",
    "items":{
        "$ref":"#/components/schemas/talentRatings-userDefinedRatingSections-userDefinedRatings-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 : talentRatings-userDefinedRatingSections-userDefinedRatings-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the user-defined talent rating item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user-defined talent rating item was created.
• Description: string (byte)
  Title: Comments

  Description of the user-defined talent rating item.
• FromDate: string (date)
  Title: From Date

  Read Only: true

  Date and time when the user-defined talent rating item becomes valid.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user-defined talent rating item was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the user-defined talent rating item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 2000

  Name of the user-defined talent rating item.
• NumericRating: number
  Title: Numeric Rating

  Read Only: true

  Numeric value of the rating level associated with the user-defined talent rating item.
• RatingId: integer (int64)
  Title: Rating ID

  Unique identifier of the user-defined talent rating item.
• RatingLevel: string
  Title: Name

  Read Only: true

  Maximum Length: 2000

  Name of the rating level associated with the custom talent rating item.
• RatingLevelCode: string
  Title: Rating Level Code

  Maximum Length: 30

  Code representing rating level associated with the user-defined talent rating item.
• RatingLevelId: integer (int64)
  Title: Rating Level ID

  Unique identifier of the rating level associated with the user-defined talent rating item.
• RatingModelId: integer (int64)
  Title: Talent Rating Model

  Read Only: true

  Unique identifier of the rating model associated with the user-defined talent rating item.
• Source: string
  Title: Source

  Maximum Length: 30

  Indicates whether the source of the performance rating item is profile, talent review, or talent review meeting. Valid values are CUSTOMPROFILE, CUSTOMTR, or CUSTOMTRMP.
• SourceDescription: string
  Title: Source

  Read Only: true

  Maximum Length: 4000

  Source of the user-defined talent rating item.
• SourceKey: integer (int64)
  Read Only: true

  Unique identifier of the source where the custom talent rating item is used.
• SourceType: string
  Maximum Length: 30

  Code associated with source type of the user-defined talent rating item.
• SubmittedBy: string
  Read Only: true

  Maximum Length: 255

  User who submitted the user-defined talent rating item.
• ToDate: string (date)
  Title: End Date

  Read Only: true

  Date and time until which the user-defined talent rating item is valid.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the user-defined talent rating item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user-defined talent rating item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the user-defined talent rating item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Description":{
            "title":"Comments",
            "type":"string",
            "description":"Description of the user-defined talent rating item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NumericRating":{
            "title":"Numeric Rating",
            "type":"number",
            "description":"Numeric value of the rating level associated with the user-defined talent rating item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "RatingModelId":{
            "title":"Talent Rating Model",
            "type":"integer",
            "description":"Unique identifier of the rating model associated with the user-defined talent rating item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "RatingLevel":{
            "title":"Name",
            "maxLength":"2000",
            "type":"string",
            "description":"Name of the rating level associated with the custom talent rating item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RatingLevelCode":{
            "title":"Rating Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code representing rating level associated with the user-defined talent rating item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Code associated with source type of the user-defined talent rating item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RatingLevelId":{
            "title":"Rating Level ID",
            "type":"integer",
            "description":"Unique identifier of the rating level associated with the user-defined talent rating item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":"255",
            "type":"string",
            "description":"User who submitted the user-defined talent rating item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Source":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the source of the performance rating item is profile, talent review, or talent review meeting. Valid values are CUSTOMPROFILE, CUSTOMTR, or CUSTOMTRMP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"2000",
            "type":"string",
            "description":"Name of the user-defined talent rating item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceKey":{
            "type":"integer",
            "description":"Unique identifier of the source where the custom talent rating item is used.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RatingId":{
            "title":"Rating ID",
            "type":"integer",
            "description":"Unique identifier of the user-defined talent rating item.",
            "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"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date and time when the user-defined talent rating item becomes valid.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ToDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date and time until which the user-defined talent rating item is valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceDescription":{
            "title":"Source",
            "maxLength":"4000",
            "type":"string",
            "description":"Source of the user-defined talent rating item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user-defined talent rating item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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

sectionContextLOV

Operation: /hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: SectionContext; Target Attribute: SectionContext
• Display Attribute: SectionContext, SectionId

userDefinedRatings

Operation: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings

Parameters:

• ProfileSectionId: $request.path.ProfileSectionId
• talentRatingsUniqID: $request.path.talentRatingsUniqID

The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.

Back to Top