Jump to

• Request
• Response

Get a community detail

get

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeCommunityDetails/{EmployeeCommunityId}

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=

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

Type: object

Show Source

• attachments: array Candidate Attachments
  Title: Candidate Attachments

  The attachments resource provides information about files attached to the interview.
• categories: array Categories
  Title: Categories

  The categories resource provides access to employee community categories.
• ChannelURL: string
  Title: Channel Link

  Maximum Length: 2048

  URL of the communication channel for the employee community.
• CommunityOwnerName: string
  Read Only: true

  Maximum Length: 255

  Name of the community owner associated with the employee community details.
• CommunityStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_DRAFT

  Indicates the status of the employee's community membership. Valid values are Active and Inactive. Default is Inactive.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates who created the employee community details record. This field is read-only and automatically populated when the record is created.
• CreationDate: string (date-time)
  Title: Created On

  Read Only: true

  Creation date of the employee community details record.
• Description: string (byte)
  Title: Description

  Description of the employee community details. This field provides a brief overview of the community.
• EmployeeCmtyLastModifiedDate: string (date-time)
  Last modified date of the employee community details. This date indicates when the community information was most recently updated.
• EmployeeCommunityId: integer (int64)
  Unique identifier for the employee community.
• EmployeeCommunityNumber: string
  Maximum Length: 64

  Unique identifier for the employee community. This number distinguishes each community record in the system.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last updated date for the employee community details.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the employee community details.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last update login identifier for the employee community details. This value tracks the login ID used during the last update of the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• members: array Members
  Title: Members

  The members resource provides details about employee community members.
• MembersCount: number
  Title: Members

  Read Only: true

  Number of members in the employee community.
• Name: string
  Title: Name

  Maximum Length: 240

  Name of the employee community. This field identifies the specific community associated with the employee.
• ObjectStatus: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  Indicates the current status of the employee community object. Valid values are Active and Inactive. Default is Inactive.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the employee community details record. This value helps in tracking changes to the record.
• posts: array Posts
  Title: Posts

  The posts resource provides access to employee community posts.
• VisibilityCode: string
  Maximum Length: 30

  Default Value: ORA_PUBLIC

  Indicates the visibility setting for the employee community details. Valid values are Public and Private. Default is Private.

{
    "type":"object",
    "properties":{
        "ChannelURL":{
            "title":"Channel Link",
            "maxLength":2048,
            "type":"string",
            "description":"URL of the communication channel for the employee community.",
            "nullable":true,
            "x-queryable":true
        },
        "CommunityOwnerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the community owner associated with the employee community details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunityStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the employee's community membership. Valid values are Active and Inactive. Default is Inactive.",
            "nullable":true,
            "default":"ORA_DRAFT",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created the employee community details record. This field is read-only and automatically populated when the record is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Created On",
            "type":"string",
            "description":"Creation date of the employee community details record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the employee community details. This field provides a brief overview of the community.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "EmployeeCmtyLastModifiedDate":{
            "type":"string",
            "description":"Last modified date of the employee community details. This date indicates when the community information was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EmployeeCommunityId":{
            "type":"integer",
            "description":"Unique identifier for the employee community.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmployeeCommunityNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier for the employee community. This number distinguishes each community record in the system.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date for the employee community details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login identifier for the employee community details. This value tracks the login ID used during the last update of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the employee community details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MembersCount":{
            "title":"Members",
            "type":"number",
            "description":"Number of members in the employee community.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the employee community. This field identifies the specific community associated with the employee.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the employee community object. Valid values are Active and Inactive. Default is Inactive.",
            "nullable":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the employee community details record. This value helps in tracking changes to the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "VisibilityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the visibility setting for the employee community details. Valid values are Public and Private. Default is Private.",
            "nullable":true,
            "default":"ORA_PUBLIC",
            "x-queryable":true
        },
        "attachments":{
            "title":"Candidate Attachments",
            "type":"array",
            "description":"The attachments resource provides information about files attached to the interview.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-attachments-item-response"
            }
        },
        "categories":{
            "title":"Categories",
            "type":"array",
            "description":"The categories resource provides access to employee community categories.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-categories-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "members":{
            "title":"Members",
            "type":"array",
            "description":"The members resource provides details about employee community members.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-members-item-response"
            }
        },
        "posts":{
            "title":"Posts",
            "type":"array",
            "description":"The posts resource provides access to employee community posts.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-item-response"
            }
        }
    }
}

