Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.13 KB

SelectedPropertyApiName.md

File metadata and controls

30 lines (19 loc) · 1.13 KB

SelectedPropertyApiName

By default, whenever an object is requested, all of its properties are returned, except for properties of the following types:

  • Vector

The response can be filtered to only include certain properties using the properties query parameter. Note that ontology object set endpoints refer to this parameter as select.

Properties to include can be specified in one of two ways.

  • A comma delimited list as the value for the properties query parameter properties={property1ApiName},{property2ApiName}
  • Multiple properties query parameters. properties={property1ApiName}&properties={property2ApiName}

The primary key of the object will always be returned even if it wasn't specified in the properties values.

Unknown properties specified in the properties list will result in a PropertiesNotFound error.

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

Type

str

[Back to Model list] [Back to API list] [Back to README]