Jump to

• Request
• Response

Update a document delivery preference

patch

/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2/{documentDeliveryPreferencesV2UniqID}

Request

Path Parameters

• documentDeliveryPreferencesV2UniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Document Delivery Preferences resource and used to uniquely identify an instance of Document Delivery Preferences. The client should not generate the hash key value. Instead, the client should query on the Document Delivery Preferences collection resource in order to navigate to a specific instance of Document Delivery Preferences to get the hash key.

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• OnlineConsentValueFlag: boolean
  Title: Online Delivery Consent

  Maximum Length: 30

  Indicates whether online consent is granted for document delivery preference. Valid values are Yes and No. The default value is Yes.
• OnlineEnabledFlag: boolean
  Title: Online

  Maximum Length: 30

  Indicates whether online delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.
• PaperEnabledFlag: boolean
  Title: Paper

  Maximum Length: 30

  Indicates whether paper based delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.

{
    "type":"object",
    "properties":{
        "OnlineConsentValueFlag":{
            "title":"Online Delivery Consent",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether online consent is granted for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PaperEnabledFlag":{
            "title":"Paper",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether paper based delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OnlineEnabledFlag":{
            "title":"Online",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether online delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "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 : documentDeliveryPreferencesV2-item-response

Type: object

Show Source

• AllowWorkerOverrideFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether worker override is allowed for document delivery preference. Valid values are Yes and No. The default value is Yes.
• AssignmentId: integer
  Read Only: true

  Internal identifier of the assignment of the person for whom document delivery preference is fetched.
• AssignmentNumber: string
  Read Only: true

  Maximum Length: 255

  Assignment number of the person for whom document delivery preference is fetched.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the document delivery preference.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the document delivery preference was created.
• DocumentDeliveryPreferenceId: integer (int64)
  Read Only: true

  Identifier of the document delivery preference.
• DocumentType: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80

  Type of the document.
• DocumentTypeCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 30

  Name of the country for the document type.
• DocumentTypeId: integer (int64)
  Title: Document Type

  Identifier of the document type.
• EditAllowedFlag: boolean
  Read Only: true

  Indicates whether document delivery preference is editable.
• HierarchyCode: string
  Title: Override Hierarchy

  Read Only: true

  Maximum Length: 30

  Code of the hierarchy for a document delivery preference.
• InitialConsentValueFlag: boolean
  Title: Initial Consent Granted

  Read Only: true

  Maximum Length: 30

  Indicates whether initial online consent is granted for document delivery preference. Valid values are Yes and No. The default value is Yes.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the document delivery preference was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the document delivery preference.
• LegislationCode: string
  Title: Country

  Read Only: true

  Maximum Length: 30

  Code of the country for the document type.
• LevelCode: string
  Title: Level

  Read Only: true

  Maximum Length: 40

  Default Value: 900_PERSON

  Code of the level for a document delivery preference.
• LevelId: integer (int64)
  Title: Name

  Read Only: true

  Identifier of the level for a document delivery preference.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OnlineConsentRequiredFlag: boolean
  Title: Online Delivery Consent Required

  Read Only: true

  Maximum Length: 30

  Indicates whether online consent is required for document delivery preference. Valid values are Yes and No. The default value is No.
• OnlineConsentValueFlag: boolean
  Title: Online Delivery Consent

  Maximum Length: 30

  Indicates whether online consent is granted for document delivery preference. Valid values are Yes and No. The default value is Yes.
• OnlineEnabledFlag: boolean
  Title: Online

  Maximum Length: 30

  Indicates whether online delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.
• PaperEnabledFlag: boolean
  Title: Paper

  Maximum Length: 30

  Indicates whether paper based delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.
• PersonId: integer (int64)
  Title: Person ID

  A unique reference to person identifier for this document delivery preference.
• PersonNumber: string
  Title: Person Number

  Maximum Length: 30

  The person number of the worker this document delivery preference is for.
• SystemDocumentType: string
  Title: System Document Type

  Maximum Length: 120

  System-generated identifier to uniquely identify the document type.

{
    "type":"object",
    "properties":{
        "HierarchyCode":{
            "title":"Override Hierarchy",
            "maxLength":30,
            "type":"string",
            "description":"Code of the hierarchy for a document delivery preference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the document delivery preference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LevelCode":{
            "title":"Level",
            "maxLength":40,
            "type":"string",
            "description":"Code of the level for a document delivery preference.",
            "nullable":true,
            "readOnly":true,
            "default":"900_PERSON",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Code of the country for the document type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OnlineConsentRequiredFlag":{
            "title":"Online Delivery Consent Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether online consent is required for document delivery preference. Valid values are Yes and No. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DocumentDeliveryPreferenceId":{
            "type":"integer",
            "description":"Identifier of the document delivery preference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Internal identifier of the assignment of the person for whom document delivery preference is fetched.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PersonId"
                ]
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Assignment number of the person for whom document delivery preference is fetched.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PersonId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowWorkerOverrideFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether worker override is allowed for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the document delivery preference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The person number of the worker this document delivery preference is for.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the document delivery preference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InitialConsentValueFlag":{
            "title":"Initial Consent Granted",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether initial online consent is granted for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DocumentType":{
            "title":"Document Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of the document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SystemDocumentType":{
            "title":"System Document Type",
            "maxLength":120,
            "type":"string",
            "description":"System-generated identifier to uniquely identify the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PersonId"
                ]
            },
            "x-queryable":true
        },
        "OnlineConsentValueFlag":{
            "title":"Online Delivery Consent",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether online consent is granted for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DocumentTypeCountry":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Name of the country for the document type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"Identifier of the document type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "OnlineEnabledFlag":{
            "title":"Online",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether online delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"A unique reference to person identifier for this document delivery preference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "EditAllowedFlag":{
            "type":"boolean",
            "description":"Indicates whether document delivery preference is editable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DocumentTypeId",
                    "PersonId"
                ]
            }
        },
        "LevelId":{
            "title":"Name",
            "type":"integer",
            "description":"Identifier of the level for a document delivery preference.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "PaperEnabledFlag":{
            "title":"Paper",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether paper based delivery is enabled for document delivery preference. Valid values are Yes and No. The default value is Yes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the document delivery preference was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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