Nested Schema : Candidate Attachments

Type: array

Title: Candidate Attachments

The attachments resource provides information about files attached to the interview.

Show Source

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

{
    "title":"Candidate Attachments",
    "type":"array",
    "description":"The attachments resource provides information about files attached to the interview.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-attachments-item-response"
    }
}

Nested Schema : Categories

Type: array

Title: Categories

The categories resource provides access to employee community categories.

Show Source

• Array of: object communicateUIEmployeeCommunityDetails-categories-item-response

{
    "title":"Categories",
    "type":"array",
    "description":"The categories resource provides access to employee community categories.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-categories-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 : Members

Type: array

Title: Members

The members resource provides details about employee community members.

Show Source

• Array of: object communicateUIEmployeeCommunityDetails-members-item-response

{
    "title":"Members",
    "type":"array",
    "description":"The members resource provides details about employee community members.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-members-item-response"
    }
}

Nested Schema : Posts

Type: array

Title: Posts

The posts resource provides access to employee community posts.

Show Source

• Array of: object communicateUIEmployeeCommunityDetails-posts-item-response

{
    "title":"Posts",
    "type":"array",
    "description":"The posts resource provides access to employee community posts.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-item-response"
    }
}

Nested Schema : communicateUIEmployeeCommunityDetails-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 where 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

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

  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

  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

  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

  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

  The 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 where 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":"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 context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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"
            }
        },
        "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":"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"
            }
        },
        "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":"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":"The 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 : communicateUIEmployeeCommunityDetails-categories-item-response

Type: object

Show Source

• CategoryCode: string
  Maximum Length: 30

  Unique code identifying the employee community category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who created the employee community category.
• CreationDate: string (date-time)
  Read Only: true

  Date when the employee community category was created.
• EmployeeCommunityCategoryId: integer (int64)
  Unique identifier for the employee community category.
• EmployeeCommunityId: integer (int64)
  Unique identifier for the employee community category.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last updated date for the employee community category.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the employee community category.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last update login identifier for the employee community category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Meaning: string
  Read Only: true

  Maximum Length: 255

  Meaning of the employee community category in the application.
