Create all document delivery preferences
post
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DocumentTypeId: integer
(int64)
Title:
Document Type
Identifier of the document type. -
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.
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.
Root Schema : documentDeliveryPreferencesV2-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.