Download a file associated with a child object
get/documents/{objectTypeName}/{objectId}/children/{childDocType}/{childDocId}/files/{fileId}/content
Downloads the file with the specified ID from the child object that is specified in the path.
Name | Type | Required | Description |
---|---|---|---|
childDocId | string | true | The ID of the child document. |
childDocType | string | true | The name of the child document type to which the child document belongs. |
fileId | string | true | The ID of the file. |
objectId | string | true | The ID of the parent object. |
objectTypeName | string | true | The name of the parent object type to which the parent object belongs. |
Name | Type | Required | Description |
---|---|---|---|
changeContentDisposition | boolean | false | A true value sets an 'inline' value in the Content-Disposition header. A false value sets an 'attachment' value in the Content-Disposition header. Default: false |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The request succeeded. The file with the specified file ID was returned. | Headers | Schema |
400 | Bad Request | The request failed. One or more of the following conditions could have caused the failure: the parent object type name was null or empty, the parent object ID was null or empty, the child document type name was null or empty, the child document ID was null or empty, or the file location was invalid. | Schema | |
404 | Not Found | The request failed. One or more of the following conditions could have caused the failure: the parent object does not exist, the child object does not exist, the user does not have the correct permissions to view the object, the file with the given ID does not exist, or the file association is a link to an external file. External files cannot be downloaded via this endpoint. | Schema |