Jump to

• Request
• Response

Get an employee event

get

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEvents/{EventNumber}

Request

Path Parameters

• EventNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : communicateUIEmployeeEvents-item-response

Type: object

Show Source

• AnonymousFeedbackFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether anonymous feedback is enabled for the employee event. Valid values are Y and N. Default is N.
• attachments: array Employee Event Attachments
  Title: Employee Event Attachments

  The attachments resource fetches attachments for employee events.
• BannerImageURL: string
  Read Only: true

  Maximum Length: 255

  Image URL for the event banner.
• CategoryNames: string
  Read Only: true

  Maximum Length: 255

  Categories of the event.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 255

  City of an in-person event.
• CollectFeedbackFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether to collect feedback for the employee event. Valid values are Y and N. Default is N.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 255

  Country of an in-person event.
• CreationDate: string (date-time)
  Read Only: true

  Creation date of the event.
• Description: string (byte)
  Title: Description

  Read Only: true

  Description of the event.
• EmployeeEventId: integer
  Read Only: true

  Unique identifier for the event.
• EndDate: string (date-time)
  Title: End Date

  Read Only: true

  End date of the event.
• EventNumber: string
  Read Only: true

  Event number of the event.
• EventOrigin: string
  Read Only: true

  Maximum Length: 255

  Indicates the origin of the employee event. This value helps identify where the event was initiated.
• EventOriginId: integer
  Read Only: true

  Unique identifier for the origin of the employee event.
• EventOriginName: string
  Read Only: true

  Maximum Length: 255

  Name of the event origin for the employee event.
• EventStatusCode: string
  Read Only: true

  Maximum Length: 255

  Event status code of the event.
• FeedbackQstnrVersionNum: string
  Read Only: true

  Maximum Length: 255

  Version number of the feedback questionnaire associated with the employee event.
• FeedbackQuestionnaireId: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the feedback questionnaire associated with the employee event.
• Format: string
  Title: Format

  Read Only: true

  Maximum Length: 255

  Format name of the event.
• FormatCode: string
  Read Only: true

  Maximum Length: 255

  Format code of the event.
• LastRegisterDate: string (date-time)
  Read Only: true

  Last registration date for the event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDetails: string (byte)
  Title: Location

  Read Only: true

  Location details for the event.
• MaximumCapacity: integer (int64)
  Title: Maximum Capacity

  Read Only: true

  Maximum allowed number of registrants in the event
• MeetingDetails: string (byte)
  Read Only: true

  Meeting details of a virtual event.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  Name of the event.
• OwnerName: string
  Title: Owner Name

  Read Only: true

  Maximum Length: 255

  Owner of the event.
• owners: array Employee Event Owners
  Title: Employee Event Owners

  The child resource that provides details of the owners of the employee event.
• QstnrVersionNumber: string
  Read Only: true

  Maximum Length: 255

  Questionnaire version number associated with the employee event.
• QuestionnaireId: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the questionnaire associated with the employee event.
• RegisteredCount: integer (int64)
  Title: Registered Count

  Read Only: true

  Number of registrants in the event.
• RespondentFeedbackSubmittedFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the respondent has submitted feedback. Valid values are Y and N. Default is N.
• RespondentStatusCode: string
  Read Only: true

  Maximum Length: 255

  Respondent status code of the event.
• RespondentStatusDescription: string
  Read Only: true

  Maximum Length: 255

  Respondent status description of the event.
• StartDate: string (date-time)
  Title: Start Date

  Read Only: true

  Start date of the event.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 255

  State in which the in-person event takes place.
• Status: string
  Title: Event Status

  Read Only: true

  Maximum Length: 255

  Status of the event.
• TimezoneCode: string
  Read Only: true

  Maximum Length: 255

  Time zone code of the event.
• TimezoneDescription: string
  Read Only: true

  Maximum Length: 255

  Time zone description of the event.
• Visibility: string
  Read Only: true

  Maximum Length: 255

  Display value indicating if the event is visible to all employees (public) or only invited employees (private).
• VisibilityCode: string
  Read Only: true

  Maximum Length: 255

  Code indicating if the event is visible to all employees (public) or only invited employees (private).
• WebConfLink: string
  Title: Meeting Web Link

  Read Only: true

  Maximum Length: 255

  Web conference link of the virtual event.

