Field Details

Field details provide information about the fields that are used within ECM. They can be used to provide mappings for index entry user fields. Please note that this type is also queryable.

../_images/fielddetails-workbench.PNG

Get field details

Sample request

GET https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/children/?id=fielddetails HTTP/1.1
Host: test2.onespresso.net
Authorization: Basic YWRtaW46YWRtaW4=

Sample response

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/atom+xml;type=feed
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-UA-Compatible: IE=edge
Date: Wed, 04 Jan 2017 04:12:55 GMT
Content-Length: 800277

<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/" xmlns="http://www.w3.org/2005/Atom" xmlns:cmis="http://docs.oasis-open.org/ns/cmis/core/200908/" xmlns:cmism="http://docs.oasis-open.org/ns/cmis/messaging/200908/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns:cmisra="http://docs.oasis-open.org/ns/cmis/restatom/200908/">
        <atom:title type="text">Contains the definitions of field. Can be used to map user fields to an appropriate description.</atom:title>
        <atom:id>fielddetails</atom:id>
        <atom:updated>2017-01-04T14:12:13Z</atom:updated>
        <atom:link rel="service" type="application/atomsvc+xml" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/servicedoc"/>
        <atom:link rel="self" type="application/atom+xml;type=feed" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/children/?id=fielddetails&amp;environmentId=testSQL"/>
        <atom:link rel="via" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/object/?id=fielddetails"/>
        <atom:link rel="down" type="application/cmistree+xml" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/descendants/?id=fielddetails"/>
        <atom:link rel="up" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/objectparents/?objectId=fielddetails"/>
        <cmisra:hasMoreItems>false</cmisra:hasMoreItems>
        <cmisra:numItems>100</cmisra:numItems>
        <atom:entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <atom:id>fielddetail-0</atom:id>
                <atom:title type="text">F1_Text</atom:title>
                <atom:published>2017-01-04T14:12:13Z</atom:published>
                <atom:updated>2017-01-04T14:12:13Z</atom:updated>
                <atom:link rel="self" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/object/?id=fielddetail-0"/>
                <atom:link rel="service" type="application/atomsvc+xml" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/servicedoc"/>
                <atom:link rel="describedby" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/type/?id=cmis:item"/>
                <atom:link rel="http://docs.oasis-open.org/ns/cmis/link/200908/allowableactions" type="application/cmisallowableactions+xml" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/allowableactions/?id=fielddetail-0"/>
                <atom:link rel="http://docs.oasis-open.org/ns/cmis/link/200908/policies" type="application/atom+xml;type=feed" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/policies/?id=fielddetail-0"/>
                <atom:link rel="down" type="application/atom+xml;type=feed" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/children/?id=fielddetail-0"/>
                <atom:link rel="up" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/objectparents/?objectId=fielddetail-0&amp;filter=%7Bfilter%7D&amp;includeRelationships=%7BincludeRelationships%7D&amp;renditionFilter=%7BrenditionFilter%7D&amp;includeAllowableActions=%7BincludeAllowableActions%7D&amp;includeRelativePathSegment=%7BincludeRelativePathSegment%7D"/>
                <app:edited>2017-01-04T14:12:13.4280334Z</app:edited>
                <cmisra:object>
                        <cmis:properties>
                                <cmis:propertyString propertyDefinitionId="cmis:name" localName="Name" displayName="Name" queryName="cmis:name">
                                        <cmis:value>F1_Text</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyString propertyDefinitionId="cmis:description" localName="Description" displayName="Description" queryName="cmis:description">
                                        <cmis:value>field</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyId propertyDefinitionId="cmis:objectId" localName="ObjectId" displayName="Object Id" queryName="cmis:objectId">
                                        <cmis:value>fielddetail-4533</cmis:value>
                                </cmis:propertyId>
                                <cmis:propertyId propertyDefinitionId="cmis:baseTypeId" localName="BaseTypeId" displayName="Base Type Id" queryName="cmis:baseTypeId">
                                        <cmis:value>cmis:item</cmis:value>
                                </cmis:propertyId>
                                <cmis:propertyId propertyDefinitionId="cmis:objectTypeId" localName="ObjectTypeId" displayName="Object Type Id" queryName="cmis:objectTypeId">
                                        <cmis:value>t1fielddetailtype</cmis:value>
                                </cmis:propertyId>
                                <cmis:propertyId propertyDefinitionId="cmis:secondaryObjectTypeIds" localName="secondaryObjectTypeIds" displayName="Ids of the objects secondary types." queryName="cmis:secondaryObjectTypeIds"/>
                                <cmis:propertyString propertyDefinitionId="cmis:createdBy" localName="CreatedBy" displayName="Created By" queryName="cmis:createdBy">
                                        <cmis:value>N/A</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyDateTime propertyDefinitionId="cmis:creationDate" localName="CreationDate" displayName="Creation Date" queryName="cmis:creationDate">
                                        <cmis:value>1900-01-01T00:00:00+10:00</cmis:value>
                                </cmis:propertyDateTime>
                                <cmis:propertyString propertyDefinitionId="cmis:lastModifiedBy" localName="LastModifiedBy" displayName="Last Modified By" queryName="cmis:lastModifiedBy">
                                        <cmis:value>N/A</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyDateTime propertyDefinitionId="cmis:lastModificationDate" localName="LastModificationDate" displayName="Last Modification Date" queryName="cmis:lastModificationDate">
                                        <cmis:value>1900-01-01T00:00:00+10:00</cmis:value>
                                </cmis:propertyDateTime>
                                <cmis:propertyString propertyDefinitionId="cmis:path" localName="Path" displayName="Path" queryName="cmis:path">
                                        <cmis:value>/OTHER/FIELDDETAILS/fielddetail-4533</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyString propertyDefinitionId="cmis:relativePathSegment" localName="relativePathSegment" displayName="Relative Path Segment" queryName="cmis:relativePathSegment">
                                        <cmis:value>fielddetail-4533</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyId propertyDefinitionId="cmis:changeToken" localName="Changetoken" displayName="Changetoken" queryName="cmis:changeToken"/>
                                <cmis:propertyString propertyDefinitionId="cmis:defaultCaption" localName="DefaultCaption" displayName="cmis:defaultCaption" queryName="cmis:defaultCaption">
                                        <cmis:value>field</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyString propertyDefinitionId="cmis:fieldType" localName="FieldType" displayName="cmis:fieldType" queryName="cmis:fieldType">
                                        <cmis:value>10</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyInteger propertyDefinitionId="cmis:displayLength" localName="DisplayLength" displayName="cmis:displayLength" queryName="cmis:displayLength">
                                        <cmis:value>20</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyInteger propertyDefinitionId="cmis:fieldId" localName="FieldId" displayName="cmis:fieldId" queryName="cmis:fieldId">
                                        <cmis:value>4533</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyString propertyDefinitionId="cmis:fieldName" localName="FieldName" displayName="cmis:fieldName" queryName="cmis:fieldName">
                                        <cmis:value>F1_Text</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyInteger propertyDefinitionId="cmis:indexNumber" localName="cmis:indexNumber" displayName="cmis:indexNumber" queryName="cmis:indexNumber">
                                        <cmis:value>93</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyInteger propertyDefinitionId="cmis:userFieldNumber" localName="UserFieldNumber" displayName="cmis:userFieldNumber" queryName="cmis:userFieldNumber">
                                        <cmis:value>1</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyInteger propertyDefinitionId="cmis:fieldLength" localName="FieldLength" displayName="cmis:fieldLength" queryName="cmis:fieldLength">
                                        <cmis:value>20</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyString propertyDefinitionId="cmis:denormalisedColumn" localName="DenormalisedColumn" displayName="cmis:denormalisedColumn" queryName="cmis:denormalisedColumn">
                                        <cmis:value>USER_TEXT1</cmis:value>
                                </cmis:propertyString>
                        </cmis:properties>
                        <cmis:allowableActions>
                                <cmis:canDeleteObject>false</cmis:canDeleteObject>
                                <cmis:canUpdateProperties>true</cmis:canUpdateProperties>
                                <cmis:canGetFolderTree>false</cmis:canGetFolderTree>
                                <cmis:canGetProperties>true</cmis:canGetProperties>
                                <cmis:canGetObjectRelationships>false</cmis:canGetObjectRelationships>
                                <cmis:canGetObjectParents>true</cmis:canGetObjectParents>
                                <cmis:canGetFolderParent>false</cmis:canGetFolderParent>
                                <cmis:canGetDescendants>false</cmis:canGetDescendants>
                                <cmis:canMoveObject>false</cmis:canMoveObject>
                                <cmis:canDeleteContentStream>false</cmis:canDeleteContentStream>
                                <cmis:canCheckOut>false</cmis:canCheckOut>
                                <cmis:canCancelCheckOut>false</cmis:canCancelCheckOut>
                                <cmis:canCheckIn>false</cmis:canCheckIn>
                                <cmis:canSetContentStream>false</cmis:canSetContentStream>
                                <cmis:canGetAllVersions>false</cmis:canGetAllVersions>
                                <cmis:canAddObjectToFolder>false</cmis:canAddObjectToFolder>
                                <cmis:canRemoveObjectFromFolder>false</cmis:canRemoveObjectFromFolder>
                                <cmis:canGetContentStream>false</cmis:canGetContentStream>
                                <cmis:canApplyPolicy>false</cmis:canApplyPolicy>
                                <cmis:canGetAppliedPolicies>false</cmis:canGetAppliedPolicies>
                                <cmis:canRemovePolicy>false</cmis:canRemovePolicy>
                                <cmis:canGetChildren>false</cmis:canGetChildren>
                                <cmis:canCreateDocument>false</cmis:canCreateDocument>
                                <cmis:canCreateFolder>false</cmis:canCreateFolder>
                                <cmis:canCreateRelationship>false</cmis:canCreateRelationship>
                                <cmis:canDeleteTree>false</cmis:canDeleteTree>
                                <cmis:canGetRenditions>false</cmis:canGetRenditions>
                                <cmis:canGetACL>false</cmis:canGetACL>
                                <cmis:canApplyACL>false</cmis:canApplyACL>
                        </cmis:allowableActions>
                </cmisra:object>
                <cmisra:relativePathSegment>c0ee7e93719d49abb2e18d1245f3ac73</cmisra:relativePathSegment>
                <cmisra:pathSegment>fielddetail-0</cmisra:pathSegment>
        </atom:entry>
        <atom:entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <atom:id>fielddetail-0</atom:id>
                <atom:title type="text">F1_Text</atom:title>
                <atom:published>2017-01-04T14:12:13Z</atom:published>
                <atom:updated>2017-01-04T14:12:13Z</atom:updated>
                <atom:link rel="self" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/object/?id=fielddetail-0"/>
                <atom:link rel="service" type="application/atomsvc+xml" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/servicedoc"/>
                <atom:link rel="describedby" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/type/?id=cmis:item"/>
                <atom:link rel="http://docs.oasis-open.org/ns/cmis/link/200908/allowableactions" type="application/cmisallowableactions+xml" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/allowableactions/?id=fielddetail-0"/>
                <atom:link rel="http://docs.oasis-open.org/ns/cmis/link/200908/policies" type="application/atom+xml;type=feed" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/policies/?id=fielddetail-0"/>
                <atom:link rel="down" type="application/atom+xml;type=feed" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/children/?id=fielddetail-0"/>
                <atom:link rel="up" type="application/atom+xml;type=entry" href="https://ecmpartner.onespresso.net/T1Dev/CiAnywhere/Web/DEV/Api/CMIS/T1/objectparents/?objectId=fielddetail-0&amp;filter=%7Bfilter%7D&amp;includeRelationships=%7BincludeRelationships%7D&amp;renditionFilter=%7BrenditionFilter%7D&amp;includeAllowableActions=%7BincludeAllowableActions%7D&amp;includeRelativePathSegment=%7BincludeRelativePathSegment%7D"/>
                <app:edited>2017-01-04T14:12:13.4280334Z</app:edited>
                <cmisra:object>
                        <cmis:properties>
                                <cmis:propertyString propertyDefinitionId="cmis:name" localName="Name" displayName="Name" queryName="cmis:name">
                                        <cmis:value>F1_Text</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyString propertyDefinitionId="cmis:description" localName="Description" displayName="Description" queryName="cmis:description">
                                        <cmis:value>field 2</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyId propertyDefinitionId="cmis:objectId" localName="ObjectId" displayName="Object Id" queryName="cmis:objectId">
                                        <cmis:value>fielddetail-4534</cmis:value>
                                </cmis:propertyId>
                                <cmis:propertyId propertyDefinitionId="cmis:baseTypeId" localName="BaseTypeId" displayName="Base Type Id" queryName="cmis:baseTypeId">
                                        <cmis:value>cmis:item</cmis:value>
                                </cmis:propertyId>
                                <cmis:propertyId propertyDefinitionId="cmis:objectTypeId" localName="ObjectTypeId" displayName="Object Type Id" queryName="cmis:objectTypeId">
                                        <cmis:value>t1fielddetailtype</cmis:value>
                                </cmis:propertyId>
                                <cmis:propertyId propertyDefinitionId="cmis:secondaryObjectTypeIds" localName="secondaryObjectTypeIds" displayName="Ids of the objects secondary types." queryName="cmis:secondaryObjectTypeIds"/>
                                <cmis:propertyString propertyDefinitionId="cmis:createdBy" localName="CreatedBy" displayName="Created By" queryName="cmis:createdBy">
                                        <cmis:value>N/A</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyDateTime propertyDefinitionId="cmis:creationDate" localName="CreationDate" displayName="Creation Date" queryName="cmis:creationDate">
                                        <cmis:value>1900-01-01T00:00:00+10:00</cmis:value>
                                </cmis:propertyDateTime>
                                <cmis:propertyString propertyDefinitionId="cmis:lastModifiedBy" localName="LastModifiedBy" displayName="Last Modified By" queryName="cmis:lastModifiedBy">
                                        <cmis:value>N/A</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyDateTime propertyDefinitionId="cmis:lastModificationDate" localName="LastModificationDate" displayName="Last Modification Date" queryName="cmis:lastModificationDate">
                                        <cmis:value>1900-01-01T00:00:00+10:00</cmis:value>
                                </cmis:propertyDateTime>
                                <cmis:propertyString propertyDefinitionId="cmis:path" localName="Path" displayName="Path" queryName="cmis:path">
                                        <cmis:value>/OTHER/FIELDDETAILS/fielddetail-4534</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyString propertyDefinitionId="cmis:relativePathSegment" localName="relativePathSegment" displayName="Relative Path Segment" queryName="cmis:relativePathSegment">
                                        <cmis:value>fielddetail-4534</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyId propertyDefinitionId="cmis:changeToken" localName="Changetoken" displayName="Changetoken" queryName="cmis:changeToken"/>
                                <cmis:propertyString propertyDefinitionId="cmis:defaultCaption" localName="DefaultCaption" displayName="cmis:defaultCaption" queryName="cmis:defaultCaption">
                                        <cmis:value>field 2</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyString propertyDefinitionId="cmis:fieldType" localName="FieldType" displayName="cmis:fieldType" queryName="cmis:fieldType">
                                        <cmis:value>10</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyInteger propertyDefinitionId="cmis:displayLength" localName="DisplayLength" displayName="cmis:displayLength" queryName="cmis:displayLength">
                                        <cmis:value>30</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyInteger propertyDefinitionId="cmis:fieldId" localName="FieldId" displayName="cmis:fieldId" queryName="cmis:fieldId">
                                        <cmis:value>4534</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyString propertyDefinitionId="cmis:fieldName" localName="FieldName" displayName="cmis:fieldName" queryName="cmis:fieldName">
                                        <cmis:value>F1_Text</cmis:value>
                                </cmis:propertyString>
                                <cmis:propertyInteger propertyDefinitionId="cmis:indexNumber" localName="cmis:indexNumber" displayName="cmis:indexNumber" queryName="cmis:indexNumber">
                                        <cmis:value>93</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyInteger propertyDefinitionId="cmis:userFieldNumber" localName="UserFieldNumber" displayName="cmis:userFieldNumber" queryName="cmis:userFieldNumber">
                                        <cmis:value>1</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyInteger propertyDefinitionId="cmis:fieldLength" localName="FieldLength" displayName="cmis:fieldLength" queryName="cmis:fieldLength">
                                        <cmis:value>30</cmis:value>
                                </cmis:propertyInteger>
                                <cmis:propertyString propertyDefinitionId="cmis:denormalisedColumn" localName="DenormalisedColumn" displayName="cmis:denormalisedColumn" queryName="cmis:denormalisedColumn">
                                        <cmis:value>USER_TEXT1</cmis:value>
                                </cmis:propertyString>
                        </cmis:properties>
                        <cmis:allowableActions>
                                <cmis:canDeleteObject>false</cmis:canDeleteObject>
                                <cmis:canUpdateProperties>true</cmis:canUpdateProperties>
                                <cmis:canGetFolderTree>false</cmis:canGetFolderTree>
                                <cmis:canGetProperties>true</cmis:canGetProperties>
                                <cmis:canGetObjectRelationships>false</cmis:canGetObjectRelationships>
                                <cmis:canGetObjectParents>true</cmis:canGetObjectParents>
                                <cmis:canGetFolderParent>false</cmis:canGetFolderParent>
                                <cmis:canGetDescendants>false</cmis:canGetDescendants>
                                <cmis:canMoveObject>false</cmis:canMoveObject>
                                <cmis:canDeleteContentStream>false</cmis:canDeleteContentStream>
                                <cmis:canCheckOut>false</cmis:canCheckOut>
                                <cmis:canCancelCheckOut>false</cmis:canCancelCheckOut>
                                <cmis:canCheckIn>false</cmis:canCheckIn>
                                <cmis:canSetContentStream>false</cmis:canSetContentStream>
                                <cmis:canGetAllVersions>false</cmis:canGetAllVersions>
                                <cmis:canAddObjectToFolder>false</cmis:canAddObjectToFolder>
                                <cmis:canRemoveObjectFromFolder>false</cmis:canRemoveObjectFromFolder>
                                <cmis:canGetContentStream>false</cmis:canGetContentStream>
                                <cmis:canApplyPolicy>false</cmis:canApplyPolicy>
                                <cmis:canGetAppliedPolicies>false</cmis:canGetAppliedPolicies>
                                <cmis:canRemovePolicy>false</cmis:canRemovePolicy>
                                <cmis:canGetChildren>false</cmis:canGetChildren>
                                <cmis:canCreateDocument>false</cmis:canCreateDocument>
                                <cmis:canCreateFolder>false</cmis:canCreateFolder>
                                <cmis:canCreateRelationship>false</cmis:canCreateRelationship>
                                <cmis:canDeleteTree>false</cmis:canDeleteTree>
                                <cmis:canGetRenditions>false</cmis:canGetRenditions>
                                <cmis:canGetACL>false</cmis:canGetACL>
                                <cmis:canApplyACL>false</cmis:canApplyACL>
                        </cmis:allowableActions>
                </cmisra:object>
                <cmisra:relativePathSegment>57a3b61a566740209e975892e9e59345</cmisra:relativePathSegment>
                <cmisra:pathSegment>fielddetail-0</cmisra:pathSegment>
        </atom:entry>
</feed>