.. _quickaddprofile:
Quick Add Profiles
=======================================
.. image:: /_static/img/quick-add-profiles-workbench.PNG
Retrieving Quick Add Profiles (QAP)
"""""""""""""""""""""""""""""""""""
Quick Add Profiles are accessible via the “other” folder directly under the root directory. Calling getChildren() on the “QuickAddProfiles” folder will return a list of all quick add profiles that are currently available via CMIS.
Request sample
^^^^^^^^^^^^^^
.. code-block:: xml
GET https://test.test.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/children/?id=quickaddprofiles HTTP/1.1
Connection: keep-alive
Authorization: Basic Y21pczpjbWlz
Response sample
^^^^^^^^^^^^^^^
.. code-block:: xml
Quick Add Profiles
quickaddprofiles
2019-11-14T10:28:47Z
false
71
quickaddprofile-20
EEL QAP
2019-11-14T10:28:47Z
2019-11-14T10:28:47Z
2019-11-14T10:28:47.7627493Z
EEL QAP 20
EEL QAP
quickaddprofile-20
cmis:item
t1quickaddprofiletype
N/A
1900-01-01T00:00:00+10:00
N/A
1900-01-01T00:00:00+10:00
/OTHER/QUICKADDPROFILES/quickaddprofile-20
quickaddprofile-20
20
false
false
false
true
false
true
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
f9020f79052f4885a8cb38843d6be6fa
quickaddprofile-20
quickaddprofile-40
this is for use in the T1 Connect process when a binder is created by the system.
2019-11-14T10:28:47Z
2019-11-14T10:28:47Z
2019-11-14T10:28:47.7627493Z
Email Related Binder QAP
this is for use in the T1 Connect process when a binder is created by the system.
quickaddprofile-40
cmis:item
t1quickaddprofiletype
N/A
1900-01-01T00:00:00+10:00
N/A
1900-01-01T00:00:00+10:00
/OTHER/QUICKADDPROFILES/quickaddprofile-40
quickaddprofile-40
40
false
false
false
true
false
true
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
05ee29520da24e8b929514e357ebbd16
quickaddprofile-40
Retrieving Mandatory and Default Properties
"""""""""""""""""""""""""""""""""""""""""""
The default behavior for the Quick Add Profile (QAP) object is to return the basic QAP properties through CMIS.
The ability to retrieve more detailed information has now been implemented.
Detailed information will be retrieved when the appropriate filter (filter=includeDefaults) is applied requesting the extra information.
The extra properties returned are Mandatory fields, Mandatory indexes, default index links and default field values.
For mandatory indexes and default index links, the value returned is the CMIS object ID.
For default fields the value returned is the field name and field value separated by ||.
Where the default field value is a lookup field (class, calltype, callsite, etc) the default value returned will be the CMIS object ID for that field.
For text fields, the text is returned.
*\* The new QAP properties will always be returned but will only be populated if the filter is used and the QAP has any of these fields configured.*
*\*\* Detailed information on QAP's can be requested at the root level or at the object level.*
Request sample
^^^^^^^^^^^^^^
.. code-block:: text
GET https://test.test.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/children/?id=quickaddprofiles&filter=includeDefaults
Connection: keep-alive
Authorization: Basic Y21pczpjbWlz
.. code-block:: text
GET https://test.test.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/children/?id=quickaddprofile-1082&filter=includeDefaults
Connection: keep-alive
Authorization: Basic Y21pczpjbWlz
Response sample
^^^^^^^^^^^^^^^
.. code-block:: xml
quickaddprofile-1082
2019-11-13T12:32:28Z
2019-11-13T12:32:28Z
2019-11-14T09:37:01.3479285Z
DAN Default
quickaddprofile-1082
cmis:item
t1quickaddprofiletype
N/A
1900-01-01T00:00:00+10:00
N/A
1900-01-01T00:00:00+10:00
/OTHER/QUICKADDPROFILES/quickaddprofile-1082
quickaddprofile-1082
Class Name
Author
Class Name||class-931
My Description||You need to put some text here
Call Type||calltype-1
index-11
indexentry-4-x-x-x-x-x-57
[DocumentProperties::FileName]
Default Precis on upload only
1082
false
false
false
true
false
true
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
DotCMIS Sample
^^^^^^^^^^^^^^
.. code-block:: c#
private static ICmisObject GetQap(ISession session, long qapId, bool includeDefaults)
{
var ctxt = includeDefaults ? new OperationContext() { Filter = new HashSet {"includeDefaults"} } : session.DefaultContext;
return session.GetObject($"{Constants.ObjectIdPrefixes.QuickAddProfile}-{qapId}", ctxt);
}