Get an attachment
get
/fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/batchAttachment/{batchAttachmentUniqID}
Request
Path Parameters
-
JeBatchId(required): integer(int64)
The unique identifier of the batch.
-
batchAttachmentUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Attachments resource and used to uniquely identify an instance of Attachments. The client should not generate the hash key value. Instead, the client should query on the Attachments collection resource in order to navigate to a specific instance of Attachments 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 -
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:
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 : journalBatches-batchAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The identifier for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the batch attachment. -
Category: string
Read Only:
true
Maximum Length:255
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the batch 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 when the batch attachment was created. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
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 error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment 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 when the batch attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the batch 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. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
Type: string
Maximum Length:
255
The type of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of 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
The following example shows how to retrieve an attachment.
Get all the attachments of a batch and use the self URI of the specific attachment.
Here's the cURL command to retrieve all the attachments:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"AttachedDocumentId": 300100179621397,
"LastUpdateDate": "2019-05-31T19:45:30.800+00:00",
"LastUpdatedBy": "FINUSER1",
"FileName": "Lines.bmp",
"DmFolderPath": null,
"DmDocumentId": "UCMFA00004008",
"DmVersionNumber": "4008",
"Url": null,
"Uri": null,
"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a4008?XFND_SCHEME_ID=1&XFND_CERT_FP=608AFAE1C10F7C0227D2405D40429C3C078A9B2E&XFND_RANDOM=7013168417918568866&XFND_EXPIRES=1559553701149&XFND_SIGNATURE=gtV~xRpmKTy82fQIxRSfwCDEgud3rZvgOBfpvXyIreow1XmHNsGBx~l2vP-7BYp9hBaF7HnvN5NNHGzDfFTPujdck~tI-40Gsr-mR0tO3PIjRsGEIyaZdE2Qpks23ZlaXGcaYMhTho3O6kop2mLIjv-PD7bIpH3WeycasXxGbTeoBkps8zJst0FHabpNil4uP2Kjxw5pH9A5Xqtwsil~i~u4HzMzftPZHv5SwJHE9UihCzRPXw6eLU3KdPtf8D-xd6gvP83scyvcRuhcUlemn1aGHf0~n1zjtdPrVTxbS7NM-GwozQbJAmqj2MVeBZ7wT3-3Jop0CZe4Di~08NcPzQ__&ld=4008&download",
"UploadedText": null,
"UploadedFileContentType": "image/bmp",
"UploadedFileLength": 3125934,
"UploadedFileName": null,
"ContentRepositoryFileShared": "false",
"Title": "Lines.bmp",
"Description": "",
"ErrorStatusCode": null,
"ErrorStatusMessage": null,
"CreatedBy": "FINUSER1",
"CreationDate": "2019-05-31T19:44:59.773+00:00",
"ExpirationDate": null,
"LastUpdatedByUserName": "Mary Johnson",
"CreatedByUserName": "Mary Johnson",
"Category": null,
"Type": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment/00020000000EACED00057708000110F0849A76150000000EACED00057708000110F0849A7614",
"name": "batchAttachment",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment/00020000000EACED00057708000110F0849A76150000000EACED00057708000110F0849A7614",
"name": "batchAttachment",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955",
"name": "journalBatches",
"kind": "item"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment/00020000000EACED00057708000110F0849A76150000000EACED00057708000110F0849A7614/enclosure/FileContents",
"name": "FileContents",
"kind": "other"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment",
"name": "batchAttachment",
"kind": "collection"
}
]
}
A hash key of JeBatchId
and batchAttachmentUniqID
identifies an attachment.
Here's the cURL command that uses the hash key in the self URI to retrieve the attachment:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment/00020000000EACED00057708000110F0849A76150000000EACED00057708000110F0849A7614
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AttachedDocumentId": 300100179621397, "LastUpdateDate": "2019-05-31T19:45:30.800+00:00", "LastUpdatedBy": "FINUSER1", "FileName": "Lines.bmp", "DmFolderPath": null, "DmDocumentId": "UCMFA00004008", "DmVersionNumber": "4008", "Url": null, "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a4008?XFND_SCHEME_ID=1&XFND_CERT_FP=608AFAE1C10F7C0227D2405D40429C3C078A9B2E&XFND_RANDOM=7013168417918568866&XFND_EXPIRES=1559553701149&XFND_SIGNATURE=gtV~xRpmKTy82fQIxRSfwCDEgud3rZvgOBfpvXyIreow1XmHNsGBx~l2vP-7BYp9hBaF7HnvN5NNHGzDfFTPujdck~tI-40Gsr-mR0tO3PIjRsGEIyaZdE2Qpks23ZlaXGcaYMhTho3O6kop2mLIjv-PD7bIpH3WeycasXxGbTeoBkps8zJst0FHabpNil4uP2Kjxw5pH9A5Xqtwsil~i~u4HzMzftPZHv5SwJHE9UihCzRPXw6eLU3KdPtf8D-xd6gvP83scyvcRuhcUlemn1aGHf0~n1zjtdPrVTxbS7NM-GwozQbJAmqj2MVeBZ7wT3-3Jop0CZe4Di~08NcPzQ__&ld=4008&download", "UploadedText": null, "UploadedFileContentType": "image/bmp", "UploadedFileLength": 3125934, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "Lines.bmp", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "FINUSER1", "CreationDate": "2019-05-31T19:44:59.773+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Mary Johnson", "CreatedByUserName": "Mary Johnson", "Category": null, "Type": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment/00020000000EACED00057708000110F0849A76150000000EACED00057708000110F0849A7614", "name": "batchAttachment", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment/00020000000EACED00057708000110F0849A76150000000EACED00057708000110F0849A7614", "name": "batchAttachment", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955", "name": "journalBatches", "kind": "item" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1731955/child/batchAttachment/00020000000EACED00057708000110F0849A76150000000EACED00057708000110F0849A7614/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] }