Query Profile Schema
GET /metadata/profiles/ | |
Available since: 8.0.100.00
|
Description
Queries the schema which describes the customer profiles.
If the profile schema is not defined, this operation returns the HTTP Status Code 404 (Not Found)
. In that case, your application should switch to maintenance mode, see Set Server Mode, and create the profile Schema by defining business contact attributes in the Configuration Manager. See Configuration Options for further details.
Operation
Prerequisites:
- The UCS<ref name="ucs"></ref> is in production mode.
- The profile schema is already defined.
ID | CV.WS.PROF.META.1 |
---|---|
Method | GET |
URL | /metadata/profiles/ |
Response
The Context Management Service API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this operation can return.
HTTP code | 200 |
---|---|
HTTP message | OK |
Body | Attribute Schema[] |
Example
Operation
GET /metadata/profiles/
Result
200 OK [{"encrypt":false,"name":"PIN","length":256,"type":"string"}, {"encrypt":false,"name":"Title","length":256,"type":"string"}, {"encrypt":false,"name":"CustomerSegment","length":256,"type":"string"}, {"encrypt":false,"name":"LastName","length":256,"type":"string"}, {"encrypt":false,"name":"AccountNumber","length":256,"type":"string"}, {"encrypt":false,"name":"FirstName","length":256,"type":"string"}, {"encrypt":false,"name":"PhoneNumber","length":256,"type":"string"}, {"encrypt":false,"name":"ContactId","length":256,"type":"string"}, {"encrypt":false,"name":"EmailAddress","length":256,"type":"string"}, {"encrypt":false,"name":"Title","length":256,"type":"string"}, {"encrypt":false,"name":"PIN","length":256,"type":"string"}, {"encrypt":false,"name":"ContactId","length":256,"type":"string"}, {"encrypt":false,"name":"homeaddress","length":256,"type":"string"}, {"encrypt":false,"name":"EmailAddress","length":256,"type":"string"}, {"encrypt":false,"name":"PhoneNumber","length":256,"type":"string"}, {"encrypt":false,"name":"AccountNumber","length":256,"type":"string"}, {"encrypt":false,"name":"LastName","length":256,"type":"string"}, {"encrypt":false,"name":"FirstName","length":256,"type":"string"}, {"encrypt":false,"name":"CustomerSegment","length":256,"type":"string"}, {"encrypt":false,"name":"LastCalledAgent_EmployeeID","length":256,"type":"string"}, {"encrypt":false,"name":"LastCalledAgent_TimeStamp","length":0,"type":"datetime"}, {"encrypt":false,"name":"PreferredAgent_EmployeeID","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_workitem","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_workitem","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_workitem","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_auxwork","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_auxwork","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_auxwork","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_imchat","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_imchat","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_imchat","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_outboundpreview","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_outboundpreview","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_outboundpreview","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_vmail","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_vmail","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_vmail","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_smail","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_smail","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_smail","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_cobrowsing","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_cobrowsing","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_cobrowsing","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_webform","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_webform","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_webform","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_busevent","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_busevent","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_busevent","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_voice","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_voice","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_voice","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_appsharing","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_appsharing","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_appsharing","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_email","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_email","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_email","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_chat","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_chat","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_chat","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_any","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_any","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_any","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_fax","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_fax","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_fax","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_video","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_video","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_video","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_whiteboard","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_whiteboard","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_whiteboard","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_alert","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_alert","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_alert","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_voip","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_voip","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_voip","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_sms","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_sms","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_sms","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_EmplID_callback","length":256,"type":"string"}, {"encrypt":false,"name":"LCA_TimeStamp_callback","length":0,"type":"datetime"}, {"encrypt":false,"name":"Pref_EmplID_callback","length":256,"type":"string"}]
This page was last edited on November 23, 2017, at 14:06.
Comments or questions about this documentation? Contact us for support!