Returns profile groups and profile item display name bindings.
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 |
|---|---|---|---|
|
|
String |
No |
The id of customer which metadata entry will be returned. |
|
|
String |
No |
The id of site group which metadata entry will be returned. |
|
|
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 |
|---|---|---|---|
|
|
String |
Yes |
User profile or content profile group name. |
|
|
Array of Objects |
No |
A list of group items metadata. |
The item metadata object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
User profile or content profile item name. |
Response
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
Array of Objects |
Yes |
A list of created bindings. |
Metadata object has the same fields as profile object from request.
Examples
# Site group binding
$ python cx.py /profile/metadata/read '{"siteGroupId":"1135172335968227720","profiles":[\
{"group":"alx-id-proffesion","items":[\
{"item":"alx-sci-item-01"}\
]}]}'
{
"metadata": [
{
"group": "alx-id-proffesion",
"groupDisplayName": "proffession",
"items": [
{
"item": "alx-sci-item-01",
"itemDisplayName": "scientist"
}
]
}
]
}
# Customer binding
$ python cx.py /profile/metadata/read '{"customerId":"0c3130d72e0d68036a579e9ab4e3349116b4b6b6","profiles":[\
{"group":"alx-id-proffesion","items":[\
{"item":"alx-sci-item-01"}\
]}]}'
{
"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","items":[\
{"item":"alx-sci-item-01"}\
]}]}'
{
"metadata": [
{
"group": "alx-id-proffesion",
"groupDisplayName": "proffession",
"items": [
{
"item": "alx-sci-item-01",
"itemDisplayName": "scientist"
}
]
}
]
}