Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Attachments > View Attachment

View Attachment

Use the View Attachment REST request to retrieve information about an attachment document.

Request

  • Production: GET https://api.zuora.com/rest/v1/attachments/{attachment-id}
  • API SandboxGET https://apisandbox-api.zuora.com/rest/v1/attachments/{attachment-id}

Request Parameter

attachment-id required Id of the attachment you want to view

Response

id Id of this attachment
fileName Attachment file name
description Description of the attachment
fileId File id of the attached file
fileContentType File type
createdOn Date and time when the attachment was added to the object
createdBy Zuora user id who added this attachment to the object
updatedOn Date and time when the attachment was last updated 
updatedBy Zuora user id who last updated the attachment
success

Returns true if the request is successful. Otherwise, returns false.

Examples

Request

GET https://api.zuora.com/rest/v1/attachments/2c92a0f94d03939e014d0d065cfb3f3e

Response

{
  "id": "8a8083e1545b706a01547316d93f4401",
  "fileName": "AttachTest.txt",
  "description": "",
  "fileId": "8a8083e1545b706a01547316d9094400",
  "fileContentType": "text/plain",
  "createdOn": "2016-05-02 13:09:17",
  "createdBy": "4028e487327fd45a0132829ebb673ff9",
  "updatedOn": "2016-05-02 13:09:17",
  "updatedBy": "4028e487327fd45a0132829ebb673ff9",
  "success": true
}

 

Last modified

Tags

This page has no custom tags.

Classifications

(not set)