Create a post
post
/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeCommunityDetails/{EmployeeCommunityId}/child/posts
Request
Path Parameters
-
EmployeeCommunityId(required): integer(int64)
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=
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
attachments: array
Candidate Attachments
Title:
Candidate AttachmentsThe attachments resource provides information about files attached to the interview. -
EmployeeCommunityId: integer
(int64)
Unique identifier for the employee community associated with the post.
-
EmployeeCommunityPostId: integer
(int64)
Unique identifier for the employee community post.
-
ObjectStatus: string
Maximum Length:
30Indicates the current status of the community post. Valid values are Active and Inactive. Default is Active. -
ObjectVersionNumber: integer
(int32)
Unique identifier for the version of the employee community post. This value helps in tracking changes to the post.
-
PinnedByPersonId: integer
(int64)
Identifier of the person who pinned the post.
-
PinnedDate: string
(date-time)
Date when the post was pinned to the top of the community feed.
-
PinnedFlag: boolean
Maximum Length:
1Indicates whether the post is pinned. Valid values are Y and N. Default is N. -
postActionTracking: array
Post Action Metrics
Title:
Post Action MetricsThe EmpCmtPostActionTkUI resource provides details about employee community post actions. -
PostContent: string
(byte)
Content of the post shared within the employee community.
-
PostCreatorPersonId: integer
(int64)
Identifier of the person who created the post.
-
postMentions: array
Post Mentions
Title:
Post MentionsThe postMentions resource provides details about mentions in employee community posts. -
VisibilityCode: string
Maximum Length:
30Indicates the visibility setting for the community post. Valid values are Public and Private. Default is Public.
Nested Schema : Candidate Attachments
Type:
arrayTitle:
Candidate AttachmentsThe attachments resource provides information about files attached to the interview.
Show Source
Nested Schema : Post Action Metrics
Type:
arrayTitle:
Post Action MetricsThe EmpCmtPostActionTkUI resource provides details about employee community post actions.
Show Source
Nested Schema : Post Mentions
Type:
arrayTitle:
Post MentionsThe postMentions resource provides details about mentions in employee community posts.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEValue that indicates data type code of attachment. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeFile content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeFile length of the attachment. -
UploadedFileName: string
Title:
Uploaded File NameFile name of the attachment. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of the attachment.
Nested Schema : communicateUIEmployeeCommunityDetails-posts-postActionTracking-item-post-request
Type:
Show Source
object-
ActionByPersonId: integer
(int64)
Identifier of the person who performed the action.
-
ActionCount: number
Count of actions taken on a post. This value represents the total number of interactions or engagements with the post.
-
ActionDate: string
(date-time)
Date when the action was taken on the post.
-
ActionTrackingId: integer
(int64)
Unique identifier for the action tracking record in the employee community post.
-
ActionTypeCode: string
Maximum Length:
32Indicates the type of action taken on the post. Valid values are defined in the associated lookup. -
EmployeeCommunityPostId: integer
(int64)
Unique identifier for the employee community post.
-
ObjectStatus: string
Maximum Length:
30Default Value:ORA_ACTIVEIndicates the current status of the object. Valid values are Active and Inactive. Default is Active. -
ObjectVersionNumber: integer
(int32)
Unique identifier for the version of the post action tracking object. This value helps in tracking changes to the object over time.
Nested Schema : schema
Type:
Show Source
object-
EmployeeCommunityPostId: integer
(int64)
Unique identifier for the employee community post associated with the mention.
-
EmployeeCommunityPostMentionId: integer
(int64)
Unique identifier for the employee community post mention.
-
MentionPersonId: integer
(int64)
Unique identifier of the person mentioned in the employee community post.
-
ObjectStatus: string
Maximum Length:
30Indicates the status of the object. Valid values are Active and Inactive. Default is Active. -
ObjectVersionNumber: integer
(int32)
Version number of the post mention object. It helps in tracking changes to the mention.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : communicateUIEmployeeCommunityDetails-posts-item-response
Type:
Show Source
object-
attachments: array
Candidate Attachments
Title:
Candidate AttachmentsThe attachments resource provides information about files attached to the interview. -
CanDelete: string
Read Only:
trueMaximum Length:255Indicates whether the user can delete the community post. Valid values are true and false. Default is false. -
CanEdit: string
Read Only:
trueMaximum Length:255Indicates whether the user can edit the community post. Valid values are true and false. Default is false. -
CanPINPost: string
Read Only:
trueMaximum Length:255Indicates whether the user can pin the post. Valid values are true and false. Default is false. -
CanUnpinPost: string
Read Only:
trueMaximum Length:255Indicates whether the user can unpin a post. Valid values are true and false. Default is false. -
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates who created the community post. This field is read-only and automatically populated when the post is created. -
CreationDate: string
(date-time)
Read Only:
trueDate when the community post was created. -
EmployeeCommunityId: integer
(int64)
Unique identifier for the employee community associated with the post.
-
EmployeeCommunityPostId: integer
(int64)
Unique identifier for the employee community post.
-
LastUpdateDate: string
(date-time)
Read Only:
trueLast updated date of the employee community post. Indicates when the post was most recently modified. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last updated by the user who modified the community post. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Last updated login identifier for the employee community post. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberOfViews: integer
(int64)
Read Only:
trueNumber of views for the community post. This value indicates how many times the post has been viewed by users. -
ObjectStatus: string
Maximum Length:
30Indicates the current status of the community post. Valid values are Active and Inactive. Default is Active. -
ObjectVersionNumber: integer
(int32)
Unique identifier for the version of the employee community post. This value helps in tracking changes to the post.
-
PinnedByPersonId: integer
(int64)
Identifier of the person who pinned the post.
-
PinnedByPersonName: string
Read Only:
trueMaximum Length:255Name of the person who pinned the post. -
PinnedDate: string
(date-time)
Date when the post was pinned to the top of the community feed.
-
PinnedFlag: boolean
Maximum Length:
1Indicates whether the post is pinned. Valid values are Y and N. Default is N. -
postActionTracking: array
Post Action Metrics
Title:
Post Action MetricsThe EmpCmtPostActionTkUI resource provides details about employee community post actions. -
PostContent: string
(byte)
Content of the post shared within the employee community.
-
PostCreatorPersonId: integer
(int64)
Identifier of the person who created the post.
-
PostCreatorPersonName: string
Read Only:
trueMaximum Length:255Name of the person who created the post. -
postMentions: array
Post Mentions
Title:
Post MentionsThe postMentions resource provides details about mentions in employee community posts. -
VisibilityCode: string
Maximum Length:
30Indicates the visibility setting for the community post. Valid values are Public and Private. Default is Public.
Nested Schema : Candidate Attachments
Type:
arrayTitle:
Candidate AttachmentsThe attachments resource provides information about files attached to the interview.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Post Action Metrics
Type:
arrayTitle:
Post Action MetricsThe EmpCmtPostActionTkUI resource provides details about employee community post actions.
Show Source
Nested Schema : Post Mentions
Type:
arrayTitle:
Post MentionsThe postMentions resource provides details about mentions in employee community posts.
Show Source
Nested Schema : communicateUIEmployeeCommunityDetails-posts-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the attachment record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEValue that indicates data type code of attachment. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DocumentPreviewURL: string
Read Only:
trueMaximum Length:255Attachment context. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeFile content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeFile length of the attachment. -
UploadedFileName: string
Title:
Uploaded File NameFile name of the attachment. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name associated with the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : communicateUIEmployeeCommunityDetails-posts-postActionTracking-item-response
Type:
Show Source
object-
ActionByPersonId: integer
(int64)
Identifier of the person who performed the action.
-
ActionCount: number
Count of actions taken on a post. This value represents the total number of interactions or engagements with the post.
-
ActionDate: string
(date-time)
Date when the action was taken on the post.
-
ActionTrackingId: integer
(int64)
Unique identifier for the action tracking record in the employee community post.
-
ActionTypeCode: string
Maximum Length:
32Indicates the type of action taken on the post. Valid values are defined in the associated lookup. -
CreatedBy: string
Read Only:
trueMaximum Length:64Created by the user who initiated the post action tracking. -
CreationDate: string
(date-time)
Read Only:
trueDate when the post action was created. -
EmployeeCommunityPostId: integer
(int64)
Unique identifier for the employee community post.
-
LastUpdateDate: string
(date-time)
Read Only:
trueLast updated date of the post action tracking record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last updated by information for the post action tracking. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Last updated login ID for the post action tracking record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectStatus: string
Maximum Length:
30Default Value:ORA_ACTIVEIndicates the current status of the object. Valid values are Active and Inactive. Default is Active. -
ObjectVersionNumber: integer
(int32)
Unique identifier for the version of the post action tracking object. This value helps in tracking changes to the object over time.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : communicateUIEmployeeCommunityDetails-posts-postMentions-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates who created the post mention in the employee community. This attribute identifies the user responsible for tagging or mentioning another user in a post. -
CreationDate: string
(date-time)
Read Only:
trueDate when the post mention was created. -
EmployeeCommunityPostId: integer
(int64)
Unique identifier for the employee community post associated with the mention.
-
EmployeeCommunityPostMentionId: integer
(int64)
Unique identifier for the employee community post mention.
-
LastUpdateDate: string
(date-time)
Read Only:
trueLast updated date and time of the post mention. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last updated by information for the post mention. Indicates the user who last modified the mention. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Last updated login ID of the user who modified the post mention. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MentionPersonId: integer
(int64)
Unique identifier of the person mentioned in the employee community post.
-
ObjectStatus: string
Maximum Length:
30Indicates the status of the object. Valid values are Active and Inactive. Default is Active. -
ObjectVersionNumber: integer
(int32)
Version number of the post mention object. It helps in tracking changes to the mention.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- attachments
-
Parameters:
- EmployeeCommunityId:
$request.path.EmployeeCommunityId - EmployeeCommunityPostId:
$request.path.EmployeeCommunityPostId
The attachments resource provides information about files attached to the interview. - EmployeeCommunityId:
- postActionTracking
-
Parameters:
- EmployeeCommunityId:
$request.path.EmployeeCommunityId - EmployeeCommunityPostId:
$request.path.EmployeeCommunityPostId
The EmpCmtPostActionTkUI resource provides details about employee community post actions. - EmployeeCommunityId:
- postMentions
-
Parameters:
- EmployeeCommunityId:
$request.path.EmployeeCommunityId - EmployeeCommunityPostId:
$request.path.EmployeeCommunityPostId
The postMentions resource provides details about mentions in employee community posts. - EmployeeCommunityId: