/profile/metadata/create

Creates a profile metadata entry with human-readable display name. This metadata entry refers to a named profile group. The profile group can be either a user profile group or a content profile group. The metadata entries also have the capability to bind displayName entries for items. Metadata entry can be created either at customer level at site group level or global level.

The user must be authenticated and have write permissions to the specified site group.

Admin user can bind metadata entries either globally or to any customer or site group.

Request

The request object has the following fields:

Name	Type	Required	Description
`customerId`	String	No	The id of customer where metadata entry will be created.
`siteGroupIds`	String	No	The id of site group where metadata entry will be created.
`profiles`	Array of Objects	Yes	A list of profile's metadata with display name bindings.

The profile object has the following fields:

Name	Type	Required	Description
`group`	String	Yes	User profile or content profile group name.
`groupDisplayName`	String	Yes	Human-readable display name assigned to the group.
`items`	Array of Objects	No	A list of group items metadata.

The item metadata object has the following fields:

Name	Type	Required	Description
`item`	String	Yes	User profile or content profile item name.
`itemDisplayName`	String	Yes	Human-readable display name assigned to the item.

Response

Name	Type	Required	Description
`metadata`	Array of Objects	Yes	A list of created bindings.

Metadata object has the same fields as profile object from request.

Examples

Bash

# Site group binding 
$ python cx.py /profile/metadata/create '{"siteGroupId":"1135172335968227720","profiles":[\
 {"group":"alx-id-proffesion","groupDisplayName":"proffesion","items":[\
 {"item":"alx-sci-item-01","itemDisplayName":"scientist"}\
 ]}]}'
{
 "metadata": [
 {
 "group": "alx-id-proffesion", 
 "groupDisplayName": "proffession", 
 "items": [
 {
 "item": "alx-sci-item-01", 
 "itemDisplayName": "scientist"
 }
 ]
 }
 ]
}

# Customer binding 
$ python cx.py /profile/metadata/create '{"customerId":"0c3130d72e0d68036a579e9ab4e3349116b4b6b6","profiles":[\
 {"group":"alx-id-proffesion","groupDisplayName":"proffesion","items":[\
 {"item":"alx-sci-item-01","itemDisplayName":"scientist"}\
 ]}]}'
{
 "metadata": [
 {
 "group": "alx-id-proffesion", 
 "groupDisplayName": "proffession", 
 "items": [
 {
 "item": "alx-sci-item-01", 
 "itemDisplayName": "scientist"
 }
 ]
 }
 ]
}

# Global binding 
$ python cx.py /profile/metadata/create?admin=true '{"profiles":[\
 {"group":"alx-id-proffesion","groupDisplayName":"proffesion","items":[\
 {"item":"alx-sci-item-01","itemDisplayName":"scientist"}\
 ]}]}'
{
 "metadata": [
 {
 "group": "alx-id-proffesion", 
 "groupDisplayName": "proffession", 
 "items": [
 {
 "item": "alx-sci-item-01", 
 "itemDisplayName": "scientist"
 }
 ]
 }
 ]
}

Last updated: December 28, 2023