Get all attachments
get
/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/attachments
Request
Path Parameters
-
purchaseOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders to get the hash key.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds purchase order attachments according to the primary key.
Finder Variables:- AttachedDocumentId; integer; Value that uniquely identifies the document that is attached to the purchase order.
- PrimaryKey: Finds purchase order attachments according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AttachedDocumentId; integer; Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order.
- CategoryName; string; Category of the attached document.
- CreatedBy; string; User who created the attached document.
- CreatedByUserName; string; Login that the user used when creating the document that is attached to the purchase order.
- CreationDate; string; Date when the user created the attached document.
- DatatypeCode; string; Abbreviation that identifies the data type.
- DmDocumentId; string; Value that uniquely identifies the attached document.
- DmFolderPath; string; Folder path of the attached document.
- DmVersionNumber; string; Number that identifies the version of the attached document.
- ExpirationDate; string; Date when the content in the attached document expires.
- FileName; string; File name of the attached document.
- LastUpdateDate; string; Date and time when the user most recently updated the document that is attached to the purchase order.
- LastUpdatedBy; string; User who most recently updated the document that is attached to the purchase order.
- LastUpdatedByUserName; string; Login that the user used when updating the document that is attached to the purchase order.
- Uri; string; URI (Uniform Resource Identifier) that identifies the attached document.
- Url; string; URI (Uniform Resource Identifier) that identifies the attached document.
- UserName; string; Login that the user used when adding or modifying the attached document.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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:
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.
Root Schema : purchaseOrders-attachments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : purchaseOrders-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attached document. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attached document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document that is attached to the purchase order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attached document. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached document. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached document. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attached document. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached document. -
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
Date and time when the user most recently updated the document that is attached to the purchase order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the document that is attached to the purchase order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attached document. -
UploadedFileLength: integer
Title:
File Size
Length of the attached document. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached document. -
UploadedText: string
Title:
Uploaded Text
Text of the attached document. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attached document.
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.
Examples
This example describes how to get all attachments
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrders/purchaseOrdersUniqID/child/attachments"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AttachedDocumentId": 300100197971814, "LastUpdateDate": "2020-10-16T10:31:21.962+00:00", "LastUpdatedBy": "CVBUYER01", "DatatypeCode": "FILE", "FileName": "REST Attachment.txt", "DmFolderPath": null, "DmDocumentId": "UCMFA00023337", "DmVersionNumber": "23340", "Url": null, "CategoryName": "TO_SUPPLIER", "UserName": "To Supplier", "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a23340?XFND_SCHEME_ID=1&XFND_CERT_FP;=0A3C9E5F872EB24E37333CB5F528CEEFA1491781&XFND_RANDOM;=6658098188575980736&XFND_EXPIRES;=1603099844275&XFND_SIGNATURE;=Mr~UM9~TcvdnlHxWYME64kUsOL71e~bgxEXyBhkaj~K2vY3~QcUNySe5SMBw3Dr-rx7TPBzrAM6AANvtjY99RigyenPBvGqxzN6-oiaR76sGDLARlRsxtj3wP4zjaSAemkM6WnE1ZvS0fkInrk40fCn9DLPZ3PhjbOB5Jv2-66mGHmSuFfq24ycxwEwYk7AcKajk-GT~hAwFuyXxMI8IvBNPUaXiJTXML1fXHgkJg5MFDSFnqd193lRmKa98G8wx402GT3u~R7MYK0FeVloLBPACShQwW-Qa9RRuAHKqwLi2HUhvQZEVVfQth9Q8HKt6jYumBkdHw9zk-aaLJDAGvg__&Id;=23340&download;", "UploadedText": null, "UploadedFileContentType": "text/plain", "UploadedFileLength": 7, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "REST Attachment.txt", "Description": "Updated attachment description", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "Clare Jones", "CreationDate": "2020-10-16T10:31:21+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Clare Jones", "CreatedByUserName": "Clare Jones", "AsyncTrackerId": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/558749", "name": "purchaseOrders", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/558749/child/attachments", "name": "attachments", "kind": "collection" } ] }