Jump to

• Request
• Response

Update a deduction group

patch

/hcmRestApi/resources/11.13.18.05/payrollComponentsAndComponentGroups/{DeductionTypeId}/child/DeductionGroupRest/{DeductionGroupId}

Request

Path Parameters

• DeductionGroupId(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=
• DeductionTypeId(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: string
  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: string
  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

• LegislationCode: string
  Title: Country

  Maximum Length: 30

  Code that identifies the legislation of the deduction group.
• ModuleId: string
  Maximum Length: 32

  Unique identifier of the module of the deduction group.
• Name: string
  Title: Component Group

  Maximum Length: 240

  Name of the deduction group.
• ObjectVersionNumber: integer (int32)
  Version number of the deduction group record.
• SeedStatus: string
  Maximum Length: 1

  Status of the predefined deduction group.

{
    "type":"object",
    "properties":{
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the legislation of the deduction group.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the module of the deduction group.",
            "nullable":true
        },
        "Name":{
            "title":"Component Group",
            "maxLength":240,
            "type":"string",
            "description":"Name of the deduction group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"C"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the deduction group record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SeedStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the predefined deduction group.",
            "nullable":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 : payrollComponentsAndComponentGroups-DeductionGroupRest-item-response

Type: object

Show Source

• BaseDeductionGroupId: integer (int64)
  Unique identifier of the base deduction group.
• BaseName: string
  Title: Name

  Maximum Length: 240

  Name of the base deduction group.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the deduction group.
• CreationDate: string (date-time)
  Read Only: true

  The date when the deduction group was created.
• DeductionGroupId: integer (int64)
  Unique identifier of the deduction group.
• DeductionGroupIdForFk: integer (int64)
  Read Only: true

  Unique identifier of the deduction group foreign key.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the deduction group was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the deduction group.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign in used for the last update.
• LegislationCode: string
  Title: Country

  Maximum Length: 30

  Code that identifies the legislation of the deduction group.
• LegislativeDataGroupId: integer
  Read Only: true

  Unique identifier of the legislative data group of the deduction group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  Unique identifier of the module of the deduction group.
• Name: string
  Title: Component Group

  Maximum Length: 240

  Name of the deduction group.
• ObjectVersionNumber: integer (int32)
  Version number of the deduction group record.
• SeedStatus: string
  Maximum Length: 1

  Status of the predefined deduction group.

{
    "type":"object",
    "properties":{
        "BaseDeductionGroupId":{
            "type":"integer",
            "description":"Unique identifier of the base deduction group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the base deduction group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"S"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the deduction group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the deduction group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Unique identifier of the deduction group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeductionGroupIdForFk":{
            "type":"integer",
            "description":"Unique identifier of the deduction group foreign key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the deduction group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Sign in used for the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the deduction group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the legislation of the deduction group.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group of the deduction group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the module of the deduction group.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Component Group",
            "maxLength":240,
            "type":"string",
            "description":"Name of the deduction group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"C"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the deduction group record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SeedStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the predefined deduction group.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top