Jump to

• Request
• Response

Update a payroll connect payload rule tree structure

patch

/hcmRestApi/resources/11.13.18.05/payrollConnectPayloadRuleTreeStructs/{ObjectId}

Request

Path Parameters

• ObjectId(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

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• BaseName: string
  Read Only: true

  Maximum Length: 80

  Base name for the payroll connect payload rule tree structure.
• BatchFlg: string
  Read Only: true

  Maximum Length: 20

  Batch flag for the payroll connect payload rule tree structure.
• CriteriaDbiName: string
  Read Only: true

  Maximum Length: 4000

  Criteria DBI name for the payroll connect payload rule tree structure.
• CriteriaSelType: string
  Read Only: true

  Maximum Length: 4000

  Criteria selection type for the payroll connect payload rule tree structure.
• CriteriaSelValue: string
  Read Only: true

  Maximum Length: 4000

  Criteria selection value for the payroll connect payload rule tree structure.
• CriteriaValueset: string
  Read Only: true

  Maximum Length: 4000

  Set of values for criteria for the payroll connect payload rule tree structure.
• DataType: string
  Read Only: true

  Maximum Length: 80

  Data type for the payroll connect payload rule tree structure.
• DisplayFlg: string
  Read Only: true

  Maximum Length: 4000

  Display flag for the payroll connect payload rule tree structure.
• HideFlg: string
  Read Only: true

  Maximum Length: 30

  Hide flag for the payroll connect payload rule tree structure.
• KeyFlg: string
  Read Only: true

  Maximum Length: 4000

  Key flag for the payroll connect payload rule tree structure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlg: string
  Read Only: true

  Maximum Length: 20

  Mandatory flag for the payroll connect payload rule tree structure.
• Name: string
  Read Only: true

  Maximum Length: 255

  Name for the payroll connect payload rule tree structure.
• ObjectId: integer (int64)
  Read Only: true

  Object identifier for the payroll connect payload rule tree structure.
• ObjectType: string
  Read Only: true

  Maximum Length: 255

  Object type for the payroll connect payload rule tree structure.
• ParentObjectId: integer (int64)
  Read Only: true

  Parent object identifier for the payroll connect payload rule tree structure.
• ParentObjectType: string
  Read Only: true

  Maximum Length: 10

  Parent object type for the payroll connect payload rule tree structure.
• RequiredFlg: string
  Read Only: true

  Maximum Length: 4000

  Required flag for the payroll connect payload rule tree structure.
• TypeCode: string
  Read Only: true

  Maximum Length: 30

  Type code for the payroll connect payload rule tree structure.

{
    "type":"object",
    "properties":{
        "BaseName":{
            "maxLength":80,
            "type":"string",
            "description":"Base name for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchFlg":{
            "maxLength":20,
            "type":"string",
            "description":"Batch flag for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaDbiName":{
            "maxLength":4000,
            "type":"string",
            "description":"Criteria DBI name for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaSelType":{
            "maxLength":4000,
            "type":"string",
            "description":"Criteria selection type for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaSelValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Criteria selection value for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaValueset":{
            "maxLength":4000,
            "type":"string",
            "description":"Set of values for criteria for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "maxLength":80,
            "type":"string",
            "description":"Data type for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayFlg":{
            "maxLength":4000,
            "type":"string",
            "description":"Display flag for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HideFlg":{
            "maxLength":30,
            "type":"string",
            "description":"Hide flag for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyFlg":{
            "maxLength":4000,
            "type":"string",
            "description":"Key flag for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MandatoryFlg":{
            "maxLength":20,
            "type":"string",
            "description":"Mandatory flag for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":255,
            "type":"string",
            "description":"Name for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object identifier for the payroll connect payload rule tree structure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":255,
            "type":"string",
            "description":"Object type for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"Parent object identifier for the payroll connect payload rule tree structure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":10,
            "type":"string",
            "description":"Parent object type for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlg":{
            "maxLength":4000,
            "type":"string",
            "description":"Required flag for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type code for the payroll connect payload rule tree structure.",
            "nullable":true,
            "readOnly":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