Jump to

• Request
• Response

Get all document types

get

/hcmRestApi/resources/11.13.18.05/hrDocumentTypes

Request

Query Parameters

• 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 Finds all the document types that match the specified primary key criteria.
    Finder Variables
    • DocumentTypeId; integer; Unique identifier of the document type.
  • findByDocumentType Finds all the document types that match the specified criteria.
    Finder Variables
    • DocumentType; string; Filter attribute to retrieve document types based on document type.
    • LegislationCode; string; Filter attribute to retrieve document types based on legislation code.
• 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:
  

  • ActiveInactiveFlag; boolean; Indicates whether the document type is active. The default value is Yes.
  • ArchiveCriteriaBasis; string; Criteria for archiving document records based on the document type.
  • ArchiveCriteriaDays; integer; Number of days after which document records are archived based on the document type.
  • AuthorizationRequiredFlag; boolean; Indicates whether approval is required for the document type. The default value is No.
  • BiReportPath; string; URL or path where the report is available.
  • CategoryCode; string; Category of the document type.
  • CommentsLabel; string; Label for the field that the user defines for the issuing comments.
  • CommentsRequired; string; Indicates whether comments are relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • CreatedBy; string; Name of the user who created the document type.
  • CreationDate; string; Date on which the document type was created.
  • DateFromLabel; string; Label for the field that the user defines for the from date.
  • DateFromRequired; string; Indicates whether date from is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • DateToLabel; string; Label for the field that the user defines for the to date.
  • DateToRequired; string; Indicates whether date to is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Description; string; Description for the document type.
  • DffCtxSegDefaultValue; string; Default value for the document records flexfield context segment.
  • DffCtxSegDisplayPreference; string; Display preference for the document records flexfield context segment.
  • DffGlbSegDisplayPreference; string; Display preference for the document records flexfield global segment.
  • DocumentNameLabel; string; Label for the field that the user defines for the document name.
  • DocumentNameRequired; string; Indicates whether document name is relevant (Y) or required (R) or not relevant (N). The default setting is relevant (Y).
  • DocumentNumberLabel; string; Label for the field that the user defines for the document number.
  • DocumentNumberRequired; string; Indicates whether document number is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • DocumentType; string; Unique name to identify the document type.
  • DocumentTypeId; integer; Surrogate ID for the document type which is available only when updating existing records.
  • DocumentTypeLevel; string; Indicates whether the document type applies to a person or an individual assignment. The default value is Person.
  • HierarchyCode; string; Hierarchy code to support delivery preferences on this document type.
  • IssuedDateLabel; string; Label for the field that the user defines for the issued date.
  • IssuedDateRequired; string; Indicates whether issued date is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • IssuingAuthorityLabel; string; Label for the field that the user defines for the issuing authority.
  • IssuingAuthorityRequired; string; Indicates whether issuing authority is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • IssuingCountryLabel; string; Label for the field that the user defines for the issuing country.
  • IssuingCountryRequired; string; Indicates whether issuing country is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • IssuingLocationLabel; string; Label for the field that the user defines for the issuing location.
  • IssuingLocationRequired; string; Indicates whether issuing location is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • LastUpdateDate; string; Date the document type was last updated.
  • LastUpdatedBy; string; User who last updated the document type.
  • LegislationCode; string; Legislation code if this is a legislation specific document type.
  • LockCreateFlag; boolean; Indicates whether it restricts or allows creating document records of this document type. The default value is No
  • LockCreateRoleList; string; List of roles that can create document records based on the document type.
  • LockDeleteFlag; boolean; Indicates whether it restricts or allows deleting document records of this document type. The default value is No.
  • LockDeleteRoleList; string; List of roles allowed to delete document records based on the document type.
  • LockUpdateFlag; boolean; Indicates whether it restricts or allows updating document records of this document type. The default value is No.
  • LockUpdateRoleList; string; List of roles allowed to update document records based on the document type.
  • MinimumAttachmentsCount; integer; Minimum number of attachments that a user must attach for a specific document type.
  • MultipleOccurencesFlag; boolean; Indicates whether multiple occurrences of this document type are allowed. The default value is Yes.
  • PublishRequiredFlag; boolean; Indicates whether document records of this document type must be published. The default value is No.
  • PurgeArchiveCriteriaDays; integer; Number of days after which archived document records will be purged.
  • SubCategoryCode; string; Code of the subcategory for the document type.
  • SystemDocumentType; string; System-generated name that uniquely identifies the document type.
  • TagList; string; Lookup code of the tag used for the document type derived from the lookup ORA_PER_DOC_TYPE_TAGS.
  • WarningPeriod; integer; Number of days in advance to generate an alert when a document record based on this document type is about to expire.
• 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

• 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 Top

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.

Body ()

