Jump to

• Request
• Response

Update delegation rule not supported

patch

/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/{PersonId}

Request

Path Parameters

• PersonId(required): string
  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:
  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

• Action: string
  Maximum Length: 255

  Action such as create or update that need to be performed on a specific delegation rule.
• DelegateTo: string
  Maximum Length: 255

  Identifier of the person who's being delegated.
• DelegateToDisplayName: string
  Maximum Length: 255

  Display name of the user being delegated.
• EndDate: string
  Maximum Length: 255

  End date of the delegation rule.
• Field: string
  Maximum Length: 255

  Attribute that determines if the delegation rule is based on a category or a task.
• FieldOperation: string
  Maximum Length: 255

  Type of operation to be performed to retrieve valid transactions based on the delegation rule.
• FieldValue: string
  Maximum Length: 255

  Name of the category or task associated with the delegation rule.
• IsSelfApprovalEnabled: string
  Maximum Length: 255

  Indicates if self-approval is enabled for a delegation rule. Default is No.
• PersonId: string
  Maximum Length: 255

  Identifier of the person.
• RuleId: string
  Maximum Length: 255

  Unique identifier for the delegation rule.
• RuleName: string
  Maximum Length: 255

  Name for the delegation rule.
• StartDate: string
  Maximum Length: 255

  Start date of the delegation rule.

{
    "type":"object",
    "properties":{
        "IsSelfApprovalEnabled":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if self-approval is enabled for a delegation rule. Default is No.",
            "nullable":true
        },
        "Action":{
            "maxLength":"255",
            "type":"string",
            "description":"Action such as create or update that need to be performed on a specific delegation rule.",
            "nullable":true
        },
        "DelegateToDisplayName":{
            "maxLength":"255",
            "type":"string",
            "description":"Display name of the user being delegated.",
            "nullable":true
        },
        "DelegateTo":{
            "maxLength":"255",
            "type":"string",
            "description":"Identifier of the person who's being delegated.",
            "nullable":true
        },
        "RuleId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the delegation rule.",
            "nullable":true
        },
        "EndDate":{
            "maxLength":"255",
            "type":"string",
            "description":"End date of the delegation rule.",
            "nullable":true
        },
        "StartDate":{
            "maxLength":"255",
            "type":"string",
            "description":"Start date of the delegation rule.",
            "nullable":true
        },
        "Field":{
            "maxLength":"255",
            "type":"string",
            "description":"Attribute that determines if the delegation rule is based on a category or a task.",
            "nullable":true
        },
        "PersonId":{
            "maxLength":"255",
            "type":"string",
            "description":"Identifier of the person.",
            "nullable":true
        },
        "FieldValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the category or task associated with the delegation rule.",
            "nullable":true
        },
        "FieldOperation":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of operation to be performed to retrieve valid transactions based on the delegation rule.",
            "nullable":true
        },
        "RuleName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name for the delegation rule.",
            "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 : businessProcessApprovalDelegationRules-item-response

Type: object

Show Source

• Action: string
  Maximum Length: 255

  Action such as create or update that need to be performed on a specific delegation rule.
• DelegateTo: string
  Maximum Length: 255

  Identifier of the person who's being delegated.
• DelegateToDisplayName: string
  Maximum Length: 255

  Display name of the user being delegated.
• EndDate: string
  Maximum Length: 255

  End date of the delegation rule.
• Field: string
  Maximum Length: 255

  Attribute that determines if the delegation rule is based on a category or a task.
• FieldOperation: string
  Maximum Length: 255

  Type of operation to be performed to retrieve valid transactions based on the delegation rule.
• FieldValue: string
  Maximum Length: 255

  Name of the category or task associated with the delegation rule.
• IsSelfApprovalEnabled: string
  Maximum Length: 255

  Indicates if self-approval is enabled for a delegation rule. Default is No.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: string
  Maximum Length: 255

  Identifier of the person.
• RuleId: string
  Maximum Length: 255

  Unique identifier for the delegation rule.
• RuleName: string
  Maximum Length: 255

  Name for the delegation rule.
• StartDate: string
  Maximum Length: 255

  Start date of the delegation rule.

{
    "type":"object",
    "properties":{
        "IsSelfApprovalEnabled":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if self-approval is enabled for a delegation rule. Default is No.",
            "nullable":true,
            "x-queryable":true
        },
        "Action":{
            "maxLength":"255",
            "type":"string",
            "description":"Action such as create or update that need to be performed on a specific delegation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegateToDisplayName":{
            "maxLength":"255",
            "type":"string",
            "description":"Display name of the user being delegated.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegateTo":{
            "maxLength":"255",
            "type":"string",
            "description":"Identifier of the person who's being delegated.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the delegation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "maxLength":"255",
            "type":"string",
            "description":"End date of the delegation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "maxLength":"255",
            "type":"string",
            "description":"Start date of the delegation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "Field":{
            "maxLength":"255",
            "type":"string",
            "description":"Attribute that determines if the delegation rule is based on a category or a task.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "maxLength":"255",
            "type":"string",
            "description":"Identifier of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the category or task associated with the delegation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldOperation":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of operation to be performed to retrieve valid transactions based on the delegation rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name for the delegation rule.",
            "nullable":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."
        }
    }
}

Back to Top