Create all document types
post
/hcmRestApi/resources/11.13.18.05/hrDocumentTypes
Request
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.
-
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
-
ActiveInactiveFlag: boolean
Title:
Active
Maximum Length:30
Default Value:true
Indicates whether the document type is active. The default value is Yes. -
ArchiveCriteriaBasis: string
Title:
Archive Criteria Basis
Maximum Length:30
Criteria for archiving document records based on the document type. -
ArchiveCriteriaDays: integer
(int32)
Title:
Archive After Days
Number of days after which document records are archived based on the document type. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
AuthorizationRequiredFlag: boolean
Title:
Approval Required
Maximum Length:1
Default Value:false
Indicates whether approval is required for the document type. The default value is No. -
BiReportPath: string
Title:
Report Path
Maximum Length:2000
URL or path where the report is available. -
CategoryCode(required): string
Title:
Category
Maximum Length:30
Category of the document type. -
CommentsLabel: string
Title:
New Label for Issuing Comments
Maximum Length:200
Label for the field that the user defines for the issuing comments. -
CommentsRequired: string
Title:
Issuing Comments Applicable
Maximum Length:30
Default Value:Y
Indicates whether comments are relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
DateFromLabel: string
Title:
New Label for From Date
Maximum Length:200
Label for the field that the user defines for the from date. -
DateFromRequired: string
Title:
From Date Applicable
Maximum Length:30
Default Value:Y
Indicates whether date from is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
DateToLabel: string
Title:
New Label for To Date
Maximum Length:200
Label for the field that the user defines for the to date. -
DateToRequired: string
Title:
To Date Applicable
Maximum Length:30
Default Value:Y
Indicates whether date to is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
Description: string
Title:
Description
Maximum Length:4000
Description for the document type. -
DffCtxSegDefaultValue: string
Title:
Default Value for Context Segment
Maximum Length:120
Default value for the document records flexfield context segment. -
DffCtxSegDisplayPreference: string
Title:
Display Preference for Context Segment
Maximum Length:30
Display preference for the document records flexfield context segment. -
DffGlbSegDisplayPreference: string
Title:
Display Preference for Global Segment
Maximum Length:30
Display preference for the document records flexfield global segment. -
DocumentNameLabel: string
Title:
New Label for Name
Maximum Length:200
Label for the field that the user defines for the document name. -
DocumentNameRequired: string
Title:
Document Name Applicable
Maximum Length:30
Default Value:Y
Indicates whether document name is relevant (Y) or required (R) or not relevant (N). The default setting is relevant (Y). -
DocumentNumberLabel: string
Title:
New Label for Number
Maximum Length:200
Label for the field that the user defines for the document number. -
DocumentNumberRequired: string
Title:
Document Number Applicable
Maximum Length:30
Default Value:Y
Indicates whether document number is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
DocumentType(required): string
Title:
Type
Maximum Length:80
Unique name to identify the document type. -
DocumentTypeId: integer
(int64)
Title:
Type
Surrogate ID for the document type which is available only when updating existing records. -
DocumentTypeLevel: string
Title:
Document Type Level
Maximum Length:30
Default Value:ORA_P
Indicates whether the document type applies to a person or an individual assignment. The default value is Person. -
documentTypesDDF: array
documentTypesDDF
-
documentTypesDFF: array
documentTypesDFF
-
HierarchyCode: string
Title:
Override Hierarchy
Maximum Length:30
Hierarchy code to support delivery preferences on this document type. -
IssuedDateLabel: string
Title:
New Label for Issued Date
Maximum Length:200
Label for the field that the user defines for the issued date. -
IssuedDateRequired: string
Title:
Issued on Applicable
Maximum Length:30
Default Value:Y
Indicates whether issued date is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
IssuingAuthorityLabel: string
Title:
New Label for Issuing Authority
Maximum Length:200
Label for the field that the user defines for the issuing authority. -
IssuingAuthorityRequired: string
Title:
Issuing Authority Applicable
Maximum Length:30
Default Value:Y
Indicates whether issuing authority is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
IssuingCountryLabel: string
Title:
New Label for Issuing Country
Maximum Length:200
Label for the field that the user defines for the issuing country. -
IssuingCountryRequired: string
Title:
Issuing Country Applicable
Maximum Length:30
Default Value:Y
Indicates whether issuing country is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
IssuingLocationLabel: string
Title:
New Label for Issuing Location
Maximum Length:200
Label for the field that the user defines for the issuing location. -
IssuingLocationRequired: string
Title:
Issuing Location Applicable
Maximum Length:30
Default Value:Y
Indicates whether issuing location is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
LegislationCode: string
Title:
Country
Maximum Length:30
Legislation code if this is a legislation specific document type. -
LockCreateFlag: boolean
Title:
Restrict Create
Maximum Length:30
Default Value:false
Indicates whether it restricts or allows creating document records of this document type. The default value is No -
LockCreateRoleList: string
Title:
Roles Excluded from Restriction
Maximum Length:4000
List of roles that can create document records based on the document type. -
LockDeleteFlag: boolean
Title:
Restrict Delete
Maximum Length:30
Default Value:false
Indicates whether it restricts or allows deleting document records of this document type. The default value is No. -
LockDeleteRoleList: string
Title:
Roles Excluded from Restriction
Maximum Length:4000
List of roles allowed to delete document records based on the document type. -
LockUpdateFlag: boolean
Title:
Restrict Update
Maximum Length:30
Default Value:false
Indicates whether it restricts or allows updating document records of this document type. The default value is No. -
LockUpdateRoleList: string
Title:
Roles Excluded from Restriction
Maximum Length:4000
List of roles allowed to update document records based on the document type. -
MinimumAttachmentsCount: integer
(int32)
Title:
Minimum Attachments
Default Value:0
Minimum number of attachments that a user must attach for a specific document type. -
MultipleOccurencesFlag: boolean
Title:
Allow multiple occurrences
Maximum Length:30
Default Value:true
Indicates whether multiple occurrences of this document type are allowed. The default value is Yes. -
PublishRequiredFlag: boolean
Title:
Publish Required
Maximum Length:30
Default Value:false
Indicates whether document records of this document type must be published. The default value is No. -
PurgeArchiveCriteriaDays: integer
(int32)
Title:
Purge After Days
Number of days after which archived document records will be purged. -
SubCategoryCode: string
Title:
Subcategory
Maximum Length:30
Code of the subcategory for the document type. -
SystemDocumentType: string
Title:
System Document Type
Maximum Length:120
System-generated name that uniquely identifies the document type. -
TagList: string
Title:
Tags
Maximum Length:2000
Lookup code of the tag used for the document type derived from the lookup ORA_PER_DOC_TYPE_TAGS. -
translations: array
Translations for Document Types
Title:
Translations for Document Types
The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type. -
WarningPeriod: integer
(int64)
Title:
Expiration Notification Period
Number of days in advance to generate an alert when a document record based on this document type is about to expire.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Translations for Document Types
Type:
array
Title:
Translations for Document Types
The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : Attachment Previews
Type:
array
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : hrDocumentTypes-attachments-AttachmentsPreview-item-post-request
Type:
Show Source
object
Nested Schema : hrDocumentTypes-documentTypesDDF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
DocumentTypeId: integer
(int64)
Title:
Type
Nested Schema : hrDocumentTypes-documentTypesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
DocumentTypeId: integer
(int64)
Title:
Type
Nested Schema : hrDocumentTypes-translations-item-post-request
Type:
Show Source
object
-
CommentsLabel: string
Title:
New Label for Issuing Comments
Maximum Length:200
Translated label for the field that the user defines for the issuing comments. -
DateFromLabel: string
Title:
New Label for From Date
Maximum Length:200
Translated label for the field that the user defines for the from date. -
DateToLabel: string
Title:
New Label for To Date
Maximum Length:200
Translated label for the field that the user defines for the to date. -
Description: string
Maximum Length:
4000
Translated description for the document type. -
DocumentNameLabel: string
Title:
New Label for Name
Maximum Length:200
Translated label for the field that the user defines for the document name. -
DocumentNumberLabel: string
Title:
New Label for Number
Maximum Length:200
Translated label for the field that the user defines for the document number. -
DocumentType: string
Maximum Length:
80
Translated name to uniquely identify the document type. -
DocumentTypeId: integer
(int64)
Surrogate ID for the translated document type which is available only when updating existing records.
-
IssuedDateLabel: string
Title:
New Label for Issued Date
Maximum Length:200
Translated label for the field that the user defines for the issued date. -
IssuingAuthorityLabel: string
Title:
New Label for Issuing Authority
Maximum Length:200
Translated label for the field that the user defines for the issuing authority. -
IssuingCountryLabel: string
Title:
New Label for Issuing Country
Maximum Length:200
Translated label for the field that the user defines for the issuing country. -
IssuingLocationLabel: string
Title:
New Label for Issuing Location
Maximum Length:200
Translated label for the field that the user defines for the issuing location. -
Language: string
Maximum Length:
4
Translated language of the document type. -
SourceLang: string
Maximum Length:
4
Source language of the document type.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : hrDocumentTypes-item-response
Type:
Show Source
object
-
ActiveInactiveFlag: boolean
Title:
Active
Maximum Length:30
Default Value:true
Indicates whether the document type is active. The default value is Yes. -
ArchiveCriteriaBasis: string
Title:
Archive Criteria Basis
Maximum Length:30
Criteria for archiving document records based on the document type. -
ArchiveCriteriaDays: integer
(int32)
Title:
Archive After Days
Number of days after which document records are archived based on the document type. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
AuthorizationRequiredFlag: boolean
Title:
Approval Required
Maximum Length:1
Default Value:false
Indicates whether approval is required for the document type. The default value is No. -
BiReportPath: string
Title:
Report Path
Maximum Length:2000
URL or path where the report is available. -
CategoryCode: string
Title:
Category
Maximum Length:30
Category of the document type. -
CommentsLabel: string
Title:
New Label for Issuing Comments
Maximum Length:200
Label for the field that the user defines for the issuing comments. -
CommentsRequired: string
Title:
Issuing Comments Applicable
Maximum Length:30
Default Value:Y
Indicates whether comments are relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the document type. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the document type was created. -
DateFromLabel: string
Title:
New Label for From Date
Maximum Length:200
Label for the field that the user defines for the from date. -
DateFromRequired: string
Title:
From Date Applicable
Maximum Length:30
Default Value:Y
Indicates whether date from is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
DateToLabel: string
Title:
New Label for To Date
Maximum Length:200
Label for the field that the user defines for the to date. -
DateToRequired: string
Title:
To Date Applicable
Maximum Length:30
Default Value:Y
Indicates whether date to is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
Description: string
Title:
Description
Maximum Length:4000
Description for the document type. -
DffCtxSegDefaultValue: string
Title:
Default Value for Context Segment
Maximum Length:120
Default value for the document records flexfield context segment. -
DffCtxSegDisplayPreference: string
Title:
Display Preference for Context Segment
Maximum Length:30
Display preference for the document records flexfield context segment. -
DffGlbSegDisplayPreference: string
Title:
Display Preference for Global Segment
Maximum Length:30
Display preference for the document records flexfield global segment. -
DocumentNameLabel: string
Title:
New Label for Name
Maximum Length:200
Label for the field that the user defines for the document name. -
DocumentNameRequired: string
Title:
Document Name Applicable
Maximum Length:30
Default Value:Y
Indicates whether document name is relevant (Y) or required (R) or not relevant (N). The default setting is relevant (Y). -
DocumentNumberLabel: string
Title:
New Label for Number
Maximum Length:200
Label for the field that the user defines for the document number. -
DocumentNumberRequired: string
Title:
Document Number Applicable
Maximum Length:30
Default Value:Y
Indicates whether document number is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
DocumentType: string
Title:
Type
Maximum Length:80
Unique name to identify the document type. -
DocumentTypeId: integer
(int64)
Title:
Type
Surrogate ID for the document type which is available only when updating existing records. -
DocumentTypeLevel: string
Title:
Document Type Level
Maximum Length:30
Default Value:ORA_P
Indicates whether the document type applies to a person or an individual assignment. The default value is Person. -
documentTypesDDF: array
documentTypesDDF
-
documentTypesDFF: array
documentTypesDFF
-
HierarchyCode: string
Title:
Override Hierarchy
Maximum Length:30
Hierarchy code to support delivery preferences on this document type. -
IssuedDateLabel: string
Title:
New Label for Issued Date
Maximum Length:200
Label for the field that the user defines for the issued date. -
IssuedDateRequired: string
Title:
Issued on Applicable
Maximum Length:30
Default Value:Y
Indicates whether issued date is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
IssuingAuthorityLabel: string
Title:
New Label for Issuing Authority
Maximum Length:200
Label for the field that the user defines for the issuing authority. -
IssuingAuthorityRequired: string
Title:
Issuing Authority Applicable
Maximum Length:30
Default Value:Y
Indicates whether issuing authority is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
IssuingCountryLabel: string
Title:
New Label for Issuing Country
Maximum Length:200
Label for the field that the user defines for the issuing country. -
IssuingCountryRequired: string
Title:
Issuing Country Applicable
Maximum Length:30
Default Value:Y
Indicates whether issuing country is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
IssuingLocationLabel: string
Title:
New Label for Issuing Location
Maximum Length:200
Label for the field that the user defines for the issuing location. -
IssuingLocationRequired: string
Title:
Issuing Location Applicable
Maximum Length:30
Default Value:Y
Indicates whether issuing location is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y). -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the document type was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the document type. -
LegislationCode: string
Title:
Country
Maximum Length:30
Legislation code if this is a legislation specific document type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockCreateFlag: boolean
Title:
Restrict Create
Maximum Length:30
Default Value:false
Indicates whether it restricts or allows creating document records of this document type. The default value is No -
LockCreateRoleList: string
Title:
Roles Excluded from Restriction
Maximum Length:4000
List of roles that can create document records based on the document type. -
LockDeleteFlag: boolean
Title:
Restrict Delete
Maximum Length:30
Default Value:false
Indicates whether it restricts or allows deleting document records of this document type. The default value is No. -
LockDeleteRoleList: string
Title:
Roles Excluded from Restriction
Maximum Length:4000
List of roles allowed to delete document records based on the document type. -
LockUpdateFlag: boolean
Title:
Restrict Update
Maximum Length:30
Default Value:false
Indicates whether it restricts or allows updating document records of this document type. The default value is No. -
LockUpdateRoleList: string
Title:
Roles Excluded from Restriction
Maximum Length:4000
List of roles allowed to update document records based on the document type. -
MinimumAttachmentsCount: integer
(int32)
Title:
Minimum Attachments
Default Value:0
Minimum number of attachments that a user must attach for a specific document type. -
MultipleOccurencesFlag: boolean
Title:
Allow multiple occurrences
Maximum Length:30
Default Value:true
Indicates whether multiple occurrences of this document type are allowed. The default value is Yes. -
PublishRequiredFlag: boolean
Title:
Publish Required
Maximum Length:30
Default Value:false
Indicates whether document records of this document type must be published. The default value is No. -
PurgeArchiveCriteriaDays: integer
(int32)
Title:
Purge After Days
Number of days after which archived document records will be purged. -
SubCategoryCode: string
Title:
Subcategory
Maximum Length:30
Code of the subcategory for the document type. -
SystemDocumentType: string
Title:
System Document Type
Maximum Length:120
System-generated name that uniquely identifies the document type. -
TagList: string
Title:
Tags
Maximum Length:2000
Lookup code of the tag used for the document type derived from the lookup ORA_PER_DOC_TYPE_TAGS. -
translations: array
Translations for Document Types
Title:
Translations for Document Types
The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type. -
WarningPeriod: integer
(int64)
Title:
Expiration Notification Period
Number of days in advance to generate an alert when a document record based on this document type is about to expire.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Translations for Document Types
Type:
array
Title:
Translations for Document Types
The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type.
Show Source
Nested Schema : hrDocumentTypes-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Attachment Previews
Type:
array
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hrDocumentTypes-attachments-AttachmentsPreview-item-response
Type:
Show Source
object
-
ImageHeight: integer
Title:
Image Height
Read Only:true
The height of the previewed image. -
ImageSource: string
Title:
Image Source
Read Only:true
The preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image Width
Read Only:true
The width of the previewed image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageNum: integer
Title:
Page Number
Read Only:true
The number of the page in the preview.
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.
Nested Schema : hrDocumentTypes-documentTypesDDF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
DocumentTypeId: integer
(int64)
Title:
Type
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hrDocumentTypes-documentTypesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
DocumentTypeId: integer
(int64)
Title:
Type
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hrDocumentTypes-translations-item-response
Type:
Show Source
object
-
CommentsLabel: string
Title:
New Label for Issuing Comments
Maximum Length:200
Translated label for the field that the user defines for the issuing comments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the translated document type. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the translated document type was created. -
DateFromLabel: string
Title:
New Label for From Date
Maximum Length:200
Translated label for the field that the user defines for the from date. -
DateToLabel: string
Title:
New Label for To Date
Maximum Length:200
Translated label for the field that the user defines for the to date. -
Description: string
Maximum Length:
4000
Translated description for the document type. -
DocumentNameLabel: string
Title:
New Label for Name
Maximum Length:200
Translated label for the field that the user defines for the document name. -
DocumentNumberLabel: string
Title:
New Label for Number
Maximum Length:200
Translated label for the field that the user defines for the document number. -
DocumentType: string
Maximum Length:
80
Translated name to uniquely identify the document type. -
DocumentTypeId: integer
(int64)
Surrogate ID for the translated document type which is available only when updating existing records.
-
IssuedDateLabel: string
Title:
New Label for Issued Date
Maximum Length:200
Translated label for the field that the user defines for the issued date. -
IssuingAuthorityLabel: string
Title:
New Label for Issuing Authority
Maximum Length:200
Translated label for the field that the user defines for the issuing authority. -
IssuingCountryLabel: string
Title:
New Label for Issuing Country
Maximum Length:200
Translated label for the field that the user defines for the issuing country. -
IssuingLocationLabel: string
Title:
New Label for Issuing Location
Maximum Length:200
Translated label for the field that the user defines for the issuing location. -
Language: string
Maximum Length:
4
Translated language of the document type. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the translated document type was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the translated document type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceLang: string
Maximum Length:
4
Source language of the document type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ArchiveCriteriaLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_DOC_ARCHIVE_BASIS
The following properties are defined on the LOV link relation:- Source Attribute: ArchiveCriteriaBasis; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CategoryLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DDOCUMENT_CATEGORY
The following properties are defined on the LOV link relation:- Source Attribute: CategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CountryLOVVA
-
Parameters:
- finder:
findByWord
The following properties are defined on the LOV link relation:- Source Attribute: LegislationCode; Target Attribute: TerritoryCode
- Display Attribute: CountryName
- finder:
- DescriptiveFlexfieldContextLOVVA
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_DOCUMENTS_OF_RECORD_DFF
The following properties are defined on the LOV link relation:- Source Attribute: DffCtxSegDefaultValue; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
- DocumentTypeLevelLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_DOCUMENT_TYPE_LEVEL
The following properties are defined on the LOV link relation:- Source Attribute: DocumentTypeLevel; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- HierarchyCodeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DDOCUMENT_HIERARCHY
The following properties are defined on the LOV link relation:- Source Attribute: HierarchyCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SegmentDisplayLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_DOR_DFF_SEG_DISPLAY
The following properties are defined on the LOV link relation:- Source Attribute: DffGlbSegDisplayPreference; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SubcategoryCodeLovVA
-
Parameters:
- finder:
findByWord%3BLookupCode%3D{CategoryCode}%2CLookupType%3DDOCUMENT_CATEGORY
The following properties are defined on the LOV link relation:- Source Attribute: SubCategoryCode; Target Attribute: ExtendedLookupCode
- Display Attribute: ExtendedLookupName
- finder:
- TagsLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_DOC_TYPE_TAGS
The following properties are defined on the LOV link relation:- Source Attribute: TagList; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: PublishRequiredFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoRequiredLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO_REQUIRED
The following properties are defined on the LOV link relation:- Source Attribute: IssuingCountryRequired; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- attachments
-
Parameters:
- DocumentTypeId:
$request.path.DocumentTypeId
The attachments resource is used to view, create, and update attachments. - DocumentTypeId:
- documentTypesDDF
-
Operation: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDDFParameters:
- DocumentTypeId:
$request.path.DocumentTypeId
(Resource of documentTypesDDF) - DocumentTypeId:
- documentTypesDFF
-
Operation: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDFFParameters:
- DocumentTypeId:
$request.path.DocumentTypeId
(Resource of documentTypesDFF) - DocumentTypeId:
- translations
-
Parameters:
- DocumentTypeId:
$request.path.DocumentTypeId
The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type. - DocumentTypeId: