Get All Rich Text Content Metadata For Brand

This API is used to fetch rich content metadata for rewards within a brand.

Prerequisites

API Specification

Endpoint

https://{host}/api_gateway/rewards/core/v1/brand/richContentMeta

Resource Information

PropertyValue
Resource URI/api_gateway/rewards/core/v1/brand/richContentMeta
HTTP MethodGET

Query Parameters

Parameter NameTypeRequiredDescription
statusStringNoFilters the metadata by status (ACTIVE/INACTIVE)
pageintegernocannot be lesser than 0 ,
sizeintegernodefault (0,10) cannot be lesser than one , max - 50

Example Response

{
    "richContentMetaROS": [
        {
            "id": 4,
            "name": "terms&conditions-1",
            "description": "RC1_desc",
            "isMandatory": false,
            "isActive": true,
            "scope": "REWARD",
            "defaultValue": null,
            "createdBy": 75161973,
            "createdOn": 1742256000000,
            "lastUpdatedBy": 75161973,
            "lastUpdatedOn": 1742342400000
        }
    ],
    "pagingDto": {
        "last": true,
        "totalElements": 5,
        "totalPages": 1,
        "numberOfElements": 5,
        "first": true,
        "size": 10,
        "number": 0
    }
}

 

Response Parameters

Field NameDescription
idUnique identifier for the rich content metadata entry.
nameThe name of the rich content metadata.
descriptionA brief description of the rich content metadata's purpose or usage.
isMandatoryIndicates whether the rich content metadata is mandatory (true or false).
isActiveIndicates whether the rich content metadata is currently active (true or false).
scopeThe scope of the rich content metadata, indicating its context (e.g., REWARD).
defaultValueThe default value assigned to the rich content metadata if no specific value is provided.
createdByThe ID of the user who created the rich content metadata.
createdOnThe timestamp (in milliseconds) when the rich content metadata was created.
lastUpdatedByThe ID of the user who last updated the rich content metadata.
lastUpdatedOnThe timestamp (in milliseconds) when the rich content metadata was last updated.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!