Get all document delivery preferences
get
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Unique identifier for the document delivery preference.
Finder Variables- DocumentDeliveryPreferenceId; integer; Filter attribute to retrieve document delivery preferences based on document delivery preference identifier.
- findByPerson Finds all the document delivery preferences for a person.
Finder Variables- PersonId; integer; Filter attribute to retrieve document delivery preferences based on person identifier.
- PersonNumber; string; Filter attribute to retrieve document delivery preferences based on person number.
- SysEffectiveDate; object;
- PrimaryKey Unique identifier for the document delivery preference.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AssignmentId; integer; Internal identifier of the assignment of the person for whom document delivery preference is fetched.
- AssignmentNumber; string; Assignment number of the person for whom document delivery preference is fetched.
- DocumentDeliveryPreferenceId; integer; Identifier of the document delivery preference.
- DocumentTypeId; integer; Identifier of the document type.
- PersonId; integer; A unique reference to person identifier for this document delivery preference.
- PersonNumber; string; The person number of the worker this document delivery preference is for.
- SystemDocumentType; string; System-generated identifier to uniquely identify the document type.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.