Root Schema : hrDocumentTypes

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hrDocumentTypes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "isCompactViewByDefault":true
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hrDocumentTypes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hrDocumentTypes-item-response"
    }
}

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 : hrDocumentTypes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the document type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyCode":{
            "title":"Override Hierarchy",
            "maxLength":30,
            "type":"string",
            "description":"Hierarchy code to support delivery preferences on this document type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurgeArchiveCriteriaDays":{
            "title":"Purge After Days",
            "type":"integer",
            "description":"Number of days after which archived document records will be purged.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CommentsRequired":{
            "title":"Issuing Comments Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether comments are relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ArchiveCriteriaDays":{
            "title":"Archive After Days",
            "type":"integer",
            "description":"Number of days after which document records are archived based on the document type.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LockDeleteFlag":{
            "title":"Restrict Delete",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether it restricts or allows deleting document records of this document type. The default value is No.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockCreateRoleList":{
            "title":"Roles Excluded from Restriction",
            "maxLength":4000,
            "type":"string",
            "description":"List of roles that can create document records based on the document type.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationRequiredFlag":{
            "title":"Approval Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether approval is required for the document type. The default value is No.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "IssuingLocationLabel":{
            "title":"New Label for Issuing Location",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the issuing location.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumberLabel":{
            "title":"New Label for Number",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the document number.",
            "nullable":true,
            "x-queryable":true
        },
        "translations":{
            "title":"Translations for Document Types",
            "type":"array",
            "description":"The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type.",
            "items":{
                "$ref":"#/components/schemas/hrDocumentTypes-translations-item-response"
            }
        },
        "LockUpdateFlag":{
            "title":"Restrict Update",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether it restricts or allows updating document records of this document type. The default value is No.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockUpdateRoleList":{
            "title":"Roles Excluded from Restriction",
            "maxLength":4000,
            "type":"string",
            "description":"List of roles allowed to update document records based on the document type.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubCategoryCode":{
            "title":"Subcategory",
            "maxLength":30,
            "type":"string",
            "description":"Code of the subcategory for the document type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DocumentNameRequired":{
            "title":"Document Name Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether document name is relevant (Y) or required (R) or not relevant (N). The default setting is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "documentTypesDDF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/hrDocumentTypes-documentTypesDDF-item-response"
            },
            "x-cardinality":"1"
        },
        "WarningPeriod":{
            "title":"Expiration Notification Period",
            "type":"integer",
            "description":"Number of days in advance to generate an alert when a document record based on this document type is about to expire.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentNumberRequired":{
            "title":"Document Number Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether document number is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SystemDocumentType":{
            "title":"System Document Type",
            "maxLength":120,
            "type":"string",
            "description":"System-generated name that uniquely identifies the document type.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DateFromRequired":{
            "title":"From Date Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether date from is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DateToLabel":{
            "title":"New Label for To Date",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the to date.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuedDateRequired":{
            "title":"Issued on Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether issued date is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentTypeLevel":{
            "title":"Document Type Level",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the document type applies to a person or an individual assignment. The default value is Person.",
            "nullable":false,
            "default":"ORA_P",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "PublishRequiredFlag":{
            "title":"Publish Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether document records of this document type must be published. The default value is No.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DffGlbSegDisplayPreference":{
            "title":"Display Preference for Global Segment",
            "maxLength":30,
            "type":"string",
            "description":"Display preference for the document records flexfield global segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockDeleteRoleList":{
            "title":"Roles Excluded from Restriction",
            "maxLength":4000,
            "type":"string",
            "description":"List of roles allowed to delete document records based on the document type.",
            "nullable":true,
            "x-queryable":true
        },
        "DffCtxSegDefaultValue":{
            "title":"Default Value for Context Segment",
            "maxLength":120,
            "type":"string",
            "description":"Default value for the document records flexfield context segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DffCtxSegDisplayPreference":{
            "title":"Display Preference for Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Display preference for the document records flexfield context segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Legislation code if this is a legislation specific document type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description for the document type.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/hrDocumentTypes-attachments-item-response"
            }
        },
        "ActiveInactiveFlag":{
            "title":"Active",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the document type is active. The default value is Yes.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DocumentNameLabel":{
            "title":"New Label for Name",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the document name.",
            "nullable":true,
            "x-queryable":true
        },
        "BiReportPath":{
            "title":"Report Path",
            "maxLength":2000,
            "type":"string",
            "description":"URL or path where the report is available.",
            "nullable":true,
            "x-queryable":true
        },
        "DateToRequired":{
            "title":"To Date Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether date to is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumAttachmentsCount":{
            "title":"Minimum Attachments",
            "type":"integer",
            "description":"Minimum number of attachments that a user must attach for a specific document type.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "includeInCompactView":true,
                "precision":5
            },
            "x-queryable":true
        },
        "DateFromLabel":{
            "title":"New Label for From Date",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the from date.",
            "nullable":true,
            "x-queryable":true
        },
        "TagList":{
            "title":"Tags",
            "maxLength":2000,
            "type":"string",
            "description":"Lookup code of the tag used for the document type derived from the lookup ORA_PER_DOC_TYPE_TAGS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "IssuingAuthorityLabel":{
            "title":"New Label for Issuing Authority",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the issuing authority.",
            "nullable":true,
            "x-queryable":true
        },
        "CommentsLabel":{
            "title":"New Label for Issuing Comments",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the issuing comments.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"Unique name to identify the document type.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "IssuedDateLabel":{
            "title":"New Label for Issued Date",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the issued date.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuingCountryRequired":{
            "title":"Issuing Country Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether issuing country is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockCreateFlag":{
            "title":"Restrict Create",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether it restricts or allows creating document records of this document type. The default value is No",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IssuingLocationRequired":{
            "title":"Issuing Location Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether issuing location is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "documentTypesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/hrDocumentTypes-documentTypesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DocumentTypeId":{
            "title":"Type",
            "type":"integer",
            "description":"Surrogate ID for the document type which is available only when updating existing records.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IssuingCountryLabel":{
            "title":"New Label for Issuing Country",
            "maxLength":200,
            "type":"string",
            "description":"Label for the field that the user defines for the issuing country.",
            "nullable":true,
            "x-queryable":true
        },
        "MultipleOccurencesFlag":{
            "title":"Allow multiple occurrences",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether multiple occurrences of this document type are allowed. The default value is Yes.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ArchiveCriteriaBasis":{
            "title":"Archive Criteria Basis",
            "maxLength":30,
            "type":"string",
            "description":"Criteria for archiving document records based on the document type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the document type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuingAuthorityRequired":{
            "title":"Issuing Authority Applicable",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether issuing authority is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object hrDocumentTypes-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/hrDocumentTypes-attachments-item-response"
    }
}

Nested Schema : documentTypesDDF

Type: array

Show Source

• Array of: object hrDocumentTypes-documentTypesDDF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hrDocumentTypes-documentTypesDDF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : documentTypesDFF

Type: array

Show Source

• Array of: object hrDocumentTypes-documentTypesDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hrDocumentTypes-documentTypesDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : 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

• Array of: object hrDocumentTypes-translations-item-response

{
    "title":"Translations for Document Types",
    "type":"array",
    "description":"The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type.",
    "items":{
        "$ref":"#/components/schemas/hrDocumentTypes-translations-item-response"
    }
}

Nested Schema : hrDocumentTypes-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "AttachmentsPreview":{
            "title":"Attachment Previews",
            "type":"array",
            "description":"The attachments preview resource is used to preview the attachment pages.",
            "items":{
                "$ref":"#/components/schemas/hrDocumentTypes-attachments-AttachmentsPreview-item-response"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Attachment Previews

Type: array

Title: Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Show Source

• Array of: object hrDocumentTypes-attachments-AttachmentsPreview-item-response

{
    "title":"Attachment Previews",
    "type":"array",
    "description":"The attachments preview resource is used to preview the attachment pages.",
    "items":{
        "$ref":"#/components/schemas/hrDocumentTypes-attachments-AttachmentsPreview-item-response"
    }
}

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 : hrDocumentTypes-attachments-AttachmentsPreview-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageSource":{
            "title":"Image Source",
            "type":"string",
            "description":"The preview of the image in base64 encoded PNG format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "PageNum":{
            "title":"Page Number",
            "type":"integer",
            "description":"The number of the page in the preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageHeight":{
            "title":"Image Height",
            "type":"integer",
            "description":"The height of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImageWidth":{
            "title":"Image Width",
            "type":"integer",
            "description":"The width of the previewed image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : hrDocumentTypes-documentTypesDDF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "DocumentTypeId":{
            "title":"Type",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_DerivedFromParameter":"LEGISLATION_CODE",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : hrDocumentTypes-documentTypesDFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "DocumentTypeId":{
            "title":"Type",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : hrDocumentTypes-translations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the translated document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the translated document type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the translated document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Translated description for the document type.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CommentsLabel":{
            "title":"New Label for Issuing Comments",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing comments.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNameLabel":{
            "title":"New Label for Name",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the document name.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"Translated name to uniquely identify the document type.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "IssuedDateLabel":{
            "title":"New Label for Issued Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issued date.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuingLocationLabel":{
            "title":"New Label for Issuing Location",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing location.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTypeId":{
            "type":"integer",
            "description":"Surrogate ID for the translated document type which is available only when updating existing records.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "IssuingCountryLabel":{
            "title":"New Label for Issuing Country",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing country.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Translated language of the document type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "DateToLabel":{
            "title":"New Label for To Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the to date.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumberLabel":{
            "title":"New Label for Number",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the document number.",
            "nullable":true,
            "x-queryable":true
        },
        "DateFromLabel":{
            "title":"New Label for From Date",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the from date.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IssuingAuthorityLabel":{
            "title":"New Label for Issuing Authority",
            "maxLength":200,
            "type":"string",
            "description":"Translated label for the field that the user defines for the issuing authority.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the translated document type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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"
    }
}

Back to Top