API Reference

Get Attachment Property By Rid

GET/api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}

Get the metadata of a particular attachment in an attachment list.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read.

Path parameters

ontology

string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

objectType

string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.

primaryKey

string

The primary key of the object containing the attachment.

property

string

The API name of the attachment property. To find the API name for your attachment, check the Ontology Manager or use the Get object type endpoint.

attachmentRid

string

The RID of the attachment.

Query parameters

artifactRepository

string

optional

The repository associated with a marketplace installation.

packageName

string

optional

The package name of the generated SDK.

Response body

AttachmentV2

object

Success response.

Hide child attributes

rid

string

The unique resource identifier of an attachment.

filename

string

The name of a File within Foundry. Examples: my-file.txt, my-file.jpg, dataframe.snappy.parquet.

sizeBytes

string

The size of the file or attachment in bytes.

mediaType

string

The media type of the file or attachment. Examples: application/json, application/pdf, application/octet-stream, image/jpeg

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/50030/attachments/performance/ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"

Response

Copied!

{
  "rid": "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f",
  "filename": "My Image.jpeg",
  "sizeBytes": 393469,
  "mediaType": "image/jpeg"
}