Get an attachment for a registered public user account
get
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
Request
Path Parameters
-
DocumentKey: 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 : publicSectorWebformAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the web form attached document. -
AttachmentEntityName(optional):
string
Maximum Length:
255
The unique name given to a web form attachment that is used by the attachment component. -
AttachmentId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
AttachmentIdXref(optional):
integer(int64)
The cross-reference transaction's attachment identifier.
-
AttachmentType:
string
Maximum Length:
15
The attachment type. The value is WRF, which is used for web form attachments. -
AttachmentTypeXref(optional):
string
Maximum Length:
15
The cross-reference transaction's attachment type. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The user who created the attachment. -
CreatedByName(optional):
string
Title:
Uploaded By
The name of the user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The data and time when the attachment was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the attached file. -
DocumentKey(optional):
integer(int64)
The unique identifier for the attached document.
-
FileName(optional):
string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize(optional):
integer(int64)
Title:
File Size
The size of the attached file. -
FileType(optional):
string
Maximum Length:
100
The type of the attached file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The data and time when the attachment was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the attachment. -
links(optional):
array Items
Title:
Items
Link Relations -
LogMessageId(optional):
integer(int64)
The unique identifier to store the log message ID information. This ID is automatically generated by the application.
-
UpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version(optional):
integer(int32)
The attachment revision number.
-
WebformAttachmentId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
WebformId(optional):
integer(int64)
The web form details applied to the file attachment.
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.