Jump to

• Request
• Response

Create an active learner comment

post

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments

Request

Path Parameters

• completionDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Completion Details resource and used to uniquely identify an instance of Completion Details. The client should not generate the hash key value. Instead, the client should query on the Completion Details collection resource in order to navigate to a specific instance of Completion Details to get the hash key.
• learnerLearningRecordsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records to get the hash key.
• selectedCourseOfferingsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Selected Course Offerings resource and used to uniquely identify an instance of Selected Course Offerings. The client should not generate the hash key value. Instead, the client should query on the Selected Course Offerings collection resource in order to navigate to a specific instance of Selected Course Offerings to get the hash key.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
• comment: string
  Title: Comment

  Maximum Length: 4000

  Comment of the learner in conversations for active and completed learners for the learning item.
• commentStatus: string
  Title: Comment Status

  Maximum Length: 30

  Learner comment status in conversations for active and completed learners for the learning item. Valid values are defined in the list CommentStatusLOV.
• dataSecurityPrivilege: string
  Title: Data Security Privilege

  Default Value: ORA_LEARNER

  Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
• likes: array Likes
  Title: Likes

  The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
• replies: array Replies
  Title: Replies

  The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.

{
    "type":"object",
    "properties":{
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.",
            "nullable":true,
            "default":"ORA_LEARNER"
        },
        "comment":{
            "title":"Comment",
            "maxLength":4000,
            "type":"string",
            "description":"Comment of the learner in conversations for active and completed learners for the learning item.",
            "nullable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-post-request"
            }
        },
        "replies":{
            "title":"Replies",
            "type":"array",
            "description":"The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-post-request"
            }
        },
        "commentStatus":{
            "title":"Comment Status",
            "maxLength":30,
            "type":"string",
            "description":"Learner comment status in conversations for active and completed learners for the learning item. Valid values are defined in the list CommentStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "likes":{
            "title":"Likes",
            "type":"array",
            "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-post-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-post-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-post-request"
    }
}

Nested Schema : Likes

Type: array

Title: Likes

The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-post-request

{
    "title":"Likes",
    "type":"array",
    "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-post-request"
    }
}

Nested Schema : Replies

Type: array

Title: Replies

The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-post-request

{
    "title":"Replies",
    "type":"array",
    "description":"The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-post-request"
    }
}

Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false, and it's the only supported value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Identifier for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number to identify the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  String representation of the JSON object used to retrieve a file attachment programmatically.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

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

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  File URL of the attachment.
• Title: string
  Title: Title

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Identifier for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false, and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"String representation of the JSON object used to retrieve a file attachment programmatically.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number to identify the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-post-request

Type: object

Show Source

• likeId: integer (int64)
  Title: Like ID

  Unique identifier of the like.
• likeStatus: string
  Title: Like Status

  Maximum Length: 30

  Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.

