Skip to main content
GET
/
content
/
propertytypes
/
{propertyTypeName}
Error
A valid request URL is required to generate request examples
{
  "name": "<string>",
  "namespace": "<string>",
  "propertyTypeFQN": "<string>",
  "adminName": "<string>",
  "installationPackage": "<string>",
  "version": "<string>",
  "dataType": "<string>",
  "isQueryable": true,
  "isSortable": true,
  "isAggregatable": true
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
propertyTypeName
string
required

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

The schema a document property value must implement. A propertyType is created at a tenant scope and is therefore shared amongst all child contexts (masterCatalog, catalog, site). A propertyType is analogous to the type argument of a class property in object oriented programming. A propertyType's dataType field is analogous to an intrinsic value type in object oriented programming, or to a column data type in relational database terminology.

​
name
string | null

The name component of the propertyType, name@namespace. The name must be unique within the namespace component and cannot be updated.

​
namespace
string | null

The namespace component of the propertyType, name@namespace. The issued dev account namespace must be used unless elevated privileges allow a blank namespace to be used. The namespace cannot be updated.

​
propertyTypeFQN
string | null

The unique identifier of the propertyTYpe, represented by name@namespace. The propertyTypeFQN must be provided when creating the propertyType, or the name and namespace fields must be provided.

​
adminName
string | null

The administrative name of the propertyType.

​
installationPackage
string | null

Optionally, a propertyType can be defined in an installationPackage and then installed into a tenant. Installed propertyTypes can only be updated via installation upgrades. Currently only internal Mozu platform components can create installations. This field is system-supplied and read-only.

​
version
string | null

The version of the installationPackge installed. This field is read-only.

​
dataType
string | null

The underlying value type that can be held in the document's property value. Valid values are string number boolean datetime json The dataType is analogous to an intrinsic value type in object oriented programming, or to a column data type in relational database terminology.

​
isQueryable
boolean | null

tbd

​
isSortable
boolean | null

tbd

​
isAggregatable
boolean | null

tbd