Get an attachment
get
/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachments/{AttachmentKey}
Request
Path Parameters
-
AttachmentKey: integer
The key of the attachment.
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 : publicSectorIntakeAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency ID. -
AttachmentEntityName(optional):
string
The attachment entity name.
-
AttachmentId(optional):
integer(int64)
The unique identifier of the attachment.
-
AttachmentKey(optional):
integer(int64)
The key of the attachment.
-
AttachmentType:
string
Maximum Length:
15
The attachment type. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The user who created the row. -
CreatedByName(optional):
string
Title:
Uploaded By
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time when the row was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The attachment description. -
DocCategory(optional):
string
Maximum Length:
30
The document category. -
DocOriginator(optional):
string
Maximum Length:
50
The document originator. -
DocSubcategory(optional):
string
Maximum Length:
30
The document subcategory. -
FileName(optional):
string
Title:
File Name
Maximum Length:255
The filename of the attachment. -
FileSize(optional):
integer(int64)
Title:
File Size
The file size of the attachment. -
FileType(optional):
string
Maximum Length:
100
The file type of the attachment. -
IntakeAgencyId(optional):
integer(int32)
The intake agency ID.
-
IntakeAttachmentId(optional):
integer(int64)
The intake attachment ID.
-
IntakeAttachmentViewAccessor(optional):
array Attachment View Accessors
Title:
Attachment View Accessors
The intake attachments resource is used to view, create, and update intake attachments. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
TransactionKey(optional):
integer(int64)
The transaction key.
-
TransactionType(optional):
string
Maximum Length:
15
The transaction type. -
UpdatedByName(optional):
string
Title:
Last Updated By
The user who last updated the attachment. -
Version(optional):
integer(int32)
The version of the attachment.
Nested Schema : Attachment View Accessors
Type:
array
Title:
Attachment View Accessors
The intake attachments resource is used to view, create, and update intake attachments.
Show Source
Nested Schema : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-item
Type:
Show Source
object
-
AsyncTrackerId(optional):
string
Title:
Asynchronous Upload Tracker Id
The 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 attached document. -
AttachmentsRevision(optional):
array Attachment Revisions
Title:
Attachment Revisions
The attachment view accessors resource is used to view, create, and update attachments. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The user who created the record. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The user name who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
A value that indicates the data type. -
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 from which the attachment is created. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number from which the attachment is created. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents(optional):
string(binary)
Title:
File Contents
The contents of the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
The filename of the attachment. -
FileUrl(optional):
string
Title:
File Url
The URI of the file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The user name who last updated the record. -
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. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The size of the attachment file. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText(optional):
string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachment view accessors resource is used to view, create, and update attachments.
Show Source
Nested Schema : publicSectorIntakeAttachments-IntakeAttachmentViewAccessor-AttachmentsRevision-item
Type:
Show Source
object
-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of the attached document for this revision.
-
ContentId(optional):
string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode(optional):
string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage(optional):
string
The error message, if any, for the attachment revision.
-
FileUrl(optional):
string
The filename of the attachment revision.
-
Format(optional):
string
Maximum Length:
128
The format of the attachment revision. -
InDate(optional):
string(date-time)
The date of the attachment revision.
-
links(optional):
array Items
Title:
Items
Link Relations -
RevisionId(optional):
string
Maximum Length:
80
The ID of the attachment revision. -
RevLabel(optional):
string
Maximum Length:
80
The revision label of the attachment revision. -
UserRevisionId(optional):
integer(int64)
The user revision ID for the attachment revision.
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.