Sign in
TraitGroup

Update Trait Group

Partially updates a Trait Group. Only the fields provided in the request body will be updated. For traits: existing traits with matching keys will be updated, new keys will be added. To remove a trait, set its dataType to an empty string ("") - this serves as an explicit deletion marker.

patch/v1/ControlPlane/Stores/{storeId}/TraitGroups/{traitGroupName}

Headers

If-Matchstring
Example:"eyJpZCI6ImFuX2lkIiwidiI6MX0"

Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource's current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.

Request body

descriptionstring

Updated description of the Trait Group

traitsobject

Map of traits to add, update, or remove in this Trait Group, where the key is the trait name. - To update/add a trait: provide the complete TraitDefinition object - To remove a trait: set dataType to an empty string ("")

Example request

{
  "description": "Updated Trait Group contains traits related to contact information."
}

Response

TraitGroup update request accepted for processing.

messagestring
statusUrlstring

URI to check operation status.

Example response

{
  "message": "TraitGroup update request accepted."
}

Changes

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

  • v1b0ed05460bbf51See the full diff
    • ▲

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

      response-property-max-increased

    • ▲

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

      response-property-max-increased

    • ▲

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

      response-property-max-increased

    • ▲

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

      response-property-max-increased

    • ▲

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

      response-property-max-increased

    • ○

      added the new optional request property traits/additionalProperties/validationRule

      new-optional-request-property

    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.