{
    "type":"object",
    "properties":{
        "AnonymousFeedbackFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether anonymous feedback is enabled for the employee event. Valid values are Y and N. Default is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BannerImageURL":{
            "maxLength":255,
            "type":"string",
            "description":"Image URL for the event banner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryNames":{
            "maxLength":255,
            "type":"string",
            "description":"Categories of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":255,
            "type":"string",
            "description":"City of an in-person event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollectFeedbackFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether to collect feedback for the employee event. Valid values are Y and N. Default is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":255,
            "type":"string",
            "description":"Country of an in-person event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the event.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeEventId":{
            "type":"integer",
            "description":"Unique identifier for the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventNumber":{
            "type":"string",
            "description":"Event number of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventOrigin":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the origin of the employee event. This value helps identify where the event was initiated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventOriginId":{
            "type":"integer",
            "description":"Unique identifier for the origin of the employee event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventOriginName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the event origin for the employee event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventStatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Event status code of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeedbackQstnrVersionNum":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the feedback questionnaire associated with the employee event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeedbackQuestionnaireId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the feedback questionnaire associated with the employee event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Format":{
            "title":"Format",
            "maxLength":255,
            "type":"string",
            "description":"Format name of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormatCode":{
            "maxLength":255,
            "type":"string",
            "description":"Format code of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastRegisterDate":{
            "type":"string",
            "description":"Last registration date for the event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDetails":{
            "title":"Location",
            "type":"string",
            "description":"Location details for the event.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumCapacity":{
            "title":"Maximum Capacity",
            "type":"integer",
            "description":"Maximum allowed number of registrants in the event",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "MeetingDetails":{
            "type":"string",
            "description":"Meeting details of a virtual event.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner Name",
            "maxLength":255,
            "type":"string",
            "description":"Owner of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QstnrVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Questionnaire version number associated with the employee event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the questionnaire associated with the employee event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RegisteredCount":{
            "title":"Registered Count",
            "type":"integer",
            "description":"Number of registrants in the event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "RespondentFeedbackSubmittedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the respondent has submitted feedback. Valid values are Y and N. Default is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RespondentStatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Respondent status code of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RespondentStatusDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Respondent status description of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":255,
            "type":"string",
            "description":"State in which the in-person event takes place.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Event Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "maxLength":255,
            "type":"string",
            "description":"Time zone code of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimezoneDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Time zone description of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Visibility":{
            "maxLength":255,
            "type":"string",
            "description":"Display value indicating if the event is visible to all employees (public) or only invited employees (private).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VisibilityCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code indicating if the event is visible to all employees (public) or only invited employees (private).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WebConfLink":{
            "title":"Meeting Web Link",
            "maxLength":255,
            "type":"string",
            "description":"Web conference link of the virtual event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Employee Event Attachments",
            "type":"array",
            "description":"The attachments resource fetches attachments for employee events.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeEvents-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "owners":{
            "title":"Employee Event Owners",
            "type":"array",
            "description":"The child resource that provides details of the owners of the employee event.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeEvents-owners-item-response"
            }
        }
    }
}

Nested Schema : Employee Event Attachments

Type: array

Title: Employee Event Attachments

The attachments resource fetches attachments for employee events.

Show Source

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

{
    "title":"Employee Event Attachments",
    "type":"array",
    "description":"The attachments resource fetches attachments for employee events.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeEvents-attachments-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 : Employee Event Owners

Type: array

Title: Employee Event Owners

The child resource that provides details of the owners of the employee event.

Show Source

• Array of: object communicateUIEmployeeEvents-owners-item-response

{
    "title":"Employee Event Owners",
    "type":"array",
    "description":"The child resource that provides details of the owners of the employee event.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeEvents-owners-item-response"
    }
}

Nested Schema : communicateUIEmployeeEvents-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

  Unique identifier of the attachment. System generated primary key.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. If true, the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the user who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates data type code of attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Attachment document preview URL.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object, represented as a string, that contains information required to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date and time of the attachment content.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  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

  Date and time when the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User name of the user who last updated the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  File content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  File length of the attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  File name of the attachment.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name associated with the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attachment. System generated primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. If true, the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Attachment document preview URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object, represented as a string, that contains information required to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the attachment 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"File content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name associated with the attachment.",
            "nullable":false,
            "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"
            }
        }
    }
}

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 : communicateUIEmployeeEvents-owners-item-response

Type: object

Show Source

• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name for the event owner.
• EmployeeEventId: integer (int64)
  Unique identifier for the employee event.
• EmployeeEventOwnerId: integer (int64)
  Unique identifier for the event owner.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First name of the event owner.
• FullName: string
  Title: Full Name

  Read Only: true

  Maximum Length: 2000

  Full name of the event owner.
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last name of the event owner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerPersonId: integer (int64)
  Person identifier for the event owner.
• OwnerTypeCode: string
  Maximum Length: 30

  Indicates whether a person is an event owner or co-owner.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name for the event owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeEventId":{
            "type":"integer",
            "description":"Unique identifier for the employee event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmployeeEventOwnerId":{
            "type":"integer",
            "description":"Unique identifier for the event owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the event owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":2000,
            "type":"string",
            "description":"Full name of the event owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the event owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPersonId":{
            "type":"integer",
            "description":"Person identifier for the event owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a person is an event owner or co-owner.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

attachments

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEvents/{EventNumber}/child/attachments

Parameters:

• EventNumber: $request.path.EventNumber

The attachments resource fetches attachments for employee events.

owners

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEvents/{EventNumber}/child/owners

Parameters:

• EventNumber: $request.path.EventNumber

The child resource that provides details of the owners of the employee event.

Back to Top