TraitGroup

List Trait Groups

Returns a list of Trait Groups for this Memory Store, with optional traits information.

get/v1/ControlPlane/Stores/{storeId}/TraitGroups

Query parameters

includeTraitsboolean

Whether to include trait definitions in the response

pageSizeinteger

The maximum number of items to return per page, maximum of 100.

pageTokenstring

The token for the page of results to retrieve.

orderBy'ASC' | 'DESC'

Either 'ASC' or 'DESC' to sort results ascending or descending respectively.

Response

List of TraitGroups retrieved successfully

Example response

{
  "traitGroups": [
    {
      "displayName": "Contact",
      "description": "This Trait Group contains traits related to contact information.",
      "traits": {
        "email": {
          "dataType": "STRING",
          "description": "User's email address"
        },
        "dob": {
          "dataType": "STRING",
          "description": "User's date of birth"
        }
      },
      "version": 3
    }
  ],
  "meta": {
    "nextToken": "eyJlYXN0ZXIiOiJlZ2cifQ",
    "previousToken": "eyJlYXN0ZXIiOiJlZ2cifQ"
  }
}

Changes

Changed in 1 of the 8 revisions of this API.52

  • v1b0ed05460bbf52See the full diff
    • the response property's max was increased from 99999.00 to 999999.00 for the response status

      response-property-max-increased

    • the response property's max was increased from 99999.00 to 999999.00 for the response status

      response-property-max-increased

    • the response property's max was increased from 99999.00 to 999999.00 for the response status

      response-property-max-increased

    • the response property's max was increased from 99999.00 to 999999.00 for the response status

      response-property-max-increased

    • the response property's max was increased from 99999.00 to 999999.00 for the response status

      response-property-max-increased

    • for the query request parameter pageToken, the maxLength was increased from 500 to 4096

      request-parameter-max-length-increased

    • the response's property default value 50 was removed for the status

      response-property-default-value-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 8 revisions, 1 has no diff computed.