API Reference

List Property Attachments

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

Get the metadata of attachments parented to the given object.

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.

Query parameters

artifactRepository

string

optional

The repository associated with a marketplace installation.

packageName

string

optional

The package name of the generated SDK.

Response body

AttachmentMetadataResponse

union

Success response.

Hide child attributes

single

object

optional

The representation of an attachment.

Show child attributes

multiple

object

optional

Show child attributes

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/50030/attachments/performance"

Response

Copied!

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