Metadata mechanism

You can retrieve the resources metadata using resourceType in a GET request:

GET /profileAndServices/resourceType/<resourceName>

The response returns the main metadata from the resource (all other fields are descriptive or internal):

  • The Content node returns the resource’s fields. For each field in the content node, we can find the following fields:

    • “apiName”: name of the attribute used in the APIs.

    • “type”: this is the high-level type definition (string, number, link, collection, enumeration…).

    • “dataPolicy”: the value of the field must follow the given policy rules. For example, if dataPolicy rule is set to “email”, the value must be a valid email. During a PATCH or a POST, the dataPolicy can check the value or modify the value to transform (smartCase for example).

    • “category”: gives the category of the field in the query editor.

    • “resType”: this the technical type.

      If “type” is completed with the value “link” or “collection”, the resTarget value is the name of the resource targeted by the link.
      If “type” is completed with the value “enumeration”, a “values” field is added and each enumeration value are detailed in the values node.

  • The Filters node returns the URL to retrieve the associated filters. For more on filters, refer to this section section.

Sample request

Perform a GET request on the resource.

-X GET<ORGANIZATION>/campaign/profileAndServices/resourceType/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

It returns the complete description of the profile resource.

"content": {
  "email": {...},
"data": "/profileAndServices/profile/",
"filters": {
        "href": "<ORGANIZATION>/campaign/profileAndServices/resourceType/<PKEY>"
"help": "Identified profiles",
"href": "<ORGANIZATION>/campaign/profileAndServices/profile/metadata",
"label": "Profiles",
"mandatory": false,
"name": "profile",
"pkgStatus": "never",
"readOnly": false,
"schema": "nms:recipient",
"type": "item"

On this page