Get article personalization details

Overview

This API allows eGain agents to get details of personalization tags of an article.

SecurityoAuthUser

Request

path Parameters

portalID required	number Example: 202200000001001
articleID required	string The Id of the article on which operation is performed. Both numeric and alternate Id formats are supported for article Id. Examples: Readable Id Providing readable article id. PROD-2268 Numeric Id Providing numeric article id. 202200000002268

query Parameters

workflowMilestone	string Default: "publish" workflow milestone of the article Enum: "authoring" "publish" "staging" Example: workflowMilestone=publish
$lang required	string Language in IETF form Example: $lang=en-US

header Parameters

Accept-Language required	string Default: en-US Language locale accepted by client (used for locale specific fields in resource representation and in error responses). Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
X-egain-tenant-id	string Unique identifier for tenant.
X-egain-activity-id	integer Numeric unique identifier of interaction from eGain.
X-interaction-id	string Unique identifier for interaction from other CRM applications.

Responses

200

Response for the get article personalization

204

No Content

400

Bad Request

401

Unauthorized Request

403

Forbidden

404

Not found

406

Unsupported Accept-Language value in Header.

500

Internal Server Error. Returned when unexpected error is encountered

get/portals/{portalID}/articles/{articleID}/personalization

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"accessTags": {"tagCategory": [{"name": "financial services",
"tags": {"tag": [{"name": "agent",
"id": "409600000001013"
},
{"name": "supervisor",
"id": "409600000001002"
}
]
},
"id": "409600000001000"
}
]
},
"filters": {"tagCategory": [{"name": "financial services",
"tagGroups": {"tagGroup": [{"name": "employees",
"id": "409600000001010"
}
]
},
"id": "409600000001000"
}
]
},
"publishViews": {"publishView": [{"name": "billing",
"tagCategories": [{"tagCategory": [{"name": "financial services",
"tags": {"tag": [{"name": "supervisor",
"id": "409600000001002"
},
{"name": "accountant",
"id": "409600000001004"
}
]
},
"id": "409600000001000"
}
]
}
],
"id": "409600000001403"
},
{"name": "specification",
"tagCategories": [{"tagCategory": [{"name": "financial services",
"tags": {"tag": [{"name": "agent",
"id": "409600000001013"
},
{"name": "technician",
"id": "409600000001006"
}
]
},
"id": "409600000001000"
}
]
}
],
"id": "409600000001404"
},
{"name": "shipping info",
"tagCategories": [{"tagCategory": [{"name": "shipping",
"tags": {"tag": [{"name": "delivery agent",
"id": "409600000001030"
}
]
},
"id": "409600000001028"
}
]
}
],
"id": "409600000001405"
},
{"name": "sales info",
"tagCategories": [{"tagCategory": [{"name": "financial services",
"tags": {"tag": [{"name": "supervisor",
"id": "409600000001002"
},
{"name": "agent",
"id": "409600000001013"
}
]
},
"id": "409600000001000"
}
]
}
],
"id": "409600000001406"
}
]
}
}