Get an APO attachment
get
/fscmRestApi/resources/11.13.18.05/publicSectorApoAttachments/{ApoAttachmentKey}
Request
Path Parameters
-
ApoAttachmentKey(required): integer(int64)
The unique key associated with the APO attachment.
Query Parameters
-
dependency: string
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> -
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 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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorApoAttachments-item-response
Type:
Show Source
object
-
AddressId: integer
(int64)
The unique identifier for the address associated with an attachment.
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
-
ApoAttachmentAccessor: array
APO Attachment Accessors
Title:
APO Attachment Accessors
The APO attachment accessor resource is used for displaying file-related information such as file name and file URL. -
ApoAttachmentId: integer
(int64)
The unique identifier for an attachment.
-
ApoAttachmentKey: integer
(int64)
The unique key associated with the APO attachment.
-
AttachmentEntityName: string
Maximum Length:
255
Default Value:PSC_APO_DOCUMENT
The unique name given to an APO attachment that is used by the Attachment component. -
AttachmentId: integer
(int64)
-
AttachmentType: string
Maximum Length:
15
Default Value:APO
The type of attachment. -
CreatedByName: string
Title:
Uploaded By
-
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
-
Description: string
Title:
Description
Maximum Length:100
-
DocCategory: string
Maximum Length:
30
The category used for dividing the attached document into a logical group. -
DocSubcategory: string
Maximum Length:
30
The sub category used for dividing the attached document into a logical group along with the category. -
FileName: string
Title:
File Name
Maximum Length:255
-
FileSize: integer
(int64)
Title:
File Size
-
FileType: string
Maximum Length:
100
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerId: integer
(int64)
The unique identifier of the parcel owner associated with the attachment.
-
ParcelId: integer
(int64)
The unique identifier of the parcel associated with the attachment.
-
Preview: string
(byte)
-
PreviewHeight: number
-
PreviewWidth: number
-
UpdatedByName: string
Title:
Last Updated By
-
Version: integer
(int32)
Nested Schema : APO Attachment Accessors
Type:
array
Title:
APO Attachment Accessors
The APO attachment accessor resource is used for displaying file-related information such as file name and file URL.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorApoAttachments-ApoAttachmentAccessor-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment document. -
AttachmentsRevision: array
APO Attachment Revisions
Title:
APO Attachment Revisions
The APO attachments revision resource is used for displaying the historical information for an attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The unique name given to the APO attachment accessors, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The datatype code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl: string
Title:
File Url
The URL or web address of the attached file. -
FileWebImage: string
(byte)
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. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time that the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment such as text/plain, or csv. -
UploadedFileLength: integer
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText: string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url: string
Title:
Url
Maximum Length:4000
The URL associated with an attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The name of the user who uploaded the attachment.
Nested Schema : APO Attachment Revisions
Type:
array
Title:
APO Attachment Revisions
The APO attachments revision resource is used for displaying the historical information for an attachment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorApoAttachments-ApoAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of an attached document. -
ContentId: string
Maximum Length:
80
The unique identifier of the attachment content. -
ErrorStatusCode: string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage: string
The message that describes the error status of the attachment.
-
FileUrl: string
The web address for an attached file.
-
Format: string
Maximum Length:
128
The format of the attachment. -
InDate: string
(date-time)
Indicates the date that the file was attached.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The unique identifier of the attachment revision. -
RevLabel: string
Maximum Length:
80
The label for an attachment revision. -
UserRevisionId: integer
The unique identifier for an attachment revision.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ApoAttachmentAccessor
-
Parameters:
- ApoAttachmentKey:
$request.path.ApoAttachmentKey
The APO attachment accessor resource is used for displaying file-related information such as file name and file URL. - ApoAttachmentKey: