Search documentation
karat

+

K

User Documentation ↗

Add property to object

POST/api/gotham/v1/objects/{primaryKey}/properties

Add a new property value to an existing object.

Path parameters

primaryKey
string

The primary key of the object to add a property to.

Request body

AddPropertyRequest
object

Adds a property to an existing object. This is similar but different from an initial creation in that it does require security to be specified.

Hide child attributes

Hide child attributes

propertyType
string

The name of the property in the API - also called the Property Type URI.

value
any

Represents the value of a property. The following table provides expected representations of scalar data types:

TypeJSON encodingExample
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Integernumber238940
Longstring"58319870951433"
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
security
object

Security mutation details for a component of an object - property, media, link. Specifying security overrides the system's default security when creating and updating data. If portion markings are specified, permissions may be specified. If portion markings are not specified, permissions must be specified.

This model may evolve over time for other security features.

Show child attributes

Show child attributes

portionMarkings
list<PortionMarking>
optional

Collection of classification portion markings; markings are validated against the system's Classification Based Access Control (CBAC) rules.

If invalid, an InvalidClassificationPortionMarkings error will be thrown.

If not specified, no markings will be applied.

Show child attributes

Show child attributes

PortionMarking
string

Security markings represent the level of access control that applies to a specific piece of information (e.g., object property, object title). Security markings are required upon creating a new object, and upon adding a new property to an existing object. To access information with one or more markings, the user must have access to the markings associated with that information as defined by your organization's defined security rules. Only users with the correct permissions can get, update, or delete a property with security markings.

In particular, if a user creates an object and adds a property of type with highly restricted markings, it is possible that subsequent calls to the get object properties endpoint may fail to display the highly restricted property.

Contact your Palantir administrator for more information on the markings that your organization uses.

permissions
list<PermissionItem>
optional

An optional mapping of groups to permissions allowed for the group. If not specified, the system's default is for the Everyone group to have WRITE permission, and the Administrators group to have OWNER permission.

A user will get the highest permission of any of the group they belong to. If portion markings are specified, the user must have access to all the markings specified before these permissions are applied.

Show child attributes

Show child attributes

PermissionItem
object

A mapping of a group to a permission.

Show child attributes

Show child attributes

group
object

A qualified group name as used when defining permissions. A group contains a name, and optionally a realm. The realm is required for external groups.

Show child attributes

Show child attributes

name
string

The base name of the group.

realm
string
optional

The realm of the group. Empty for internal groups.

permission
string (enum)

A permission, one of READ, WRITE, or OWNER. Each successive permission implies the previous ones, so WRITE implies READ, and OWNER implies READ and WRITE.

Enum values: READ, WRITE, OWNER

Response body

EmptySuccessResponse
object

Success response

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/gotham/v1/objects/ri.gotham.111111-0.object-internal.111111/properties" \ -d '{"propertyType":"com.palantir.property.name","value":{"FIRST_NAME":"John","LAST_NAME":"Smith"},"security":{"portionMarkings":["SENSITIVE"]}}'