• ObjectStatus: string
  Maximum Length: 30

  Indicates the status of the employee community category. Valid values are Active and Inactive. Default is Active.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the employee community category record. This value helps in tracking changes to the record over time.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code identifying the employee community category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the employee community category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the employee community category was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeCommunityCategoryId":{
            "type":"integer",
            "description":"Unique identifier for the employee community category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmployeeCommunityId":{
            "type":"integer",
            "description":"Unique identifier for the employee community category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date for the employee community category.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login identifier for the employee community category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the employee community category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the employee community category in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the employee community category. Valid values are Active and Inactive. Default is Active.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the employee community category record. This value helps in tracking changes to the record over time.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "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 : communicateUIEmployeeCommunityDetails-members-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates who created the community member record. This field is read-only and automatically populated when the record is created.
• CreationDate: string (date-time)
  Read Only: true

  Date when the community member record was created.
• EmployeeCommunityId: integer (int64)
  Unique identifier for the employee community member.
• EmployeeCommunityMemberId: integer (int64)
  Unique identifier for the employee community member.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last updated date and time of the employee community member's details.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the employee community member.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last update login identifier for the employee community member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberPersonId: integer (int64)
  Unique identifier for the member person in the employee community.
• MemberTypeCode: string
  Maximum Length: 30

  Indicates the type of member in the employee community. Valid values are defined in the associated lookup. Default is null.
• ObjectStatus: string
  Maximum Length: 30

  Indicates the status of the community member object. Valid values are Active and Inactive. Default is Active.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the employee community member record. This value helps in tracking changes to the record.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created the community member record. This field is read-only and automatically populated when the record is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the community member record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeCommunityId":{
            "type":"integer",
            "description":"Unique identifier for the employee community member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmployeeCommunityMemberId":{
            "type":"integer",
            "description":"Unique identifier for the employee community member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date and time of the employee community member's details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login identifier for the employee community member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the employee community member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberPersonId":{
            "type":"integer",
            "description":"Unique identifier for the member person in the employee community.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemberTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of member in the employee community. Valid values are defined in the associated lookup. Default is null.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the community member object. Valid values are Active and Inactive. Default is Active.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the employee community member record. This value helps in tracking changes to the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "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 : communicateUIEmployeeCommunityDetails-posts-item-response

Type: object

Show Source

• attachments: array Candidate Attachments
  Title: Candidate Attachments

  The attachments resource provides information about files attached to the interview.
• CanDelete: string
  Read Only: true

  Maximum Length: 255

  Indicates whether the user can delete the community post. Valid values are true and false. Default is false.
• CanEdit: string
  Read Only: true

  Maximum Length: 255

  Indicates whether the user can edit the community post. Valid values are true and false. Default is false.
• CanPINPost: string
  Read Only: true

  Maximum Length: 255

  Indicates whether the user can pin the post. Valid values are true and false. Default is false.
• CanUnpinPost: string
  Read Only: true

  Maximum Length: 255

  Indicates whether the user can unpin a post. Valid values are true and false. Default is false.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates who created the community post. This field is read-only and automatically populated when the post is created.
• CreationDate: string (date-time)
  Read Only: true

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

  Last updated date of the employee community post. Indicates when the post was most recently modified.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by the user who modified the community post.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last updated login identifier for the employee community post.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfViews: integer (int64)
  Read Only: true

  Number of views for the community post. This value indicates how many times the post has been viewed by users.
• ObjectStatus: string
  Maximum Length: 30

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

  Maximum Length: 255

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

  Indicates whether the post is pinned. Valid values are Y and N. Default is N.
• postActionTracking: array Post Action Metrics
  Title: Post Action Metrics

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

  Maximum Length: 255

  Name of the person who created the post.
• postMentions: array Post Mentions
  Title: Post Mentions

  The postMentions resource provides details about mentions in employee community posts.
• VisibilityCode: string
  Maximum Length: 30

  Indicates the visibility setting for the community post. Valid values are Public and Private. Default is Public.

{
    "type":"object",
    "properties":{
        "CanDelete":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the user can delete the community post. Valid values are true and false. Default is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanEdit":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the user can edit the community post. Valid values are true and false. Default is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanPINPost":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the user can pin the post. Valid values are true and false. Default is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanUnpinPost":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the user can unpin a post. Valid values are true and false. Default is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created the community post. This field is read-only and automatically populated when the post is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the community post was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeCommunityId":{
            "type":"integer",
            "description":"Unique identifier for the employee community associated with the post.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmployeeCommunityPostId":{
            "type":"integer",
            "description":"Unique identifier for the employee community post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date of the employee community post. Indicates when the post was most recently modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last updated login identifier for the employee community post.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by the user who modified the community post.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfViews":{
            "type":"integer",
            "description":"Number of views for the community post. This value indicates how many times the post has been viewed by users.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the community post. Valid values are Active and Inactive. Default is Active.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the employee community post. This value helps in tracking changes to the post.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PinnedByPersonId":{
            "type":"integer",
            "description":"Identifier of the person who pinned the post.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PinnedByPersonName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who pinned the post.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PinnedDate":{
            "type":"string",
            "description":"Date when the post was pinned to the top of the community feed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PinnedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the post is pinned. Valid values are Y and N. Default is N.",
            "nullable":true,
            "x-queryable":true
        },
        "PostContent":{
            "type":"string",
            "description":"Content of the post shared within the employee community.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PostCreatorPersonId":{
            "type":"integer",
            "description":"Identifier of the person who created the post.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostCreatorPersonName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who created the post.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VisibilityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the visibility setting for the community post. Valid values are Public and Private. Default is Public.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Candidate Attachments",
            "type":"array",
            "description":"The attachments resource provides information about files attached to the interview.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "postActionTracking":{
            "title":"Post Action Metrics",
            "type":"array",
            "description":"The EmpCmtPostActionTkUI resource provides details about employee community post actions.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-postActionTracking-item-response"
            }
        },
        "postMentions":{
            "title":"Post Mentions",
            "type":"array",
            "description":"The postMentions resource provides details about mentions in employee community posts.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-postMentions-item-response"
            }
        }
    }
}

Nested Schema : Candidate Attachments

Type: array

Title: Candidate Attachments

The attachments resource provides information about files attached to the interview.

Show Source

• Array of: object communicateUIEmployeeCommunityDetails-posts-attachments-item-response

{
    "title":"Candidate Attachments",
    "type":"array",
    "description":"The attachments resource provides information about files attached to the interview.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-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 : Post Action Metrics

Type: array

Title: Post Action Metrics

The EmpCmtPostActionTkUI resource provides details about employee community post actions.

Show Source

• Array of: object communicateUIEmployeeCommunityDetails-posts-postActionTracking-item-response

{
    "title":"Post Action Metrics",
    "type":"array",
    "description":"The EmpCmtPostActionTkUI resource provides details about employee community post actions.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-postActionTracking-item-response"
    }
}

Nested Schema : Post Mentions

Type: array

Title: Post Mentions

The postMentions resource provides details about mentions in employee community posts.

Show Source

• Array of: object communicateUIEmployeeCommunityDetails-posts-postMentions-item-response

{
    "title":"Post Mentions",
    "type":"array",
    "description":"The postMentions resource provides details about mentions in employee community posts.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeCommunityDetails-posts-postMentions-item-response"
    }
}

Nested Schema : communicateUIEmployeeCommunityDetails-posts-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 where 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

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

  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

  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

  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

  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

  The 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 where 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":"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 context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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"
            }
        },
        "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":"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"
            }
        },
        "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":"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":"The 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 : communicateUIEmployeeCommunityDetails-posts-postActionTracking-item-response

Type: object

Show Source

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

  Indicates the type of action taken on the post. Valid values are defined in the associated lookup.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Created by the user who initiated the post action tracking.
• CreationDate: string (date-time)
  Read Only: true

  Date when the post action was created.
• EmployeeCommunityPostId: integer (int64)
  Unique identifier for the employee community post.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last updated date of the post action tracking record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the post action tracking.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last updated login ID for the post action tracking record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectStatus: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

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

{
    "type":"object",
    "properties":{
        "ActionByPersonId":{
            "type":"integer",
            "description":"Identifier of the person who performed the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionCount":{
            "type":"number",
            "description":"Count of actions taken on a post. This value represents the total number of interactions or engagements with the post.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionDate":{
            "type":"string",
            "description":"Date when the action was taken on the post.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActionTrackingId":{
            "type":"integer",
            "description":"Unique identifier for the action tracking record in the employee community post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionTypeCode":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the type of action taken on the post. Valid values are defined in the associated lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Created by the user who initiated the post action tracking.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the post action was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeCommunityPostId":{
            "type":"integer",
            "description":"Unique identifier for the employee community post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date of the post action tracking record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last updated login ID for the post action tracking record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the post action tracking.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the object. Valid values are Active and Inactive. Default is Active.",
            "nullable":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the post action tracking object. This value helps in tracking changes to the object over time.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "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 : communicateUIEmployeeCommunityDetails-posts-postMentions-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Last updated date and time of the post mention.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the post mention. Indicates the user who last modified the mention.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last updated login ID of the user who modified the post mention.
• links: array Links
  Title: Links

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

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

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created the post mention in the employee community. This attribute identifies the user responsible for tagging or mentioning another user in a post.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the post mention was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeCommunityPostId":{
            "type":"integer",
            "description":"Unique identifier for the employee community post associated with the mention.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmployeeCommunityPostMentionId":{
            "type":"integer",
            "description":"Unique identifier for the employee community post mention.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date and time of the post mention.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last updated login ID of the user who modified the post mention.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the post mention. Indicates the user who last modified the mention.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MentionPersonId":{
            "type":"integer",
            "description":"Unique identifier of the person mentioned in the employee community post.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the object. Valid values are Active and Inactive. Default is Active.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the post mention object. It helps in tracking changes to the mention.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "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/communicateUIEmployeeCommunityDetails/{EmployeeCommunityId}/child/attachments

Parameters:

• EmployeeCommunityId: $request.path.EmployeeCommunityId

The attachments resource provides information about files attached to the interview.

categories

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIEmployeeCommunityDetails/{EmployeeCommunityId}/child/categories

Parameters:

• EmployeeCommunityId: $request.path.EmployeeCommunityId

The categories resource provides access to employee community categories.

members

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIEmployeeCommunityDetails/{EmployeeCommunityId}/child/members

Parameters:

• EmployeeCommunityId: $request.path.EmployeeCommunityId

The members resource provides details about employee community members.

posts

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIEmployeeCommunityDetails/{EmployeeCommunityId}/child/posts

Parameters:

• EmployeeCommunityId: $request.path.EmployeeCommunityId

The posts resource provides access to employee community posts.

Back to Top