Jump to

• Request
• Response

Update an impact of loss rating item

patch

/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}

Request

Path Parameters

• ImpactOfLossId(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=
• 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

• Comments: string (byte)
  Title: Comments

  Comments on the impact of loss rating item.
• EstimatedRemainingMonths: string
  Title: Estimated Remaining Months

  Maximum Length: 30

  Code representing the estimated months left for the employees to depart the organization. A list of accepted values is defined in the lookup type HRT_EST_DEPARTURE_DATE.
• ExpectedReasonForDeparture: string
  Title: Expected Reason for Departure

  Maximum Length: 30

  Code representing the expected reason for the departure of the employee. A list of accepted values is defined in the lookup type HRT_DEPARTURE_REASON.
• ImpactLevelCode: string
  Title: Impact Level Code

  Maximum Length: 30

  Code representing the rating level associated with the impact of loss rating item. Valid values are defined in the ratingLevelsLOV.
• ImpactLevelId: integer (int64)
  Title: Impact Level ID

  Unique identifier of the rating level associated with the impact of loss rating item.
• SourceType: string
  Maximum Length: 30

  Code representing the source of impact of loss rating item.

{
    "type":"object",
    "properties":{
        "ExpectedReasonForDeparture":{
            "title":"Expected Reason for Departure",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the expected reason for the departure of the employee. A list of accepted values is defined in the lookup type HRT_DEPARTURE_REASON.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ImpactLevelCode":{
            "title":"Impact Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the rating level associated with the impact of loss rating item. Valid values are defined in the ratingLevelsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on the impact of loss rating item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing the source of impact of loss rating item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ImpactLevelId":{
            "title":"Impact Level ID",
            "type":"integer",
            "description":"Unique identifier of the rating level associated with the impact of loss rating item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "EstimatedRemainingMonths":{
            "title":"Estimated Remaining Months",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the estimated months left for the employees to depart the organization. A list of accepted values is defined in the lookup type HRT_EST_DEPARTURE_DATE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        }
    }
}

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-impactOfLosses-item-response

Type: object

Show Source

• Comments: string (byte)
  Title: Comments

  Comments on the impact of loss rating item.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the impact of loss rating item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the impact of loss rating item was created.
• EstimatedRemainingMonths: string
  Title: Estimated Remaining Months

  Maximum Length: 30

  Code representing the estimated months left for the employees to depart the organization. A list of accepted values is defined in the lookup type HRT_EST_DEPARTURE_DATE.
• EstimatedRemainingMonthsMeaning: string
  Title: Estimated Remaining Months

  Read Only: true

  Maximum Length: 80

  Estimated months left for the employees to depart the organization. A list of accepted values is defined in the lookup type HRT_EST_DEPARTURE_DATE.
• ExpectedReasonForDeparture: string
  Title: Expected Reason for Departure

  Maximum Length: 30

  Code representing the expected reason for the departure of the employee. A list of accepted values is defined in the lookup type HRT_DEPARTURE_REASON.
• ExpectedReasonForDepartureMeaning: string
  Title: Expected Reason for Departure

  Read Only: true

  Maximum Length: 80

  Expected reason for the departure of the employee. A list of accepted values is defined in the lookup type HRT_DEPARTURE_REASON.
• FromDate: string (date)
  Title: From Date

  Read Only: true

  Date and time when the impact of loss rating item becomes valid.
• ImpactLevel: string
  Title: Name

  Read Only: true

  Maximum Length: 2000

  Name of the rating level associated with the impact of loss rating item.
• ImpactLevelCode: string
  Title: Impact Level Code

  Maximum Length: 30

  Code representing the rating level associated with the impact of loss rating item. Valid values are defined in the ratingLevelsLOV.
• ImpactLevelId: integer (int64)
  Title: Impact Level ID

  Unique identifier of the rating level associated with the impact of loss rating item.
• ImpactModelId: integer (int64)
  Title: Impact Rating Model

  Read Only: true

  Default Value: 13

  Unique identifier of the rating model associated with the impact of loss rating item.
• ImpactOfLossId: integer (int64)
  Title: Impact of Loss ID

  Read Only: true

  Unique identifier of the impact of loss rating item.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the impact of loss rating item was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the impact of loss rating item.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Indicates whether the source of the impact of loss rating item is profile, succession management, talent review meeting, or talent review. Valid values are PROFILERISK, SUCCESSIONRISK, TRMPRISK, and TRRISK.
• SourceDescription: string
  Title: Source

  Read Only: true

  Maximum Length: 4000

  Date and time until which the impact of loss rating item is valid.
• SourceKey: integer (int64)
  Unique identifier of the source where the impact of loss rating item is used.
• SourceType: string
  Maximum Length: 30

  Code representing the source of impact of loss rating item.
• SubmittedBy: string
  Read Only: true

  Maximum Length: 255

  User who submitted the impact of loss rating item.
• ToDate: string (date)
  Title: End Date

  Read Only: true

  Date and time until which the impact of loss rating item is valid.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the impact of loss rating item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the impact of loss rating item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ImpactModelId":{
            "title":"Impact Rating Model",
            "type":"integer",
            "description":"Unique identifier of the rating model associated with the impact of loss rating item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":13,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the impact of loss rating item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ExpectedReasonForDeparture":{
            "title":"Expected Reason for Departure",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the expected reason for the departure of the employee. A list of accepted values is defined in the lookup type HRT_DEPARTURE_REASON.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ImpactLevel":{
            "title":"Name",
            "maxLength":2000,
            "type":"string",
            "description":"Name of the rating level associated with the impact of loss rating item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImpactLevelCode":{
            "title":"Impact Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the rating level associated with the impact of loss rating item. Valid values are defined in the ratingLevelsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on the impact of loss rating item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Code representing the source of impact of loss rating item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who submitted the impact of loss rating item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedRemainingMonths":{
            "title":"Estimated Remaining Months",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the estimated months left for the employees to depart the organization. A list of accepted values is defined in the lookup type HRT_EST_DEPARTURE_DATE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Source":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the source of the impact of loss rating item is profile, succession management, talent review meeting, or talent review. Valid values are PROFILERISK, SUCCESSIONRISK, TRMPRISK, and TRRISK.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EstimatedRemainingMonthsMeaning":{
            "title":"Estimated Remaining Months",
            "maxLength":80,
            "type":"string",
            "description":"Estimated months left for the employees to depart the organization. A list of accepted values is defined in the lookup type HRT_EST_DEPARTURE_DATE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceKey":{
            "type":"integer",
            "description":"Unique identifier of the source where the impact of loss rating item is used.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ExpectedReasonForDepartureMeaning":{
            "title":"Expected Reason for Departure",
            "maxLength":80,
            "type":"string",
            "description":"Expected reason for the departure of the employee. A list of accepted values is defined in the lookup type HRT_DEPARTURE_REASON.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImpactOfLossId":{
            "title":"Impact of Loss ID",
            "type":"integer",
            "description":"Unique identifier of the impact of loss rating item.",
            "format":"int64",
            "nullable":false,
            "readOnly":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"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date and time when the impact of loss 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 impact of loss rating item is valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ImpactLevelId":{
            "title":"Impact Level ID",
            "type":"integer",
            "description":"Unique identifier of the rating level associated with the impact of loss rating item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDescription":{
            "title":"Source",
            "maxLength":4000,
            "type":"string",
            "description":"Date and time until which the impact of loss rating item is valid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the impact of loss rating item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":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 : 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."
        }
    }
}

Links

estimatedRemainingMonthsLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHRT_EST_DEPARTURE_DATE

The following properties are defined on the LOV link relation:

• Source Attribute: EstimatedRemainingMonths; Target Attribute: LookupCode
• Display Attribute: Meaning

expectedReasonForDepartureLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHRT_DEPARTURE_REASON

The following properties are defined on the LOV link relation:

• Source Attribute: ExpectedReasonForDeparture; Target Attribute: LookupCode
• Display Attribute: Meaning

impactLevelsLOV

Operation: /hcmRestApi/resources/11.13.18.05/ratingLevelsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ImpactLevelCode; Target Attribute: RatingLevelCode
• Display Attribute: RatingLevelCode, RatingLevelId

Back to Top