Get an attachment for a registered public user account
get
/fscmRestApi/resources/11.13.18.05/publicSectorAccountAttachments/{DocumentId}
Request
Path Parameters
-
DocumentId: integer
The unique identifier for the attached document.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorAccountAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
Unique identifier for an agency. -
AttachmentEntityName(optional):
string
The unique name given to an account attachment that is used by the Attachment component.
-
AttachmentId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
AttachmentNewId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
AttachmentType:
string
Maximum Length:
15
The attachment type. The value is PBL for registered public user account management attachments. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time that the attachment was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the attachment. -
DocumentCategory(optional):
string
Maximum Length:
30
The category for an attached document. The category must be in the Document Group that is specified for registered user accounts. This Document Group is referenced by the REST publicSectorUserSetups.DocGroupId. -
DocumentId(optional):
integer(int64)
The unique identifier for the attached document.
-
DocumentSubcategory(optional):
string
Maximum Length:
30
The subcategory for an attached document. Only active subcategories for the specified document category are allowed. -
FileName(optional):
string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize(optional):
integer(int64)
Title:
File Size
The file size of the attachment. -
FileType(optional):
string
Maximum Length:
100
The type of the attachment file such as text/plain, or image/jpeg. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the attachment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the attachment. -
links(optional):
array Items
Title:
Items
Link Relations -
PblAttachmentAccessor(optional):
array Account Attachment Accessors
Title:
Account Attachment Accessors
The account attachments resource is used to view, create, delete or modify attachments to registered public user account. -
ProfileId(optional):
integer(int64)
The unique identifier for a registered public user account profile.
-
ProfileName(optional):
string
A transient field for a registered public user account profile name.
-
PscUserId(optional):
integer(int64)
The unique identifier for a registered public user reference row.
-
Version(optional):
integer(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
Nested Schema : Account Attachment Accessors
Type:
array
Title:
Account Attachment Accessors
The account attachments resource is used to view, create, delete or modify attachments to registered public user account.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorAccountAttachments-PblAttachmentAccessor-item
Type:
Show Source
object
-
AsyncTrackerId(optional):
string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId(optional):
integer(int64)
Title:
Attached Document Id
The unique identifier of the attachment document. -
AttachmentsRevision(optional):
array Account Attachment Revisions
Title:
Account Attachment Revisions
The account attachment accessor resource is used for displaying file-related information such as file name and file URL. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The unique name given to the account attachment accessors, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The user who created the attachment. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the attachment was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
The datatype code of the attachment. -
Description(optional):
string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId(optional):
string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number from which the attachment is created. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents(optional):
string(binary)
Title:
File Contents
The file contents of the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl(optional):
string
Title:
File Url
The URL or web address of the attached file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date and time that the attachment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The user who last updated the attachment. -
links(optional):
array Items
Title:
Items
Link Relations -
Title(optional):
string
Title:
Title
The title of the attachment. -
UploadedFileContentType(optional):
string
Title:
Uploaded File Content Type
The content type of the attachment such as text/plain, or csv. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText(optional):
string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL associated with an attachment. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The user's unique user name for signing in to the fusion system.
Nested Schema : Account Attachment Revisions
Type:
array
Title:
Account Attachment Revisions
The account attachment accessor resource is used for displaying file-related information such as file name and file URL.
Show Source
Nested Schema : publicSectorAccountAttachments-PblAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object
-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of an attached document.
-
ContentId(optional):
string
Maximum Length:
80
The unique identifier of the attachment content. -
ErrorStatusCode(optional):
string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage(optional):
string
The message that describes the error status of the attachment.
-
FileUrl(optional):
string
The web address for an attached file.
-
Format(optional):
string
Maximum Length:
128
The format of the attachment. -
InDate(optional):
string(date-time)
Indicates the date that the file was attached.
-
links(optional):
array Items
Title:
Items
Link Relations -
RevisionId(optional):
string
Maximum Length:
80
The unique identifier of the attachment revision. -
RevLabel(optional):
string
Maximum Length:
80
The label for an attachment revision. -
UserRevisionId(optional):
integer(int64)
The unique identifier for an attachment revision.