Jump to

• Request
• Response

Update a related materials item

patch

/hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/relatedMaterials/{relatedMaterialsUniqID}

Request

Path Parameters

• digitalLearningUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the (digitalLearning) resource and used to uniquely identify an instance of (digitalLearning). The client should not generate the hash key value. Instead, the client should query on the (digitalLearning) collection resource in order to navigate to a specific instance of (digitalLearning) to get the hash key.
• relatedMaterialsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the (relatedMaterials) resource and used to uniquely identify an instance of (relatedMaterials). The client should not generate the hash key value. Instead, the client should query on the (relatedMaterials) collection resource in order to navigate to a specific instance of (relatedMaterials) 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• relatedMaterialsBinaries: array Related Materials Binaries
  Title: Related Materials Binaries

  Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "relatedMaterialsBinaries":{
            "title":"Related Materials Binaries",
            "type":"array",
            "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-relatedMaterials-relatedMaterialsBinaries-item-patch-request"
            }
        }
    }
}

Nested Schema : Related Materials Binaries

Type: array

Title: Related Materials Binaries

Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object digitalLearning-relatedMaterials-relatedMaterialsBinaries-item-patch-request

{
    "title":"Related Materials Binaries",
    "type":"array",
    "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-relatedMaterials-relatedMaterialsBinaries-item-patch-request"
    }
}

Nested Schema : digitalLearning-relatedMaterials-relatedMaterialsBinaries-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• 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

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  User name of the person who uploaded the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Description of the attachment.
• DmFolderPath: string
  Maximum Length: 1000

  Surrogate identifier of the document attached.
• DmVersionNumber: string
  Maximum Length: 255

  The folder path from which the attachment is created.
• DownloadInfo: string
  Version number of the attachment.
• ErrorStatusCode: string
  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusMessage: string
  The error status code, if any, for the attachment.
• ExpirationDate: string (date-time)
  The error message, if any, for the attachment.
• FileContents: string (byte)
  Expiration date of the attachment. This is a read-only attribute.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Actual content of the attachment.
• FileUrl: string
  Name of the attachment file.
• PostProcessingAction: string
  Title: PostProcessingAction
• Title: string
  Title: Title

  User name of the user who last updated the attachment.
• UploadedFileContentType: string
  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Size of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Name of the uploaded file. This is a read-only attribute.
• Uri: string
  Maximum Length: 4000

  Text uploaded in the attachment.
• Url: string
  Maximum Length: 4000

  URI of the attachment. This is a read-only attribute.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded 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":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Actual content of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UploadedText":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

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 : digitalLearning-relatedMaterials-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• relatedMaterialsBinaries: array Related Materials Binaries
  Title: Related Materials Binaries

  Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "relatedMaterialsBinaries":{
            "title":"Related Materials Binaries",
            "type":"array",
            "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/digitalLearning-relatedMaterials-relatedMaterialsBinaries-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 : Related Materials Binaries

Type: array

Title: Related Materials Binaries

Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object digitalLearning-relatedMaterials-relatedMaterialsBinaries-item-response

{
    "title":"Related Materials Binaries",
    "type":"array",
    "description":"Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/digitalLearning-relatedMaterials-relatedMaterialsBinaries-item-response"
    }
}

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 : digitalLearning-relatedMaterials-relatedMaterialsBinaries-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Attribute provided by the Attachment UI components to support the upload of files.
• AttachedDocumentId: integer (int64)
  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• 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
  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Read Only: true

  User name of the user who created the attachment.
• CreationDate: string (date-time)
  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  User name of the person who uploaded the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Description of the attachment.
• DmFolderPath: string
  Maximum Length: 1000

  Surrogate identifier of the document attached.
• DmVersionNumber: string
  Maximum Length: 255

  The folder path from which the attachment is created.
• DownloadInfo: string
  Version number of the attachment.
• ErrorStatusCode: string
  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusMessage: string
  The error status code, if any, for the attachment.
• ExpirationDate: string (date-time)
  The error message, if any, for the attachment.
• FileContents: string (byte)
  Expiration date of the attachment. This is a read-only attribute.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Actual content of the attachment.
• FileUrl: string
  Name of the attachment file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  File URL of the attachment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Date when attachment record was last updated.
• LastUpdatedByUserName: string
  Read Only: true

  Name of the user who last updated the attachment record.
• links: array Links
  Title: Links

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

  User name of the user who last updated the attachment.
• UploadedFileContentType: string
  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Size of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Name of the uploaded file. This is a read-only attribute.
• Uri: string
  Maximum Length: 4000

  Text uploaded in the attachment.
• Url: string
  Maximum Length: 4000

  URI of the attachment. This is a read-only attribute.
• UserName: string
  Read Only: true

  Maximum Length: 255

  URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "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":"User name of the person who uploaded 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":"Actual content of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"File URL of the attachment.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"User name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "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":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Date when attachment record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UploadedText":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of 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"
    }
}

Links

RelatedMaterialsVisibilityLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LRN_ATTACH_VISIBILITY

The following properties are defined on the LOV link relation:

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

relatedMaterialsBinaries

Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/relatedMaterials/{relatedMaterialsUniqID}/child/relatedMaterialsBinaries

Parameters:

• digitalLearningUniqID: $request.path.digitalLearningUniqID
• relatedMaterialsUniqID: $request.path.relatedMaterialsUniqID

Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Back to Top