Jump to

• Request
• Response

Update a reply

patch

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}

Request

Path Parameters

• activeLearnerCommentsUniqID(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• commentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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.
• otherSelectedCourseOfferingsUniqID(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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

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 used to view, create, and update attachments.
• comment: string
  Title: Comment

  Maximum Length: 4000

  Learner reply to a comment.
• dataSecurityPrivilege: string
  Title: Data Security Privilege

  Default Value: ORA_LEARNER

  Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
• likes: array Likes
  Title: Likes

  The likes resource provides details of the likes for comments by active and completed learners for the learning item.
• replyStatus: string
  Title: Reply Status

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-patch-request"
            }
        },
        "comment":{
            "title":"Comment",
            "maxLength":4000,
            "type":"string",
            "description":"Learner reply to a comment.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Comment"
                }
            }
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.",
            "nullable":true,
            "default":"ORA_LEARNER",
            "x-hints":{
                "help":{
                    "instruction":"Data Security Privilege"
                }
            }
        },
        "likes":{
            "title":"Likes",
            "type":"array",
            "description":"The likes resource provides details of the likes for comments by active and completed learners for the learning item.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-patch-request"
            }
        },
        "replyStatus":{
            "title":"Reply Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the reply to a comment. Valid values are defined in the ReplyStatusLOV list.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Reply Status"
                },
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-patch-request"
    }
}

Nested Schema : Likes

Type: array

Title: Likes

The likes resource provides details of the likes for comments by active and completed learners for the learning item.

Show Source

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

{
    "title":"Likes",
    "type":"array",
    "description":"The likes resource provides details of the likes for comments by active and completed learners for the learning item.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-patch-request"
    }
}

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

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

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

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

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

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

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        }
    }
}

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

Type: object

Show Source

• likeStatus: string
  Title: Like Status

  Maximum Length: 30

  Status for the comment like. Valid values are defined in the LikeStatusLOV list.

{
    "type":"object",
    "properties":{
        "likeStatus":{
            "title":"Like Status",
            "maxLength":30,
            "type":"string",
            "description":"Status for the comment like. Valid values are defined in the LikeStatusLOV list.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Like Status"
                },
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

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

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• 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

  Learner reply to a comment.
• commentDate: string (date-time)
  Title: Replied on Date

  Read Only: true

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

  Read Only: true

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

  Indicates whether the comment was liked by the signed in user. Valid values are Y or N. Default value is N.
• dataSecurityPrivilege: string
  Title: Data Security Privilege

  Default Value: ORA_LEARNER

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

  Read Only: true

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

  The likes resource provides details of the likes for comments by active and completed learners for the learning item.
• 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 to a comment. Valid values are defined in the ReplyStatusLOV list.
• replyStatusMeaning: string
  Title: Reply Status Description

  Read Only: true

  Maximum Length: 4000

  Description of the replyStatus attribute value.

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

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

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

Nested Schema : Likes

Type: array

Title: Likes

The likes resource provides details of the likes for comments by active and completed learners for the learning item.

Show Source

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

{
    "title":"Likes",
    "type":"array",
    "description":"The likes resource provides details of the likes for comments by active and completed learners for the learning item.",
    "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 attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

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

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

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

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

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

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

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

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"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
        },
        "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
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "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
        },
        "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"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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

Type: object

Show Source

• byPersonDisplayName: string
  Title: Liked By

  Read Only: true

  Maximum Length: 240

  Display name for the comment liker.
• byPersonId: integer (int64)
  Title: Liked by Person ID

  Read Only: true

  Person identifier for the comment liker.
• byPersonImageURL: string
  Title: Liked by Person Image URL

  Read Only: true

  Maximum Length: 4000

  Image URL for the comment liker.
• byPersonNumber: string
  Title: Liked by Person Number

  Read Only: true

  Maximum Length: 30

  Person number for the comment liker.
• likeDate: string (date-time)
  Title: Liked on Date

  Read Only: true

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

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

  Maximum Length: 30

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

  Read Only: true

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

ReplyStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_SOCIAL_EVT_STATUS

The following properties are defined on the LOV link relation:

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

attachments

Parameters:

• activeLearnerCommentsUniqID2: $request.path.activeLearnerCommentsUniqID2
• commentId2: $request.path.commentId2
• completionDetailsUniqID: $request.path.completionDetailsUniqID
• learnerLearningRecordsUniqID: $request.path.learnerLearningRecordsUniqID
• otherSelectedCourseOfferingsUniqID102: $request.path.otherSelectedCourseOfferingsUniqID102

likes

Parameters:

• activeLearnerCommentsUniqID2: $request.path.activeLearnerCommentsUniqID2
• commentId2: $request.path.commentId2
• completionDetailsUniqID: $request.path.completionDetailsUniqID
• learnerLearningRecordsUniqID: $request.path.learnerLearningRecordsUniqID
• otherSelectedCourseOfferingsUniqID102: $request.path.otherSelectedCourseOfferingsUniqID102

Back to Top