{
    "type":"object",
    "properties":{
        "likeStatus":{
            "title":"Like Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "likeId":{
            "title":"Like ID",
            "type":"integer",
            "description":"Unique identifier of the like.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-post-request

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
• comment: string
  Title: Comment

  Maximum Length: 4000

  Reply comment of the learner on a comment.
• dataSecurityPrivilege: string
  Title: Data Security Privilege

  Default Value: ORA_LEARNER

  Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
• likes: array Likes
  Title: Likes

  The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
• replyStatus: string
  Title: Reply Status

  Maximum Length: 30

  Status of the reply on a comment. Valid values are defined in the list ReplyStatusLOV.

{
    "type":"object",
    "properties":{
        "replyStatus":{
            "title":"Reply Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the reply on a comment. Valid values are defined in the list ReplyStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.",
            "nullable":true,
            "default":"ORA_LEARNER"
        },
        "comment":{
            "title":"Comment",
            "maxLength":4000,
            "type":"string",
            "description":"Reply comment of the learner on a comment.",
            "nullable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-post-request"
            }
        },
        "likes":{
            "title":"Likes",
            "type":"array",
            "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-post-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-post-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-post-request"
    }
}

Nested Schema : Likes

Type: array

Title: Likes

The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-post-request

{
    "title":"Likes",
    "type":"array",
    "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-post-request"
    }
}

Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false, and it's the only supported value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Identifier for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number to identify the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  String representation of the JSON object used to retrieve a file attachment programmatically.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

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

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  File URL of the attachment.
• Title: string
  Title: Title

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Identifier for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false, and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"String representation of the JSON object used to retrieve a file attachment programmatically.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number to identify the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-post-request

Type: object

Show Source

• likeId: integer (int64)
  Title: Like ID

  Unique identifier of the like.
• likeStatus: string
  Title: Like Status

  Maximum Length: 30

  Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.

{
    "type":"object",
    "properties":{
        "likeStatus":{
            "title":"Like Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "likeId":{
            "title":"Like ID",
            "type":"integer",
            "description":"Unique identifier of the like.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-item-response

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
• byPersonDisplayName: string
  Title: Commented By

  Read Only: true

  Maximum Length: 240

  Commented by person display name.
• byPersonId: integer (int64)
  Title: Commented by Person ID

  Read Only: true

  Commented by person identifier.
• byPersonImageURL: string
  Title: Commented by Person Image URL

  Read Only: true

  Maximum Length: 4000

  Commented by person image URL.
• byPersonNumber: string
  Title: Commented by Person Number

  Read Only: true

  Maximum Length: 30

  Commented by person number.
• comment: string
  Title: Comment

  Maximum Length: 4000

  Comment of the learner in conversations for active and completed learners for the learning item.
• commentDate: string (date-time)
  Title: Commented on Date

  Read Only: true

  Date of the comment in conversations for active and completed learners for the learning item.
• commentId: integer (int64)
  Title: Comment ID

  Read Only: true

  Unique identifier of the comment.
• commentLikedByCurrentUser: string
  Read Only: true

  Indicates whether the signed in person liked the comment. Valid values are Y and N. The default value is N.
• commentStatus: string
  Title: Comment Status

  Maximum Length: 30

  Learner comment status in conversations for active and completed learners for the learning item. Valid values are defined in the list CommentStatusLOV.
• commentStatusMeaning: string
  Title: Comment Status Description

  Read Only: true

  Maximum Length: 4000

  Description for the commentStatus attribute value.
• dataSecurityPrivilege: string
  Title: Data Security Privilege

  Default Value: ORA_LEARNER

  Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
• likeCount: integer (int32)
  Title: Like Count

  Read Only: true

  Like count for the comment in conversations for active and completed learners for the learning item.
• likes: array Likes
  Title: Likes

  The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• replies: array Replies
  Title: Replies

  The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
• replyCount: integer (int32)
  Title: Reply Count

  Read Only: true

  Reply count for the comment in conversations for active and completed learners for the learning item.

{
    "type":"object",
    "properties":{
        "byPersonDisplayName":{
            "title":"Commented By",
            "maxLength":240,
            "type":"string",
            "description":"Commented by person display name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonImageURL":{
            "title":"Commented by Person Image URL",
            "maxLength":4000,
            "type":"string",
            "description":"Commented by person image URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-response"
            }
        },
        "byPersonNumber":{
            "title":"Commented by Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Commented by person number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeCount":{
            "title":"Like Count",
            "type":"integer",
            "description":"Like count for the comment in conversations for active and completed learners for the learning item.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "commentStatus":{
            "title":"Comment Status",
            "maxLength":30,
            "type":"string",
            "description":"Learner comment status in conversations for active and completed learners for the learning item. Valid values are defined in the list CommentStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "replyCount":{
            "title":"Reply Count",
            "type":"integer",
            "description":"Reply count for the comment in conversations for active and completed learners for the learning item.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "replies":{
            "title":"Replies",
            "type":"array",
            "description":"The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-response"
            }
        },
        "commentDate":{
            "title":"Commented on Date",
            "type":"string",
            "description":"Date of the comment in conversations for active and completed learners for the learning item.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "commentStatusMeaning":{
            "title":"Comment Status Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description for the commentStatus attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "commentId":{
            "title":"Comment ID",
            "type":"integer",
            "description":"Unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "commentLikedByCurrentUser":{
            "type":"string",
            "description":"Indicates whether the signed in person liked the comment. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.",
            "nullable":true,
            "default":"ORA_LEARNER",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "comment":{
            "title":"Comment",
            "maxLength":4000,
            "type":"string",
            "description":"Comment of the learner in conversations for active and completed learners for the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "byPersonId":{
            "title":"Commented by Person ID",
            "type":"integer",
            "description":"Commented by person identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "likes":{
            "title":"Likes",
            "type":"array",
            "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-response"
    }
}

Nested Schema : Likes

Type: array

Title: Likes

The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-response

{
    "title":"Likes",
    "type":"array",
    "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-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 : Replies

Type: array

Title: Replies

The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-response

{
    "title":"Replies",
    "type":"array",
    "description":"The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-response"
    }
}

Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false, and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Identifier for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number to identify the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  String representation of the JSON object used to retrieve a file attachment programmatically.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

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

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

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

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : 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 : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-response

Type: object

Show Source

• byPersonDisplayName: string
  Title: Liked By

  Read Only: true

  Maximum Length: 240

  Liked by person display name.
• byPersonId: integer (int64)
  Title: Liked by Person ID

  Read Only: true

  Liked by person identifier.
• byPersonImageURL: string
  Title: Liked by Person Image URL

  Read Only: true

  Maximum Length: 4000

  Liked by person image URL.
• byPersonNumber: string
  Title: Liked by Person Number

  Read Only: true

  Maximum Length: 30

  Liked by person number.
• likeDate: string (date-time)
  Title: Liked on Date

  Read Only: true

  Date of the like on a comment.
• likeId: integer (int64)
  Title: Like ID

  Unique identifier of the like.
• likeStatus: string
  Title: Like Status

  Maximum Length: 30

  Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.
• likeStatusMeaning: string
  Title: Like Status Description

  Read Only: true

  Description for the likeStatus attribute value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "byPersonDisplayName":{
            "title":"Liked By",
            "maxLength":240,
            "type":"string",
            "description":"Liked by person display name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonImageURL":{
            "title":"Liked by Person Image URL",
            "maxLength":4000,
            "type":"string",
            "description":"Liked by person image URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonNumber":{
            "title":"Liked by Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Liked by person number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "likeDate":{
            "title":"Liked on Date",
            "type":"string",
            "description":"Date of the like on a comment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeId":{
            "title":"Like ID",
            "type":"integer",
            "description":"Unique identifier of the like.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "likeStatusMeaning":{
            "title":"Like Status Description",
            "type":"string",
            "description":"Description for the likeStatus attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeStatus":{
            "title":"Like Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "byPersonId":{
            "title":"Liked by Person ID",
            "type":"integer",
            "description":"Liked by person identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-response

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
• byPersonDisplayName: string
  Title: Replied By

  Read Only: true

  Maximum Length: 240

  Replied by person display name.
• byPersonId: integer (int64)
  Title: Replied by Person ID

  Read Only: true

  Replied by person identifier.
• byPersonImageURL: string
  Title: Replied by Person Image URL

  Read Only: true

  Maximum Length: 4000

  Replied by person image URL.
• byPersonNumber: string
  Title: Replied by Person Number

  Read Only: true

  Maximum Length: 30

  Replied by person number.
• comment: string
  Title: Comment

  Maximum Length: 4000

  Reply comment of the learner on a comment.
• commentDate: string (date-time)
  Title: Replied on Date

  Read Only: true

  Date of the reply on a comment.
• commentId: integer (int64)
  Title: Comment ID

  Read Only: true

  Unique identifier of the comment.
• commentLikedByCurrentUser: string
  Read Only: true

  Indicates whether the signed in person liked the comment. Valid values are Y and N. The default value is N.
• dataSecurityPrivilege: string
  Title: Data Security Privilege

  Default Value: ORA_LEARNER

  Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
• likeCount: integer (int32)
  Title: Like Count

  Read Only: true

  Like count for the reply on a comment.
• likes: array Likes
  Title: Likes

  The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• replyStatus: string
  Title: Reply Status

  Maximum Length: 30

  Status of the reply on a comment. Valid values are defined in the list ReplyStatusLOV.
• replyStatusMeaning: string
  Title: Reply Status Description

  Read Only: true

  Maximum Length: 4000

  Description for the replyStatus attribute value.

{
    "type":"object",
    "properties":{
        "byPersonDisplayName":{
            "title":"Replied By",
            "maxLength":240,
            "type":"string",
            "description":"Replied by person display name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonImageURL":{
            "title":"Replied by Person Image URL",
            "maxLength":4000,
            "type":"string",
            "description":"Replied by person image URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-response"
            }
        },
        "byPersonNumber":{
            "title":"Replied by Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Replied by person number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeCount":{
            "title":"Like Count",
            "type":"integer",
            "description":"Like count for the reply on a comment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "replyStatusMeaning":{
            "title":"Reply Status Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description for the replyStatus attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "commentDate":{
            "title":"Replied on Date",
            "type":"string",
            "description":"Date of the reply on a comment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "commentId":{
            "title":"Comment ID",
            "type":"integer",
            "description":"Unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "commentLikedByCurrentUser":{
            "type":"string",
            "description":"Indicates whether the signed in person liked the comment. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "replyStatus":{
            "title":"Reply Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the reply on a comment. Valid values are defined in the list ReplyStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.",
            "nullable":true,
            "default":"ORA_LEARNER",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "comment":{
            "title":"Comment",
            "maxLength":4000,
            "type":"string",
            "description":"Reply comment of the learner on a comment.",
            "nullable":true,
            "x-queryable":true
        },
        "byPersonId":{
            "title":"Replied by Person ID",
            "type":"integer",
            "description":"Replied by person identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "likes":{
            "title":"Likes",
            "type":"array",
            "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-response"
    }
}

Nested Schema : Likes

Type: array

Title: Likes

The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.

Show Source

• Array of: object learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-response

{
    "title":"Likes",
    "type":"array",
    "description":"The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-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 : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false, and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Identifier for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number to identify the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  String representation of the JSON object used to retrieve a file attachment programmatically.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

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

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

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

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

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

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : 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 : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-response

Type: object

Show Source

• byPersonDisplayName: string
  Title: Liked By

  Read Only: true

  Maximum Length: 240

  Liked by person display name.
• byPersonId: integer (int64)
  Title: Liked by Person ID

  Read Only: true

  Liked by person identifier.
• byPersonImageURL: string
  Title: Liked by Person Image URL

  Read Only: true

  Maximum Length: 4000

  Liked by person image URL.
• byPersonNumber: string
  Title: Liked by Person Number

  Read Only: true

  Maximum Length: 30

  Liked by person number.
• likeDate: string (date-time)
  Title: Liked on Date

  Read Only: true

  Date of the like on a comment.
• likeId: integer (int64)
  Title: Like ID

  Unique identifier of the like.
• likeStatus: string
  Title: Like Status

  Maximum Length: 30

  Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.
• likeStatusMeaning: string
  Title: Like Status Description

  Read Only: true

  Description for the likeStatus attribute value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "byPersonDisplayName":{
            "title":"Liked By",
            "maxLength":240,
            "type":"string",
            "description":"Liked by person display name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonImageURL":{
            "title":"Liked by Person Image URL",
            "maxLength":4000,
            "type":"string",
            "description":"Liked by person image URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonNumber":{
            "title":"Liked by Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Liked by person number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "likeDate":{
            "title":"Liked on Date",
            "type":"string",
            "description":"Date of the like on a comment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeId":{
            "title":"Like ID",
            "type":"integer",
            "description":"Unique identifier of the like.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "likeStatusMeaning":{
            "title":"Like Status Description",
            "type":"string",
            "description":"Description for the likeStatus attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeStatus":{
            "title":"Like Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the like on a comment. Valid values are defined in the list LikeStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "byPersonId":{
            "title":"Liked by Person ID",
            "type":"integer",
            "description":"Liked by person identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

CommentStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_SOCIAL_EVT_STATUS

The list of values for the comment status.

The following properties are defined on the LOV link relation:

• Source Attribute: commentStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

attachments

Operation: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments

Parameters:

• activeLearnerCommentsUniqID2: $request.path.activeLearnerCommentsUniqID2
• completionDetailsUniqID: $request.path.completionDetailsUniqID
• learnerLearningRecordsUniqID: $request.path.learnerLearningRecordsUniqID
• selectedCourseOfferingsUniqID: $request.path.selectedCourseOfferingsUniqID

The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.

likes

Operation: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes

Parameters:

• activeLearnerCommentsUniqID2: $request.path.activeLearnerCommentsUniqID2
• completionDetailsUniqID: $request.path.completionDetailsUniqID
• learnerLearningRecordsUniqID: $request.path.learnerLearningRecordsUniqID
• selectedCourseOfferingsUniqID: $request.path.selectedCourseOfferingsUniqID

The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.

replies

Operation: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies

Parameters:

• activeLearnerCommentsUniqID2: $request.path.activeLearnerCommentsUniqID2
• completionDetailsUniqID: $request.path.completionDetailsUniqID
• learnerLearningRecordsUniqID: $request.path.learnerLearningRecordsUniqID
• selectedCourseOfferingsUniqID: $request.path.selectedCourseOfferingsUniqID

The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.

Back to Top