Get all attachments
get
/fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/attachments
Request
Path Parameters
-
NewItemRequestId(required): integer
Value that uniquely identifies the new item request.
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 attachments according to the primary key.
Finder Variables:- AttachedDocumentId; integer; Value that uniquely identifies the attachment of a new item request. This attribute is a primary key.
- PrimaryKey: Finds 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 attachment.
- CategoryName; string; Category of the attachment.
- CreatedBy; string; User who created the attachment.
- CreatedByUserName; string; Login that the user used when creating the attachment for the change object.
- CreationDate; string; Date when the user created the attachment.
- DatatypeCode; string; Abbreviation that identifies the data type of the attachment.
- DmDocumentId; string; Value that uniquely identifies the attached document.
- DmFolderPath; string; Repository folder path of the attachment.
- DmVersionNumber; string; Number that identifies the version of the attached document.
- ExpirationDate; string; Date when the attachment expires.
- FileName; string; File name of the attachment.
- LastUpdateDate; string; Date and time when the attached document was most recently updated.
- LastUpdatedBy; string; Login of the user who most recently updated the attached document.
- LastUpdatedByUserName; string; Login that the user used when updating the attachment for the change object.
- Uri; string; URI (Uniform Resource Identifier) of the attachment.
- Url; string; URL (Uniform Resource Locator) of the attachment.
- UserName; string; Login that the user used when adding the attachment.
-
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(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 : newItemRequests-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 : newItemRequests-attachments-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
Value that uniquely identifies the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the change object. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached file. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
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
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the file attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) 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
Date and time when the attached document was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the change object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding the attachment.
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/newItemRequests/NewItemRequestId/child/attachments"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AttachedDocumentId": 300100185232325, "LastUpdateDate": "2019-04-17T09:57:43.069+00:00", "LastUpdatedBy": "PIMQA", "DatatypeCode": "FILE", "FileName": "gesun2.jpg", "DmFolderPath": null, "Url": null, "CategoryName": "MISC", "UserName": "Miscellaneous", "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a114549?XFND_SCHEME_ID=1&XFND_CERT_FP=F49039C2CD07BD7DA2FA95DE445FFD10FB91B2E2&XFND_RANDOM=-6109106188158487087&XFND_EXPIRES=1555495717497&XFND_SIGNATURE=UPOoyxQnCIMJRHC0wFVJpRZCD4Mo7CdQknGAKfzJN6a5vBfVY2PvxnIcOcKJaYRE1Ed7zXTYUaFLJJ6-i1YIPOEFJ3YsypAUcWBvZ5B1~DIH9RHAPI7a-pOhbLVlGoqe6E~F9KHJDqP5X5H~UHb~~cMA7Cz2ni5j2XgIYTtq~YYOq~qA4aHf4IPh019SsYp0ZkAG4GCKL72c1hlFkRVScuxNrnNIRRNXbbIC6s41tQA0DGKX2AozSHONn41bZa1UxXI6ldxqpJMadSBA12Roy5FG7eDU-yqSERIEdHzTt0xeDIMGgkzCEWJBO1z8Le6lpnxFjXD1JRyNBkX2EnJ3OA__&Id=114549&download", "UploadedText": null, "UploadedFileContentType": "image/jpeg", "UploadedFileLength": 2506, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "gesun2.jpg", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "PIMQA", "CreationDate": "2019-04-17T09:57:40.737+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "PIMQA", "CreatedByUserName": "PIMQA", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321/child/attachments/00020000000EACED00057708000110F084F013C50000000EACED00057708000110F084F013C4", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321/child/attachments/00020000000EACED00057708000110F084F013C50000000EACED00057708000110F084F013C4", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321", "name": "newItemRequests", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321/child/attachments/00020000000EACED00057708000110F084F013C50000000EACED00057708000110F084F013C4/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] }, { "AttachedDocumentId": 300100185232323, "LastUpdateDate": "2019-04-17T09:57:42.194+00:00", "LastUpdatedBy": "PIMQA", "DatatypeCode": "FILE", "FileName": "gesun1.jpg", "DmFolderPath": null, "Url": null, "CategoryName": "MISC", "UserName": "Miscellaneous", "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a114548?XFND_SCHEME_ID=1&XFND_CERT_FP=F49039C2CD07BD7DA2FA95DE445FFD10FB91B2E2&XFND_RANDOM=-3428013688553678585&XFND_EXPIRES=1555495717608&XFND_SIGNATURE=Q-tylX0gPbpowvkD~GMGUjdQ6Ld1SeH2vET1JWLAlKjb3HzzDDcImT-yYYHI2T0PGcgFeHEa2itkUyNSosueBsdtn0JdAnjrZosNFAPyvWUqnlAB0iYiNrBa1eb9PjRGcDTuql06xn2gGNfXoMZGYlpeC5x2fmiLEWoql0n6MBlQLd9iM-T2aDQMUPualVDXBlt1p7JS3tu6xivfuN~uy5hChZ56xsoop4CgQIPp22p0EgvN3~SCzM2HNCaXW7a8~WGToxYUkN4RYgFIJGkaeo9YGXO29-FqWMnV1vU87ix8I6NAET8enOuLeivQzQmRZwHlDOuIZBlLruQangs1vg__&Id=114548&download", "UploadedText": null, "UploadedFileContentType": "image/jpeg", "UploadedFileLength": 2506, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "gesun1.jpg", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "PIMQA", "CreationDate": "2019-04-17T09:57:40.727+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "PIMQA", "CreatedByUserName": "PIMQA", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321/child/attachments/00020000000EACED00057708000110F084F013C30000000EACED00057708000110F084F013C2", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321/child/attachments/00020000000EACED00057708000110F084F013C30000000EACED00057708000110F084F013C2", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321", "name": "newItemRequests", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321/child/attachments/00020000000EACED00057708000110F084F013C30000000EACED00057708000110F084F013C2/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100185232321/child/attachments", "name": "attachments", "kind": "collection" }] }