Get a mapping attachment's file-related information

get

/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{MappingAttachmentAccessorUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Mapping Attachment Accessors resource and used to uniquely identify an instance of Mapping Attachment Accessors. The client should not generate the hash key value. Instead, the client should query on the Mapping Attachment Accessors collection resource in order to navigate to a specific instance of Mapping Attachment Accessors to get the hash key.
  • The unique identifier associated with the Data Format Exchange mapping attachment.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorMappingAttachments-MappingAttachmentAccessor-item-response
Type: object
Show Source
  • Title: Asynchronous Upload Tracker Id
    Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
  • Title: Attached Document Id
    The unique identifier of the attachment document.
  • Mapping Attachment Revisions
    Title: Mapping Attachment Revisions
    The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.
  • Title: Category
    Maximum Length: 30
    The unique name given to the mapping attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.
  • Title: Shared
    Indicates whether the attached file repository is shared. The default value is false.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    The user who created the attachment.
  • Title: Created By User Name
    Read Only: true
    The user who created the attachment.
  • Title: Creation Date
    Read Only: true
    The date and time when the attachment was created.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    The datatype code of the attachment.
  • Title: Description
    Maximum Length: 255
    The description of the attachment.
  • Maximum Length: 255
    The document ID from which the attachment is created.
  • Title: Dm Folder Path
    Maximum Length: 1000
    The folder path of the attached file.
  • Maximum Length: 255
    The document version number from which the attachment is created.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    The code that indicates the error status of the attachment.
  • Title: Error Status Message
    The message that describes the error status of the attachment.
  • Title: Expiration Date
    The date of expiration of the attachment.
  • Title: File Contents
    The core attachments API has been restructured and this attribute is no longer supported for attachments insert functionality. Use these attributes instead: UploadedFileContentType, UploadedFileLength, and UploadedFileName. See Document 3034288.1 in My Oracle Support.
  • Title: File Name
    Maximum Length: 2048
    The name of the attached file.
  • Title: File Url
    The URL or web address of the attached file.
  • 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.
  • Title: Last Update Date
    Read Only: true
    The date and time when the attachment was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    The user who last updated the attachment.
  • Title: Last Updated By User
    Read Only: true
    The user who last updated the attachment.
  • Links
  • Title: PostProcessingAction
    The name of the action that can be performed after an attachment is uploaded.
  • Title: Title
    The title of the attachment.
  • Title: Uploaded File Content Type
    The content type of the attachment, such as text/plain or csv. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
  • Title: File Size
    The file length of the attachment in bytes. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
  • Title: Uploaded File Name
    The name of the attached file. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
  • Title: Uploaded Text
    The text that is entered along with the attachment.
  • Title: Uri
    Maximum Length: 4000
    The type of universal resource identifier (URI) associated with the attachment. For example, URL.
  • Title: Url
    Maximum Length: 4000
    The URL associated with an attachment.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    The user's unique user name for logging into the system.
Nested Schema : Mapping Attachment Revisions
Type: array
Title: Mapping Attachment Revisions
The mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.
Show Source
Nested Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item-response
Type: object
Show Source
Back to Top