List property formats

1 min

GET

/_cms/v1/propertyformats

List all property formats using the provided options.

Query Parameters

pageIndexinteger<int32>
Description
Zero based index of the page that should be retrieved.
Format
int32
Minimum
0
Maximum
10000
pageSizeinteger<int32>
Description
The maximum items per page that should be retrieved.
Format
int32
Minimum
1
Maximum
10000

Responses

200OK

PropertyFormatPage
Description
Represents a single page of items in a paged collection, including paging metadata such as the current page index, page size, and an estimated total item count.
- itemsPropertyFormat[]
  Description
  The items in this paged collection.
  - keystring
    Description
    The unique identifier (key) of the resource.
    Min Length
    2
    Max Length
    255
    Pattern
    ^[A-Za-z][_0-9A-Za-z]+$
  - dataTypestring<string | url | boolean | integer | float | dateTime | contentReference | content | link | richText | json | array | component>
    Description
    The underlying data type used for this PropertyFormat.
    Allowed
    stringurlbooleanintegerfloatdateTimecontentReferencecontentlinkrichTextjsonarraycomponent
  - itemTypestring<string | url | boolean | integer | float | dateTime | contentReference | content | link | richText | json | array | component>
    Description
    The underlying item type used for this property format. Specifies the item type when the dataType is 'array'.
    Allowed
    stringurlbooleanintegerfloatdateTimecontentReferencecontentlinkrichTextjsonarraycomponent
  - displayNamestring
    Description
    The display name of this PropertyFormat.
  - isDeletedboolean
    Description
    Indicates if this property format has been deleted.
  - createdstring<date-time>
    Description
    A timestamp indicating when this display template was first created.
    Format
    date-time
  - createdBystring
    Description
    The username of the user that created this display template.
  - lastModifiedstring<date-time>
    Description
    A timestamp indicating when this display template was last modified.
    Format
    date-time
  - lastModifiedBystring
    Description
    The username of the user that last modified this display template.
- pageIndexinteger<int32>
  Description
  The zero-based index of the current page.
  Format
  int32
- pageSizeinteger<int32>
  Description
  The number of items in each page. Not necessarily the same as the number of items in this page.
  Format
  int32
- totalCountinteger<int32>
  Description
  The estimated total number of items in the collection. May be omitted if the total count is unknown.
  Format
  int32

401Unauthorized

403Forbidden

500Internal Server Error

curl

curl --request GET \
     --url /_cms/v1/propertyformats \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/_cms/v1/propertyformats", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/_cms/v1/propertyformats")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/_cms/v1/propertyformats"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "items": [
    {
      "key": "",
      "dataType": "",
      "itemType": "",
      "displayName": "",
      "isDeleted": false,
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": ""
    }
  ],
  "pageIndex": "",
  "pageSize": "",
  "totalCount": ""
}

401

// Unauthorized

403

// Forbidden

500

// Internal Server Error