Operations

List Operations / Hide Operations
Expand Fully / Collapse Fully

AnnotationTemplate (Version 1)

GET/v1/annotationTemplate Gets all annotations templates for which the user has any priv access stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets all annotations templates for which the user has any priv access stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Query Parameters
type (optional) A collection of annotation template types used for filtering. Default returns all types.
includeInactive (optional) Include inactive templates in the response. Default is false.
Response
Content
annotationTemplates
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

annotationTemplates type

Represents a collection of annotation templates

Field Name Data Type Expected Description
arrowAnnotationTemplates List of arrowAnnotationTemplate [arrowAnnotationTemplate] Yes The collection of arrow annotation templates
checkAnnotationTemplates List of checkAnnotationTemplate [checkAnnotationTemplate] Yes The collection of check annotation templates
highlightAnnotationTemplates List of highlightAnnotationTemplate [highlightAnnotationTemplate] Yes The collection of highlight annotation templates
lineAnnotationTemplates List of lineAnnotationTemplate [lineAnnotationTemplate] Yes The collection of line annotation templates
ovalAnnotationTemplates List of ovalAnnotationTemplate [ovalAnnotationTemplate] Yes The collection of oval annotation templates
penAnnotationTemplates List of penAnnotationTemplate [penAnnotationTemplate] Yes The collection of pen annotation templates
pictureStampAnnotationTemplates List of pictureStampAnnotationTemplate [pictureStampAnnotationTemplate] Yes The collection of picture stamp annotation templates
rectangleAnnotationTemplates List of rectangleAnnotationTemplate [rectangleAnnotationTemplate] Yes The collection of rectangle annotation templates
redactionAnnotationTemplates List of redactionAnnotationTemplate [redactionAnnotationTemplate] Yes The collection of redaction annotation templates
stickyNoteAnnotationTemplates List of stickyNoteAnnotationTemplate [stickyNoteAnnotationTemplate] Yes The collection of sticky note annotation templates
textAnnotationTemplates List of textAnnotationTemplate [textAnnotationTemplate] Yes The collection of text annotation templates
textStampAnnotationTemplates List of textStampAnnotationTemplate [textStampAnnotationTemplate] Yes The collection of text stamp annotation templates
urlAnnotationTemplates List of urlAnnotationTemplate [urlAnnotationTemplate] Yes The collection of url annotation templates
annotationTemplateType enumeration

Represents an annotation template type

Constant Name Description
ARROW An arrow annotation template
CHECK A check annotation template
HIGHLIGHT A highlight annotation template
LINE A line annotation template
RECTANGLE A rectangle annotation template
OVAL An oval annotation template
PEN A pen annotation template
PICTURE_STAMP A picture stamp annotation template
REDACTION A redaction annotation template
TEXT_STAMP A text stamp annotation template
TEXT A text annotation template
STICKY_NOTE A sticky note annotation template
URL A URL annotation template
arrowAnnotationTemplate type

Represents an arrow annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
penColor String Yes The pen color for the annotation template
penWidth Integer Yes The pen width for the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
checkAnnotationTemplate type

Represents an check annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
penColor String Yes The pen color of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
fileInformation type

Represents information about the file

Field Name Data Type Expected Description
fileExtension String Yes The extension of the file
workingName String Yes The name of the file
font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
frame type

Represents the frame of an annotation

Field Name Data Type Expected Description
frameColor String Yes The frame color for the annotation
frameCornerRadius Integer Yes The frame corner radius for the annotation
frameMarginBottom Integer Yes The frame bottom margin for the annotation
frameMarginLeft Integer Yes The frame left margin for the annotation
frameMarginRight Integer Yes The frame right margin for the annotation
frameMarginTop Integer Yes The frame top margin for the annotation
frameStyle frameStyle Yes The frame style for the annotation
frameThickness Integer Yes The frame thickness for the annotation
frameStyle enumeration

The frame style of an annotation

Constant Name Description
NONE No frame style
RECTANGLE Rectangle frame style
ROUNDED_RECTANGLE Rounded rectangle frame style
ELLIPSE Ellipse frame style
highlightAnnotationTemplate type

Represents a highlight annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
fillColor String Yes The fill color of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
lineAnnotationTemplate type

Represents a line annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
penColor String Yes The pen color of the annotation template
penWidth Integer Yes The pen width of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
ovalAnnotationTemplate type

Represents an oval annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
fillColor String Yes The fill color of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
penColor String Yes The pen color of the annotation template
penWidth Integer Yes The pen width of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
penAnnotationTemplate type

Represents a pen annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
penColor String Yes The pen color of the annotation template
penWidth Integer Yes The pen width for the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
pictureStampAnnotationTemplate type

Represents a picture stamp annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
fileInformation fileInformation Yes Information about the image file
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
privileges type

Represents privilege information about an annotation template

Field Name Data Type Expected Description
canCreate boolean Yes Flag to determine if annotations of this template type can be created.
canDelete boolean Yes Flag to determine if the annotations of this template type can be deleted
canHide boolean Yes Flag to determine if the annotations of this template type can be hidden
canModify boolean Yes Flag to determine if the annotations of this template type can be modified
canView boolean Yes Flag to determine if the annotations of this template type can be viewed
rectangleAnnotationTemplate type

Represents a rectangle annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
fillColor String Yes The fill color of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
penColor String Yes The pen color of the annotation template
penWidth Integer Yes The pen width of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
redactionAnnotationTemplate type

Represents a redaction annotation template

Field Name Data Type Expected Description
canCreate Boolean Yes The create privilege status of the annotation template for the caller
description String Yes The description of the annotation template
fillColor String Yes The fill color of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
stickyNoteAnnotationTemplate type

Represents an sticky note annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
textAnnotationTemplate type

Represents an text annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
textInformation textInformation Yes The text content of the annotation template
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification
textStampAnnotationTemplate type

Represents an text stamp annotation template

Field Name Data Type Expected Description
description String Yes The description of the annotation template
dynamicVariables Boolean Yes The format specifiers in the text content are dynamic
fillColor String Yes The fill color of the annotation template
frame frame Yes Information about the frame of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
textInformation textInformation Yes The text content of the annotation template
urlAnnotationTemplate type

Represents a URL annotation template

Field Name Data Type Expected Description
actionURL String Yes The action url of the annotation template
description String Yes The description of the annotation template
id String Yes The ID of the annotation template
isActive Boolean Yes The active status of the annotation template
name String Yes The name of the annotation template
privileges privileges Yes The privilege information of the annotation template for the caller
textInformation textInformation Yes The text content of the annotation template

JSON Samples

Sample 1
Request URL
/v1/annotationTemplate
Response
{"arrowAnnotationTemplates":[{"id":"321YX18_000001Q8C000007","name":"Red Arrow","description":"Predefined","isActive":true,"privileges":{"canCreate":true,"canDelete":false,"canHide":true,"canModify":true,"canView":true},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotationTemplates":[{"id":"321YX18_000001Q8C000008","name":"Green Check","description":"Predefined","isActive":true,"privileges":{"canCreate":true,"canDelete":true,"canHide":true,"canModify":true,"canView":true},"penColor":"#FF008000"}],"highlightAnnotationTemplates":[{"id":"321YX18_000001Q8C00000D","name":"Blue Highlight","description":"Predefined","isActive":true,"privileges":{"canCreate":false,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"fillColor":"#FFCCFFFF"}],"lineAnnotationTemplates":[{"id":"321YX18_000001Q8C00000F","name":"Black Line","description":"Predefined","isActive":true,"privileges":{"canCreate":false,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"penColor":"#FF000000","penWidth":3}],"ovalAnnotationTemplates":[{"id":"321YX18_000001Q8C00000J","name":"Blue Oval","description":"Predefined","isActive":true,"privileges":{"canCreate":false,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"penColor":"#FF0000FF","penWidth":2,"fillColor":"#00000000"}],"penAnnotationTemplates":[{"id":"321YX18_000001Q8C00000M","name":"Red Pen","description":"Predefined","isActive":true,"privileges":{"canCreate":false,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"penColor":"#FFFF0000","penWidth":3}],"pictureStampAnnotationTemplates":[{"id":"321YX3N_0002RXR9000000W","name":"Signature","description":"John Doe's signature","isActive":true,"privileges":{"canCreate":true,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"fileInformation":{"workingName":"signature.PNG","fileExtension":"PNG"}}],"rectangleAnnotationTemplates":[{"id":"321YX18_000001Q8C00000P","name":"Solid Red Rectangle","description":"Predefined","isActive":true,"privileges":{"canCreate":false,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"penColor":"#FFFF0000","penWidth":1,"fillColor":"#FFFF0000"}],"redactionAnnotationTemplates":[{"id":"321YY58_000001J2200000Q","name":"Gray Redaction","description":"Predefined","isActive":true,"canCreate":true,"fillColor":"#FF808080"}],"stickyNoteAnnotationTemplates":[{"id":"321YX18_000001Q8C00000R","name":"Sticky Note","description":"Predefined","isActive":true,"privileges":{"canCreate":true,"canDelete":false,"canHide":false,"canModify":true,"canView":true}}],"textAnnotationTemplates":[{"id":"321YY1W_000DKBFM5000004","name":"Text","description":"Predefined","isActive":true,"privileges":{"canCreate":false,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text <hour.24>:<minute>"}}],"textStampAnnotationTemplates":[{"id":"321YX18_000001Q8C00000V","name":"View Properties","description":"Dynamic Stamp Template","isActive":true,"privileges":{"canCreate":true,"canDelete":false,"canHide":false,"canModify":true,"canView":true},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF008000","frameThickness":3,"frameCornerRadius":8,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF008000","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Viewed by <user.name> at <hour.24>:<minute>:<second>"},"dynamicVariables":false}],"urlAnnotationTemplates":[{"id":"321YX7C_0006M43PS00001J","name":"URL","description":"Predefined","isActive":true,"privileges":{"canCreate":false,"canDelete":false,"canHide":false,"canModify":false,"canView":true},"textInformation":{"font":{"face":"Arial","color":"#FF0000FF","height":12,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}]}
Sample 2
Request URL
/v1/annotationTemplate?type=ARROW&type=CHECK&includeInactive=true
Response
{"arrowAnnotationTemplates":[{"id":"321YX18_000001Q8C000007","name":"Red Arrow","description":"Predefined","isActive":true,"privileges":{"canCreate":true,"canDelete":false,"canHide":true,"canModify":true,"canView":true},"penColor":"#FFFF0000","penWidth":3},{"id":"321YY6D_0001KP2X6000008","name":"Arrow Annotation Template","description":"Inactive","isActive":false,"privileges":{"canCreate":false,"canDelete":false,"canHide":true,"canModify":false,"canView":true},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotationTemplates":[],"highlightAnnotationTemplates":[],"lineAnnotationTemplates":[],"ovalAnnotationTemplates":[],"penAnnotationTemplates":[],"pictureStampAnnotationTemplates":[],"rectangleAnnotationTemplates":[],"redactionAnnotationTemplates":[],"stickyNoteAnnotationTemplates":[],"textAnnotationTemplates":[],"textStampAnnotationTemplates":[],"urlAnnotationTemplates":[]}

XML Samples

Sample 1
Request URL
/v1/annotationTemplate
Response
<annotationTemplates>
    <arrowAnnotationTemplates>
        <arrowAnnotationTemplate>
            <id>321YX18_000001Q8C000007</id>
            <name>Red Arrow</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>true</canCreate>
                <canDelete>false</canDelete>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotationTemplate>
    </arrowAnnotationTemplates>
    <checkAnnotationTemplates>
        <checkAnnotationTemplate>
            <id>321YX18_000001Q8C000008</id>
            <name>Green Check</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>true</canCreate>
                <canDelete>true</canDelete>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FF008000</penColor>
        </checkAnnotationTemplate>
    </checkAnnotationTemplates>
    <highlightAnnotationTemplates>
        <highlightAnnotationTemplate>
            <id>321YX18_000001Q8C00000D</id>
            <name>Blue Highlight</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <fillColor>#FFCCFFFF</fillColor>
        </highlightAnnotationTemplate>
    </highlightAnnotationTemplates>
    <lineAnnotationTemplates>
        <lineAnnotationTemplate>
            <id>321YX18_000001Q8C00000F</id>
            <name>Black Line</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FF000000</penColor>
            <penWidth>3</penWidth>
        </lineAnnotationTemplate>
    </lineAnnotationTemplates>
    <ovalAnnotationTemplates>
        <ovalAnnotationTemplate>
            <id>321YX18_000001Q8C00000J</id>
            <name>Blue Oval</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FF0000FF</penColor>
            <penWidth>2</penWidth>
            <fillColor>#00000000</fillColor>
        </ovalAnnotationTemplate>
    </ovalAnnotationTemplates>
    <penAnnotationTemplates>
        <penAnnotationTemplate>
            <id>321YX18_000001Q8C00000M</id>
            <name>Red Pen</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </penAnnotationTemplate>
    </penAnnotationTemplates>
    <pictureStampAnnotationTemplates>
        <pictureStampAnnotationTemplate>
            <id>321YX3N_0002RXR9000000W</id>
            <name>Signature</name>
            <description>John Doe's signature</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>true</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <fileInformation>
                <workingName>signature.PNG</workingName>
                <fileExtension>PNG</fileExtension>
            </fileInformation>
        </pictureStampAnnotationTemplate>
    </pictureStampAnnotationTemplates>
    <rectangleAnnotationTemplates>
        <rectangleAnnotationTemplate>
            <id>321YX18_000001Q8C00000P</id>
            <name>Solid Red Rectangle</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FFFF0000</penColor>
            <penWidth>1</penWidth>
            <fillColor>#FFFF0000</fillColor>
        </rectangleAnnotationTemplate>
    </rectangleAnnotationTemplates>
    <redactionAnnotationTemplates>
        <redactionAnnotationTemplate>
            <id>321YY58_000001J2200000Q</id>
            <name>Gray Redaction</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <canCreate>true</canCreate>
            <fillColor>#FF808080</fillColor>
        </redactionAnnotationTemplate>
    </redactionAnnotationTemplates>
    <stickyNoteAnnotationTemplates>
        <stickyNoteAnnotationTemplate>
            <id>321YX18_000001Q8C00000R</id>
            <name>Sticky Note</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>true</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>true</canModify>
                <canView>true</canView>
            </privileges>
        </stickyNoteAnnotationTemplate>
    </stickyNoteAnnotationTemplates>
    <textAnnotationTemplates>
        <textAnnotationTemplate>
            <id>321YY1W_000DKBFM5000004</id>
            <name>Text</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <textInformation>
                <font>
                    <face>Times New Roman</face>
                    <color>#FF0000FF</color>
                    <height>14</height>
                    <bold>true</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>My Text &lt;hour.24&gt;:&lt;minute&gt;</text>
            </textInformation>
        </textAnnotationTemplate>
    </textAnnotationTemplates>
    <textStampAnnotationTemplates>
        <textStampAnnotationTemplate>
            <id>321YX18_000001Q8C00000V</id>
            <name>View Properties</name>
            <description>Dynamic Stamp Template</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>true</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>true</canModify>
                <canView>true</canView>
            </privileges>
            <fillColor>#00000000</fillColor>
            <frame>
                <frameStyle>ROUNDED_RECTANGLE</frameStyle>
                <frameColor>#FF008000</frameColor>
                <frameThickness>3</frameThickness>
                <frameCornerRadius>8</frameCornerRadius>
                <frameMarginLeft>5</frameMarginLeft>
                <frameMarginRight>5</frameMarginRight>
                <frameMarginTop>0</frameMarginTop>
                <frameMarginBottom>0</frameMarginBottom>
            </frame>
            <textInformation>
                <font>
                    <face>Stencil</face>
                    <color>#FF008000</color>
                    <height>20</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>Viewed by &lt;user.name&gt; at &lt;hour.24&gt;:&lt;minute&gt;:&lt;second&gt;</text>
            </textInformation>
            <dynamicVariables>false</dynamicVariables>
        </textStampAnnotationTemplate>
    </textStampAnnotationTemplates>
    <urlAnnotationTemplates>
        <urlAnnotationTemplate>
            <id>321YX7C_0006M43PS00001J</id>
            <name>URL</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <textInformation>
                <font>
                    <face>Arial</face>
                    <color>#FF0000FF</color>
                    <height>12</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>true</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_LEFT</justify>
                <text>Perceptive Software</text>
            </textInformation>
            <actionURL>http://www.perceptivesoftware.com</actionURL>
        </urlAnnotationTemplate>
    </urlAnnotationTemplates>
</annotationTemplates>
Sample 2
Request URL
/v1/annotationTemplate?type=ARROW&type=CHECK&includeInactive=true
Response
<annotationTemplates>
    <arrowAnnotationTemplates>
        <arrowAnnotationTemplate>
            <id>321YX18_000001Q8C000007</id>
            <name>Red Arrow</name>
            <description>Predefined</description>
            <isActive>true</isActive>
            <privileges>
                <canCreate>true</canCreate>
                <canDelete>false</canDelete>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotationTemplate>
        <arrowAnnotationTemplate>
            <id>321YY6D_0001KP2X6000008</id>
            <name>Arrow Annotation Template</name>
            <description>Inactive</description>
            <isActive>false</isActive>
            <privileges>
                <canCreate>false</canCreate>
                <canDelete>false</canDelete>
                <canHide>true</canHide>
                <canModify>false</canModify>
                <canView>true</canView>
            </privileges>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotationTemplate>
    </arrowAnnotationTemplates>
    <checkAnnotationTemplates/>
    <highlightAnnotationTemplates/>
    <lineAnnotationTemplates/>
    <ovalAnnotationTemplates/>
    <penAnnotationTemplates/>
    <pictureStampAnnotationTemplates/>
    <rectangleAnnotationTemplates/>
    <redactionAnnotationTemplates/>
    <stickyNoteAnnotationTemplates/>
    <textAnnotationTemplates/>
    <textStampAnnotationTemplates/>
    <urlAnnotationTemplates/>
</annotationTemplates>

GET/v1/annotationTemplate/PICTURE_STAMP/{id}/file Gets the file associated with a picture stamp annotation template stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets the file associated with a picture stamp annotation template stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-Name The working name for the file of the document annotation.
X-IntegrationServer-Resource-Extension The extension type for the file of the document annotation.

JSON Samples

Sample 1
Request URL
/v1/annotationTemplate/PICTURE_STAMP/301YVD7_0002ZL50K000025/file

XML Samples

Sample 1
Request URL
/v1/annotationTemplate/PICTURE_STAMP/301YVD7_0002ZL50K000025/file

HEAD/v1/annotationTemplate/PICTURE_STAMP/{id}/file Gets the file info associated with a picture stamp annotation template stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets the file info associated with a picture stamp annotation template stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
Binary
Content-Types
  • application/octet-stream
  • application/xml
  • application/json
Additional Headers
X-IntegrationServer-Resource-Name The working name for the file of the document annotation.
X-IntegrationServer-Resource-Extension The extension type for the file of the document annotation.
Content-Type Note: "application/xml" and "application/json" are deprecated and should no longer be specified as valid Accept types in the request.

JSON Samples

Sample 1
Request URL
/v1/annotationTemplate/PICTURE_STAMP/301YVD7_0002ZL50K000025/file

XML Samples

Sample 1
Request URL
/v1/annotationTemplate/PICTURE_STAMP/301YVD7_0002ZL50K000025/file

ApplicationPlan (Version 1)

GET/v1/applicationPlan Gets all Application Plans if no type parameter provided or only those Application Plans of the t...

Expand Operation / Collapse Operation

Gets all Application Plans if no type parameter provided or only those Application Plans of the type provided.

Available from version: 1.0.0

Call Properties

Query Parameter
learnModeType type (optional) Limits the response to the type of Application Plan provided
Response
Content
List of applicationPlan [applicationPlan]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents an application plan in a get all call

Field Name Data Type Expected Description
id String Yes The unique ID of the application plan type.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan type in your ImageNow system.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.

JSON Samples

Sample 1
Request URL
/v1/applicationPlan?learnModeType=INTERACT_OUTLOOK
Response
{"applicationPlans":[{"id":"321YX26_00012H9T2000005","name":"Interact for Outlook: Accounts Payable","learnModeType":"INTERACT_OUTLOOK"},{"id":"321YX26_00012H9T200004F","name":"Interact for Outlook: Accounts Payable DRAFT","learnModeType":"INTERACT_OUTLOOK"}]}

XML Samples

Sample 1
Request URL
/v1/applicationPlan?learnModeType=INTERACT_OUTLOOK
Response
<applicationPlans>
    <applicationPlan>
        <id>321YX26_00012H9T2000005</id>
        <name>Interact for Outlook: Accounts Payable</name>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
    </applicationPlan>
    <applicationPlan>
        <id>321YX26_00012H9T200004F</id>
        <name>Interact for Outlook: Accounts Payable DRAFT</name>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
    </applicationPlan>
</applicationPlans>

GET/v1/applicationPlan/{id} Gets the Application Plan information for the provided id

Expand Operation / Collapse Operation

Gets the Application Plan information for the provided id

Available from version: 1.0.0

Call Properties

Response
Content
applicationPlan
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents a detailed application plan

Field Name Data Type Expected Description
description String Yes The description of the application plan type in your ImageNow system.
docKeyInfos List of docKeyInfo [docKeyInfo] Yes List of document key info objects which contain information about configuration of document keys.
id String Yes The unique ID of the application plan type.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan type in your ImageNow system.
docKeyInfo type

Represents an application plan's document key info.

Field Name Data Type Expected Description
allowBlank boolean Yes Can this value be blank
listId String No If a list, the id of the list
listValue boolean Yes Is this a list
name String Yes The caption name
sourceType sourceType Yes The source type
type keyType Yes The caption type
userModifiable boolean Yes Can the user modify this value
keyType enumeration

Describes the type of the key.

Constant Name Description
DOC_TYPE Document type
DOC_DRAWER Drawer
DOC_FIELD1 Field1
DOC_FIELD2 Field2
DOC_FIELD3 Field3
DOC_FIELD4 Field4
DOC_FIELD5 Field5
DOC_PROPERTY Property
FOLDER_NAME Folder name
FOLDER_TYPE Folder type
FOLDER_PROPERTY Folder property
DOC_NAME Document name
DOC_SHORTCUT Document shortcut
sourceType enumeration

Describes the type for a context map item source.

Constant Name Description
NONE No mapping.
DICTIONARY Mapped to a dictionary item.
LITERAL Mapped to a string literal.
USER_ENTRY Requires user entry.
PREDEFINED_LIST Mapped to a predefined list.
USER_NAME_SELECT Mapped to a list of user names.
USER_NAME_CURRENT Mapped to current user name.
USER_ID Mapped to user id.
DATE_TIME Mapped to a date.
SEQUENCE_NUM Mapped to a sequence number.
UNIQUE_ID Mapped to a unique id generator.
SCRIPT Mapped to a script.
BATCH_ID Mapped to a batch id.
SYSTEM_DRAWER Mapped to a drawer.
SYSTEM_DRAWER_LIST Mapped to a drawer list.
DOC_TYPE Mapped to a document type.
DOC_TYPE_LIST Mapped to a document type list.
FOLDER_TYPE Mapped to a folder type.
FOLDER_TYPE_LIST Mapped to a folder type list.
DOC_KEY Mapped to a document key.
DOC_PROPERTY Mapped to a document property.
LEGACY_FOLDER_TYPE Mapped to a folder type.
TARGET_NAME Mapped to a shortcut target name.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.

JSON Samples

Sample 1
Request URL
/v1/applicationPlan/321YX26_00012H9T2000005
Response
{"id":"321YX26_00012H9T2000005","name":"Interact for Outlook: Accounts Payable","description":"Interact for Outlook application plan","learnModeType":"INTERACT_OUTLOOK","docKeyInfos":[{"name":"","type":"DOC_NAME","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""},{"name":"Test Label","type":"DOC_FIELD1","sourceType":"LITERAL","userModifiable":true,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD2","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD3","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD4","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD5","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_TYPE","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""}]}

XML Samples

Sample 1
Request URL
/v1/applicationPlan/321YX26_00012H9T2000005
Response
<applicationPlan>
    <id>321YX26_00012H9T2000005</id>
    <name>Interact for Outlook: Accounts Payable</name>
    <description>Interact for Outlook application plan</description>
    <learnModeType>INTERACT_OUTLOOK</learnModeType>
    <docKeyInfos>
        <docKeyInfo>
            <name/>
            <type>DOC_NAME</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name>Test Label</name>
            <type>DOC_FIELD1</type>
            <sourceType>LITERAL</sourceType>
            <userModifiable>true</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD2</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD3</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD4</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD5</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_TYPE</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
    </docKeyInfos>
</applicationPlan>

PUT/v1/applicationPlan/{id}/location Resolves the location of an application plan

Expand Operation / Collapse Operation

Resolves the location of an application plan

Available from version: 1.0.0

Call Properties

Request
Content applicationPlanInfo
Content-Types
  • application/xml
  • application/json
Response
Content
applicationPlanLocation
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlanInfo type

Field Name Data Type Expected Description
sourceMetadataPairs List of keyValuePair [sourceMetadataPair] No
applicationPlanLocation type

Represents the target location of an Application Plan path

Field Name Data Type Expected Description
id String Yes The unique ID of the folder or drawer location.
path path Yes The folder or drawer path.
type applicationPlanLocationType Yes The location type. The applicationPlanLocationType enumeration contains the possible values for this element.
applicationPlanLocationType enumeration

The type of the location

Constant Name Description
UNKNOWN The instance is unknown.
FOLDER The instance is an ImageNow folder.
DRAWER The instance is an ImageNow drawer.
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.

JSON Samples

Sample 1 - Multi-level application plan including a folder type with custom properties
Request URL
/v1/applicationPlan/321YX26_00012H9T2000005/location
Request
{"sourceMetadataPairs":[{"key":"folderName0","value":"Folder Level 1"},{"key":"folderName1","value":"Folder Level 2"},{"key":"folderName2","value":"Folder Level 3"},{"key":"tripId","value":"42"},{"key":"dateOfBirth","value":"11/09/2013"},{"key":"folderDescription","value":"Travel Expenses"},{"key":"canCopy","value":"1"}]}
Response
{"id":"321YX66_0000BWZY700000F","path":{"pathSegments":["Default","Folder Level 1","Folder Level 2","Folder Level 3"]},"type":"FOLDER"}
Sample 2 - Application plan expects an existing drawer name
Request URL
/v1/applicationPlan/321YX65_00006ECRT000004/location
Request
{"sourceMetadataPairs":[{"key":"drawerName","value":"ExpenseReports"}]}
Response
{"id":"321YX66_0000BRZY7000009","path":{"pathSegments":["ExpenseReports"]},"type":"DRAWER"}

XML Samples

Sample 1 - Multi-level application plan including a folder type with custom properties
Request URL
/v1/applicationPlan/321YX26_00012H9T2000005/location
Request
<applicationPlanInfo>
    <sourceMetadataPairs>
        <sourceMetadataPair>
            <key>folderName0</key>
            <value>Folder Level 1</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>folderName1</key>
            <value>Folder Level 2</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>folderName2</key>
            <value>Folder Level 3</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>tripId</key>
            <value>42</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>dateOfBirth</key>
            <value>11/09/2013</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>folderDescription</key>
            <value>Travel Expenses</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>canCopy</key>
            <value>1</value>
        </sourceMetadataPair>
    </sourceMetadataPairs>
</applicationPlanInfo>
Response
<applicationPlanLocation>
    <id>321YX66_0000BWZY700000F</id>
    <path>
        <pathSegments>
            <pathSegment>Default</pathSegment>
            <pathSegment>Folder Level 1</pathSegment>
            <pathSegment>Folder Level 2</pathSegment>
            <pathSegment>Folder Level 3</pathSegment>
        </pathSegments>
    </path>
    <type>FOLDER</type>
</applicationPlanLocation>
Sample 2 - Application plan expects an existing drawer name
Request URL
/v1/applicationPlan/321YX65_00006ECRT000004/location
Request
<applicationPlanInfo>
    <sourceMetadataPairs>
        <sourceMetadataPair>
            <key>drawerName</key>
            <value>ExpenseReports</value>
        </sourceMetadataPair>
    </sourceMetadataPairs>
</applicationPlanInfo>
Response
<applicationPlanLocation>
    <id>321YX66_0000BRZY7000009</id>
    <path>
        <pathSegments>
            <pathSegment>ExpenseReports</pathSegment>
        </pathSegments>
    </path>
    <type>DRAWER</type>
</applicationPlanLocation>

ApplicationPlan (Version 2)

GET/v2/applicationPlan Gets all Application Plans if no type parameter provided or only those Application Plans of the t...

Expand Operation / Collapse Operation

Gets all Application Plans if no type parameter provided or only those Application Plans of the type or category type provided.

Available from version: 1.0.0

Call Properties

Query Parameter
learnModeType type (optional) Limits the response to the type of Application Plan provided
Response
Content
List of applicationPlan [applicationPlan]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents an application plan in a get all call

Field Name Data Type Expected Description
id String Yes The unique ID of the application plan type.
learnModeCategoryType categoryType Yes This indicates the category type of application plan. The learnModeCategoryType enumeration contains the possible values for this data element.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan type in your ImageNow system.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.

JSON Samples

Sample 1
Request URL
/v2/applicationPlan?learnModeType=INTERACT_OUTLOOK
Response
{"applicationPlans":[{"id":"321YX26_00012H9T2000005","name":"Interact for Outlook: Accounts Payable","learnModeType":"INTERACT_OUTLOOK","learnModeCategoryType":"DOCUMENT"},{"id":"321YX26_00012H9T200004F","name":"Interact for Outlook: Accounts Payable DRAFT","learnModeType":"INTERACT_OUTLOOK","learnModeCategoryType":"DOCUMENT"}]}

XML Samples

Sample 1
Request URL
/v2/applicationPlan?learnModeType=INTERACT_OUTLOOK
Response
<applicationPlans>
    <applicationPlan>
        <id>321YX26_00012H9T2000005</id>
        <name>Interact for Outlook: Accounts Payable</name>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
        <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    </applicationPlan>
    <applicationPlan>
        <id>321YX26_00012H9T200004F</id>
        <name>Interact for Outlook: Accounts Payable DRAFT</name>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
        <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    </applicationPlan>
</applicationPlans>

GET/v2/applicationPlan/{id} Gets the Application Plan information for the provided id

Expand Operation / Collapse Operation

Gets the Application Plan information for the provided id

Available from version: 1.0.0

Call Properties

Response
Content
applicationPlan
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents a detailed application plan

Field Name Data Type Expected Description
description String Yes The description of the application plan type in your ImageNow system.
dictionaryElements List of dictionaryElement [dictionaryElement] Yes List of dictionary elements for the application plan.
docKeyInfos List of docKeyInfo [docKeyInfo] Yes List of document key info objects which contain information about configuration of document keys.
id String Yes The unique ID of the application plan type.
learnModeCategoryType categoryType Yes This indicates the category type of application plan. The learnModeCategoryType enumeration contains the possible values for this data element.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan type in your ImageNow system.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
dictionaryElement type

Represents an application plan's dictionary element.

Field Name Data Type Expected Description
id String Yes The unique ID of the dictionary element.
mappedFields List of mappedField [mappedField] Yes The fields that the dictionary element is mapped to
name String Yes The name of the dictionary element
docKeyInfo type

Represents an application plan's document key info.

Field Name Data Type Expected Description
allowBlank boolean Yes Can this value be blank
listId String No If a list, the id of the list
listValue boolean Yes Is this a list
name String Yes The caption name
sourceType sourceType Yes The source type
type keyType Yes The caption type
userModifiable boolean Yes Can the user modify this value
keyType enumeration

Describes the type of the key.

Constant Name Description
DOC_TYPE Document type
DOC_DRAWER Drawer
DOC_FIELD1 Field1
DOC_FIELD2 Field2
DOC_FIELD3 Field3
DOC_FIELD4 Field4
DOC_FIELD5 Field5
DOC_PROPERTY Property
FOLDER_NAME Folder name
FOLDER_TYPE Folder type
FOLDER_PROPERTY Folder property
DOC_NAME Document name
DOC_SHORTCUT Document shortcut
RECORD_FILE_PLAN File plan
RECORD_CATEGORY Record Category
RECORD_FOLDER_NAME Folder name
RECORD_FOLDER_TYPE Folder type
RECORD_TYPE Type
RECORD_AUTHOR Author
RECORD_ORIGINATING_ORG Originating org
RECORD_PUBLICATION_DATE Publication date
RECORD_MEDIA_TYPE Media type
RECORD_FORMAT Format
RECORD_DATE_RECEIVED Date received
RECORD_ADDRESSEES Addressees
RECORD_OTHER_ADDRESSEES Other addressees
RECORD_LOCATION Location
RECORD_FOLDER_LOCATION Folder location
mappedField type

Represents the field a dictionary element is mapped to.

Field Name Data Type Expected Description
fieldKey keyType Yes The field key type
propertyId String No The custom property id if applicable
sourceType enumeration

Describes the type for a context map item source.

Constant Name Description
NONE No mapping.
DICTIONARY Mapped to a dictionary item.
LITERAL Mapped to a string literal.
USER_ENTRY Requires user entry.
PREDEFINED_LIST Mapped to a predefined list.
USER_NAME_SELECT Mapped to a list of user names.
USER_NAME_CURRENT Mapped to current user name.
USER_ID Mapped to user id.
DATE_TIME Mapped to a date.
SEQUENCE_NUM Mapped to a sequence number.
UNIQUE_ID Mapped to a unique id generator.
SCRIPT Mapped to a script.
BATCH_ID Mapped to a batch id.
SYSTEM_DRAWER Mapped to a drawer.
SYSTEM_DRAWER_LIST Mapped to a drawer list.
DOC_TYPE Mapped to a document type.
DOC_TYPE_LIST Mapped to a document type list.
FOLDER_TYPE Mapped to a folder type.
FOLDER_TYPE_LIST Mapped to a folder type list.
DOC_KEY Mapped to a document key.
DOC_PROPERTY Mapped to a document property.
LEGACY_FOLDER_TYPE Mapped to a folder type.
TARGET_NAME Mapped to a shortcut target name.
RECORD_FILE_PLAN Mapped to a record file plan.
RECORD_FOLDER_TYPE Mapped to a record folder type.
RECORD_TYPE Mapped to a record type.
RECORD_CATEGORY Mapped to a record category.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.

JSON Samples

Sample 1
Request URL
/v2/applicationPlan/321YX26_00012H9T2000005
Response
{"id":"321YX26_00012H9T2000005","name":"Interact for Outlook: Accounts Payable","description":"Interact for Outlook application plan","learnModeType":"INTERACT_OUTLOOK","learnModeCategoryType":"DOCUMENT","docKeyInfos":[{"name":"","type":"DOC_NAME","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""},{"name":"Test Label","type":"DOC_FIELD1","sourceType":"LITERAL","userModifiable":true,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD2","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD3","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD4","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_FIELD5","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"","type":"DOC_TYPE","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""}],"dictionaryElements":[{"id":"321YY6E_000KQNESJ00000H","name":"Vendor Name","mappedFields":[{"fieldKey":"DOC_FIELD2","propertyId":null},{"fieldKey":"DOC_PROPERTY","propertyId":"321YY7C_000LGNM2X000001"},{"fieldKey":null,"propertyId":null}]},{"id":"321YY7J_000N0HXBG000029","name":"Address","mappedFields":[]}]}

XML Samples

Sample 1
Request URL
/v2/applicationPlan/321YX26_00012H9T2000005
Response
<applicationPlan>
    <id>321YX26_00012H9T2000005</id>
    <name>Interact for Outlook: Accounts Payable</name>
    <description>Interact for Outlook application plan</description>
    <learnModeType>INTERACT_OUTLOOK</learnModeType>
    <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    <docKeyInfos>
        <docKeyInfo>
            <name/>
            <type>DOC_NAME</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name>Test Label</name>
            <type>DOC_FIELD1</type>
            <sourceType>LITERAL</sourceType>
            <userModifiable>true</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD2</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD3</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD4</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD5</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_TYPE</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
        </docKeyInfo>
    </docKeyInfos>
    <dictionaryElements>
        <dictionaryElement>
            <id>321YY6E_000KQNESJ00000H</id>
            <name>Vendor Name</name>
            <mappedFields>
                <mappedField>
                    <fieldKey>DOC_FIELD2</fieldKey>
                </mappedField>
                <mappedField>
                    <fieldKey>DOC_PROPERTY</fieldKey>
                    <propertyId>321YY7C_000LGNM2X000001</propertyId>
                </mappedField>
                <mappedField/>
            </mappedFields>
        </dictionaryElement>
        <dictionaryElement>
            <id>321YY7J_000N0HXBG000029</id>
            <name>Address</name>
            <mappedFields/>
        </dictionaryElement>
    </dictionaryElements>
</applicationPlan>

PUT/v2/applicationPlan/{id}/location Resolves the location of an application plan

Expand Operation / Collapse Operation

Resolves the location of an application plan

Available from version: 1.0.0

Call Properties

Request
Content applicationPlanInfo
Content-Types
  • application/xml
  • application/json
Response
Content
applicationPlanLocation
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlanInfo type

Field Name Data Type Expected Description
sourceMetadataPairs List of keyValuePair [sourceMetadataPair] No
applicationPlanLocation type

Represents the target location of an Application Plan path

Field Name Data Type Expected Description
id String Yes The unique ID of the folder or drawer location.
path path Yes The folder or drawer path.
type applicationPlanLocationType Yes The location type. The applicationPlanLocationType enumeration contains the possible values for this element.
applicationPlanLocationType enumeration

The type of the location

Constant Name Description
UNKNOWN The instance is unknown.
FOLDER The instance is an ImageNow folder.
DRAWER The instance is an ImageNow drawer.
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.

JSON Samples

Sample 1 - Multi-level application plan including a folder type with custom properties
Request URL
/v2/applicationPlan/321YX26_00012H9T2000005/location
Request
{"sourceMetadataPairs":[{"key":"folderName0","value":"Folder Level 1"},{"key":"folderName1","value":"Folder Level 2"},{"key":"folderName2","value":"Folder Level 3"},{"key":"tripId","value":"42"},{"key":"dateOfBirth","value":"11/09/2013"},{"key":"folderDescription","value":"Travel Expenses"},{"key":"canCopy","value":"1"}]}
Response
{"id":"321YX66_0000BWZY700000F","path":{"pathSegments":["Default","Folder Level 1","Folder Level 2","Folder Level 3"]},"type":"FOLDER"}
Sample 2 - Application plan expects an existing drawer name
Request URL
/v2/applicationPlan/321YX65_00006ECRT000004/location
Request
{"sourceMetadataPairs":[{"key":"drawerName","value":"ExpenseReports"}]}
Response
{"id":"321YX66_0000BRZY7000009","path":{"pathSegments":["ExpenseReports"]},"type":"DRAWER"}

XML Samples

Sample 1 - Multi-level application plan including a folder type with custom properties
Request URL
/v2/applicationPlan/321YX26_00012H9T2000005/location
Request
<applicationPlanInfo>
    <sourceMetadataPairs>
        <sourceMetadataPair>
            <key>folderName0</key>
            <value>Folder Level 1</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>folderName1</key>
            <value>Folder Level 2</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>folderName2</key>
            <value>Folder Level 3</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>tripId</key>
            <value>42</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>dateOfBirth</key>
            <value>11/09/2013</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>folderDescription</key>
            <value>Travel Expenses</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>canCopy</key>
            <value>1</value>
        </sourceMetadataPair>
    </sourceMetadataPairs>
</applicationPlanInfo>
Response
<applicationPlanLocation>
    <id>321YX66_0000BWZY700000F</id>
    <path>
        <pathSegments>
            <pathSegment>Default</pathSegment>
            <pathSegment>Folder Level 1</pathSegment>
            <pathSegment>Folder Level 2</pathSegment>
            <pathSegment>Folder Level 3</pathSegment>
        </pathSegments>
    </path>
    <type>FOLDER</type>
</applicationPlanLocation>
Sample 2 - Application plan expects an existing drawer name
Request URL
/v2/applicationPlan/321YX65_00006ECRT000004/location
Request
<applicationPlanInfo>
    <sourceMetadataPairs>
        <sourceMetadataPair>
            <key>drawerName</key>
            <value>ExpenseReports</value>
        </sourceMetadataPair>
    </sourceMetadataPairs>
</applicationPlanInfo>
Response
<applicationPlanLocation>
    <id>321YX66_0000BRZY7000009</id>
    <path>
        <pathSegments>
            <pathSegment>ExpenseReports</pathSegment>
        </pathSegments>
    </path>
    <type>DRAWER</type>
</applicationPlanLocation>

ApplicationPlan (Version 3)

GET/v3/applicationPlan Gets all Application Plans if no type parameter provided or only those Application Plans of the t...

Expand Operation / Collapse Operation

Gets all Application Plans if no type parameter provided or only those Application Plans of the type or category type provided.

Available from version: 1.0.0

Call Properties

Query Parameter
learnModeType type (optional) Limits the response to the type of Application Plan provided
Response
Content
List of applicationPlan [applicationPlan]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents an application plan in a get all call

Field Name Data Type Expected Description
id String Yes The unique ID of the application plan.
learnModeCategoryType categoryType Yes This indicates the category type of application plan. The learnModeCategoryType enumeration contains the possible values for this data element.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.
EXTERNAL_USER This is the External User LearnMode method, which is used for external applications, such as a scan application.

JSON Samples

Sample 1
Request URL
/v3/applicationPlan?learnModeType=INTERACT_OUTLOOK
Response
{"applicationPlans":[{"id":"321YX26_00012H9T2000005","name":"Interact for Outlook: Accounts Payable","learnModeType":"INTERACT_OUTLOOK","learnModeCategoryType":"DOCUMENT"},{"id":"321YX26_00012H9T200004F","name":"Interact for Outlook: Accounts Payable DRAFT","learnModeType":"INTERACT_OUTLOOK","learnModeCategoryType":"DOCUMENT"}]}

XML Samples

Sample 1
Request URL
/v3/applicationPlan?learnModeType=INTERACT_OUTLOOK
Response
<applicationPlans>
    <applicationPlan>
        <id>321YX26_00012H9T2000005</id>
        <name>Interact for Outlook: Accounts Payable</name>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
        <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    </applicationPlan>
    <applicationPlan>
        <id>321YX26_00012H9T200004F</id>
        <name>Interact for Outlook: Accounts Payable DRAFT</name>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
        <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    </applicationPlan>
</applicationPlans>

GET/v3/applicationPlan/{id} Gets the Application Plan information for the provided id

Expand Operation / Collapse Operation

Gets the Application Plan information for the provided id

Available from version: 1.0.0

Call Properties

Response
Content
applicationPlan
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents a detailed application plan

Field Name Data Type Expected Description
description String Yes The description of the application plan type in your ImageNow system.
dictionaryElements List of dictionaryElement [dictionaryElement] Yes List of dictionary elements for the application plan.
docKeyInfos List of docKeyInfo [docKeyInfo] Yes List of document key info objects which contain information about configuration of document keys.
id String Yes The unique ID of the application plan type.
learnModeCategoryType categoryType Yes This indicates the category type of application plan. The learnModeCategoryType enumeration contains the possible values for this data element.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan type in your ImageNow system.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
dictionaryElement type

Represents an application plan's dictionary element.

Field Name Data Type Expected Description
id String Yes The unique ID of the dictionary element.
mappedFields List of mappedField [mappedField] Yes The fields that the dictionary element is mapped to
name String Yes The name of the dictionary element
docKeyInfo type

Represents an application plan's document key info.

Field Name Data Type Expected Description
allowBlank boolean Yes Can this value be blank
listId String No If a list, the id of the list
listValue boolean Yes Is this a list
name String Yes The caption name
propertyId String No If a property, the id of the property
rememberLastValue boolean Yes Remember last value
sourceData String No Data for the source type
sourceType sourceType Yes The source type
type keyType Yes The key type
userModifiable boolean Yes Can the user modify this value
keyType enumeration

Describes the type of the key.

Constant Name Description
DOC_TYPE Document type
DOC_DRAWER Drawer
DOC_FIELD1 Field1
DOC_FIELD2 Field2
DOC_FIELD3 Field3
DOC_FIELD4 Field4
DOC_FIELD5 Field5
DOC_PROPERTY Property
FOLDER_NAME Folder name
FOLDER_TYPE Folder type
FOLDER_PROPERTY Folder property
DOC_NAME Document name
DOC_SHORTCUT Document shortcut
RECORD_FILE_PLAN File plan
RECORD_CATEGORY Record Category
RECORD_FOLDER_NAME Folder name
RECORD_FOLDER_TYPE Folder type
RECORD_TYPE Type
RECORD_AUTHOR Author
RECORD_ORIGINATING_ORG Originating org
RECORD_PUBLICATION_DATE Publication date
RECORD_MEDIA_TYPE Media type
RECORD_FORMAT Format
RECORD_DATE_RECEIVED Date received
RECORD_ADDRESSEES Addressees
RECORD_OTHER_ADDRESSEES Other addressees
RECORD_LOCATION Location
RECORD_FOLDER_LOCATION Folder location
mappedField type

Represents the field a dictionary element is mapped to.

Field Name Data Type Expected Description
fieldKey keyType Yes The field key type
propertyId String No The custom property id if applicable
sourceType enumeration

Describes the type for a context map item source.

Constant Name Description
NONE No mapping.
DICTIONARY Mapped to a dictionary item.
LITERAL Mapped to a string literal.
USER_ENTRY Requires user entry.
PREDEFINED_LIST Mapped to a predefined list.
USER_NAME_SELECT Mapped to a list of user names.
USER_NAME_CURRENT Mapped to current user name.
USER_ID Mapped to user id.
DATE_TIME Mapped to a date.
SEQUENCE_NUM Mapped to a sequence number.
UNIQUE_ID Mapped to a unique id generator.
SCRIPT Mapped to a script.
BATCH_ID Mapped to a batch id.
SYSTEM_DRAWER Mapped to a drawer.
SYSTEM_DRAWER_LIST Mapped to a drawer list.
DOC_TYPE Mapped to a document type.
DOC_TYPE_LIST Mapped to a document type list.
FOLDER_TYPE Mapped to a folder type.
FOLDER_TYPE_LIST Mapped to a folder type list.
DOC_KEY Mapped to a document key.
DOC_PROPERTY Mapped to a document property.
LEGACY_FOLDER_TYPE Mapped to a folder type.
TARGET_NAME Mapped to a shortcut target name.
RECORD_FILE_PLAN Mapped to a record file plan.
RECORD_FOLDER_TYPE Mapped to a record folder type.
RECORD_TYPE Mapped to a record type.
RECORD_CATEGORY Mapped to a record category.
BARCODE Mapped to a name for a barcode value.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.
EXTERNAL_USER This is the External User LearnMode method, which is used for external applications, such as a scan application.

JSON Samples

Sample 1
Request URL
/v3/applicationPlan/321YX26_00012H9T2000005
Response
{"id":"321YX26_00012H9T2000005","name":"Interact for Outlook: Accounts Payable","description":"Interact for Outlook application plan","learnModeType":"INTERACT_OUTLOOK","learnModeCategoryType":"DOCUMENT","docKeyInfos":[{"name":"","type":"DOC_NAME","sourceType":"DICTIONARY","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":""},{"name":"Test Label","type":"DOC_FIELD1","sourceType":"LITERAL","sourceData":null,"userModifiable":true,"rememberLastValue":true,"allowBlank":true,"listValue":false,"listId":"","propertyId":""},{"name":"","type":"DOC_FIELD2","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":""},{"name":"","type":"DOC_FIELD3","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":true,"allowBlank":true,"listValue":false,"listId":"","propertyId":""},{"name":"","type":"DOC_FIELD4","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":""},{"name":"","type":"DOC_FIELD5","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":""},{"name":"","type":"DOC_TYPE","sourceType":"DICTIONARY","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":""}],"dictionaryElements":[{"id":"321YY6E_000KQNESJ00000H","name":"Vendor Name","mappedFields":[{"fieldKey":"DOC_FIELD2","propertyId":null},{"fieldKey":"DOC_PROPERTY","propertyId":"321YY7C_000LGNM2X000001"},{"fieldKey":null,"propertyId":null}]},{"id":"321YY7J_000N0HXBG000029","name":"Address","mappedFields":[]}]}

XML Samples

Sample 1
Request URL
/v3/applicationPlan/321YX26_00012H9T2000005
Response
<applicationPlan>
    <id>321YX26_00012H9T2000005</id>
    <name>Interact for Outlook: Accounts Payable</name>
    <description>Interact for Outlook application plan</description>
    <learnModeType>INTERACT_OUTLOOK</learnModeType>
    <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    <docKeyInfos>
        <docKeyInfo>
            <name/>
            <type>DOC_NAME</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
        </docKeyInfo>
        <docKeyInfo>
            <name>Test Label</name>
            <type>DOC_FIELD1</type>
            <sourceType>LITERAL</sourceType>
            <userModifiable>true</userModifiable>
            <rememberLastValue>true</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD2</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD3</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>true</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD4</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD5</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_TYPE</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
        </docKeyInfo>
    </docKeyInfos>
    <dictionaryElements>
        <dictionaryElement>
            <id>321YY6E_000KQNESJ00000H</id>
            <name>Vendor Name</name>
            <mappedFields>
                <mappedField>
                    <fieldKey>DOC_FIELD2</fieldKey>
                </mappedField>
                <mappedField>
                    <fieldKey>DOC_PROPERTY</fieldKey>
                    <propertyId>321YY7C_000LGNM2X000001</propertyId>
                </mappedField>
                <mappedField/>
            </mappedFields>
        </dictionaryElement>
        <dictionaryElement>
            <id>321YY7J_000N0HXBG000029</id>
            <name>Address</name>
            <mappedFields/>
        </dictionaryElement>
    </dictionaryElements>
</applicationPlan>

ApplicationPlan (Version 4)

GET/v4/applicationPlan/{id} Gets the Application Plan information for the provided ID

Expand Operation / Collapse Operation

Gets the Application Plan information for the provided ID

Available from version: 1.0.0

Call Properties

Response
Content
applicationPlan
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents a detailed application plan

Field Name Data Type Expected Description
description String Yes The description of the application plan.
dictionaryElements List of dictionaryElement [dictionaryElement] Yes List of dictionary elements for the application plan.
docKeyInfos List of keyInfo [docKeyInfo] Yes List of document key info objects.
drawerInfo keyInfo Yes The info describing the drawer for the document
id String Yes The unique ID of the application plan.
learnModeCategoryType categoryType Yes This indicates the category type of the application plan.
learnModeType type Yes This indicates the type of the application plan.
name String Yes The name of the application plan.
path List of applicationPlanFolderInfo [folderInfo] Yes This describes the folder path for the document.
applicationPlanFolderInfo type

Represents the definition of a folder in an application plan

Field Name Data Type Expected Description
folderKeyInfos List of keyInfo [folderKeyInfo] Yes List of folder key info objects.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
dictionaryElement type

Represents an application plan's dictionary element.

Field Name Data Type Expected Description
id String Yes The unique ID of the dictionary element.
mappedFields List of mappedField [mappedField] Yes The fields that the dictionary element is mapped to
name String Yes The name of the dictionary element
keyInfo type

Represents an application plan's key info.

Field Name Data Type Expected Description
allowBlank boolean Yes This indicates whether this key value can be blank.
hidden boolean No This indicates Whether to hide this field/property from display.
listId String No The id of the list if this key info is a list.
listValue boolean Yes This indicates whether this key info is a list.
name String Yes The name of the key info.
propertyId String No The id of the property if this key info is a property.
rememberLastValue boolean Yes This indicates whether the key remembers the last value.
sourceData String No The source data value of the key info.
sourceType sourceType Yes The source type of the key info.
type keyType Yes The type of the key info.
userModifiable boolean Yes This indicates whether the user can modify this value.
keyType enumeration

Describes the type of the key.

Constant Name Description
DOC_TYPE Document type
DOC_DRAWER Drawer
DOC_FIELD1 Field1
DOC_FIELD2 Field2
DOC_FIELD3 Field3
DOC_FIELD4 Field4
DOC_FIELD5 Field5
DOC_PROPERTY Property
FOLDER_NAME Folder name
FOLDER_TYPE Folder type
FOLDER_PROPERTY Folder property
DOC_NAME Document name
DOC_SHORTCUT Document shortcut
RECORD_FILE_PLAN File plan
RECORD_CATEGORY Record Category
RECORD_FOLDER_NAME Folder name
RECORD_FOLDER_TYPE Folder type
RECORD_TYPE Type
RECORD_AUTHOR Author
RECORD_ORIGINATING_ORG Originating org
RECORD_PUBLICATION_DATE Publication date
RECORD_MEDIA_TYPE Media type
RECORD_FORMAT Format
RECORD_DATE_RECEIVED Date received
RECORD_ADDRESSEES Addressees
RECORD_OTHER_ADDRESSEES Other addressees
RECORD_LOCATION Location
RECORD_FOLDER_LOCATION Folder location
mappedField type

Represents the field a dictionary element is mapped to.

Field Name Data Type Expected Description
fieldKey keyType Yes The field key type
propertyId String No The custom property id if applicable
sourceType enumeration

Describes the type for a context map item source.

Constant Name Description
NONE No mapping.
DICTIONARY Mapped to a dictionary item.
LITERAL Mapped to a string literal.
USER_ENTRY Requires user entry.
PREDEFINED_LIST Mapped to a predefined list.
USER_NAME_SELECT Mapped to a list of user names.
USER_NAME_CURRENT Mapped to current user name.
USER_ID Mapped to user id.
DATE_TIME Mapped to a date.
SEQUENCE_NUM Mapped to a sequence number.
UNIQUE_ID Mapped to a unique id generator.
SCRIPT Mapped to a script.
BATCH_ID Mapped to a batch id.
SYSTEM_DRAWER Mapped to a drawer.
SYSTEM_DRAWER_LIST Mapped to a drawer list.
DOC_TYPE Mapped to a document type.
DOC_TYPE_LIST Mapped to a document type list.
FOLDER_TYPE Mapped to a folder type.
FOLDER_TYPE_LIST Mapped to a folder type list.
DOC_KEY Mapped to a document key.
DOC_PROPERTY Mapped to a document property.
LEGACY_FOLDER_TYPE Mapped to a folder type.
TARGET_NAME Mapped to a shortcut target name.
RECORD_FILE_PLAN Mapped to a record file plan.
RECORD_FOLDER_TYPE Mapped to a record folder type.
RECORD_TYPE Mapped to a record type.
RECORD_CATEGORY Mapped to a record category.
BARCODE Mapped to a name for a barcode value.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.
EXTERNAL_USER This is the External User LearnMode method, which is used for external applications, such as a scan application.

JSON Samples

Sample 1
Request URL
/v4/applicationPlan/321YX26_00012H9T2000005
Response
{"id":"321YX26_00012H9T2000005","name":"ExternalUserAppPlan","description":"User modifiable app plan for external use","learnModeType":"EXTERNAL_USER","learnModeCategoryType":"DOCUMENT","drawerInfo":{"name":"","type":"DOC_DRAWER","sourceType":"SYSTEM_DRAWER","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true},"path":[{"folderKeyInfos":[{"name":"","type":"FOLDER_NAME","sourceType":"BARCODE","sourceData":"BarcodeName","userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"FOLDER_TYPE","sourceType":"FOLDER_TYPE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"FOLDER_PROPERTY","sourceType":"DATE_TIME","sourceData":null,"userModifiable":true,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false}]},{"folderKeyInfos":[{"name":"","type":"FOLDER_NAME","sourceType":"LITERAL","sourceData":null,"userModifiable":true,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"FOLDER_TYPE","sourceType":"FOLDER_TYPE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false}]}],"docKeyInfos":[{"name":"","type":"DOC_NAME","sourceType":"DICTIONARY","sourceData":null,"userModifiable":true,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_FIELD1","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_FIELD2","sourceType":"UNIQUE_ID","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true},{"name":"","type":"DOC_FIELD3","sourceType":"DATE_TIME","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true},{"name":"","type":"DOC_FIELD4","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_FIELD5","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_TYPE","sourceType":"DICTIONARY","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_PROPERTY","sourceType":"PREDEFINED_LIST","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":true,"listId":"321YZ2T_0000FFGPJ000002","propertyId":"","hidden":false},{"name":"","type":"DOC_PROPERTY","sourceType":"DICTIONARY","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true}],"dictionaryElements":[{"id":"321YY6E_000KQNESJ00000H","name":"Vendor Name","mappedFields":[{"fieldKey":"DOC_FIELD2","propertyId":null},{"fieldKey":"DOC_PROPERTY","propertyId":"321YY7C_000LGNM2X000001"},{"fieldKey":null,"propertyId":null}]},{"id":"321YY7J_000N0HXBG000029","name":"Address","mappedFields":[]}]}

XML Samples

Sample 1
Request URL
/v4/applicationPlan/321YX26_00012H9T2000005
Response
<applicationPlan>
    <id>321YX26_00012H9T2000005</id>
    <name>ExternalUserAppPlan</name>
    <description>User modifiable app plan for external use</description>
    <learnModeType>EXTERNAL_USER</learnModeType>
    <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    <drawerInfo>
        <name/>
        <type>DOC_DRAWER</type>
        <sourceType>SYSTEM_DRAWER</sourceType>
        <userModifiable>false</userModifiable>
        <rememberLastValue>false</rememberLastValue>
        <allowBlank>false</allowBlank>
        <listValue>false</listValue>
        <listId/>
        <propertyId/>
        <hidden>true</hidden>
    </drawerInfo>
    <path>
        <folderInfo>
            <folderKeyInfos>
                <folderKeyInfo>
                    <name/>
                    <type>FOLDER_NAME</type>
                    <sourceType>BARCODE</sourceType>
                    <sourceData>BarcodeName</sourceData>
                    <userModifiable>false</userModifiable>
                    <rememberLastValue>false</rememberLastValue>
                    <allowBlank>false</allowBlank>
                    <listValue>false</listValue>
                    <listId/>
                    <propertyId/>
                    <hidden>false</hidden>
                </folderKeyInfo>
                <folderKeyInfo>
                    <name/>
                    <type>FOLDER_TYPE</type>
                    <sourceType>FOLDER_TYPE</sourceType>
                    <userModifiable>false</userModifiable>
                    <rememberLastValue>false</rememberLastValue>
                    <allowBlank>false</allowBlank>
                    <listValue>false</listValue>
                    <listId/>
                    <propertyId/>
                    <hidden>false</hidden>
                </folderKeyInfo>
                <folderKeyInfo>
                    <name/>
                    <type>FOLDER_PROPERTY</type>
                    <sourceType>DATE_TIME</sourceType>
                    <userModifiable>true</userModifiable>
                    <rememberLastValue>false</rememberLastValue>
                    <allowBlank>false</allowBlank>
                    <listValue>false</listValue>
                    <listId/>
                    <propertyId/>
                    <hidden>false</hidden>
                </folderKeyInfo>
            </folderKeyInfos>
        </folderInfo>
        <folderInfo>
            <folderKeyInfos>
                <folderKeyInfo>
                    <name/>
                    <type>FOLDER_NAME</type>
                    <sourceType>LITERAL</sourceType>
                    <userModifiable>true</userModifiable>
                    <rememberLastValue>false</rememberLastValue>
                    <allowBlank>false</allowBlank>
                    <listValue>false</listValue>
                    <listId/>
                    <propertyId/>
                    <hidden>false</hidden>
                </folderKeyInfo>
                <folderKeyInfo>
                    <name/>
                    <type>FOLDER_TYPE</type>
                    <sourceType>FOLDER_TYPE</sourceType>
                    <userModifiable>false</userModifiable>
                    <rememberLastValue>false</rememberLastValue>
                    <allowBlank>false</allowBlank>
                    <listValue>false</listValue>
                    <listId/>
                    <propertyId/>
                    <hidden>false</hidden>
                </folderKeyInfo>
            </folderKeyInfos>
        </folderInfo>
    </path>
    <docKeyInfos>
        <docKeyInfo>
            <name/>
            <type>DOC_NAME</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>true</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>false</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD1</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>false</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD2</type>
            <sourceType>UNIQUE_ID</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>true</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD3</type>
            <sourceType>DATE_TIME</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>true</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD4</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>false</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_FIELD5</type>
            <sourceType>NONE</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>true</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>false</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_TYPE</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>false</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_PROPERTY</type>
            <sourceType>PREDEFINED_LIST</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>true</listValue>
            <listId>321YZ2T_0000FFGPJ000002</listId>
            <propertyId/>
            <hidden>false</hidden>
        </docKeyInfo>
        <docKeyInfo>
            <name/>
            <type>DOC_PROPERTY</type>
            <sourceType>DICTIONARY</sourceType>
            <userModifiable>false</userModifiable>
            <rememberLastValue>false</rememberLastValue>
            <allowBlank>false</allowBlank>
            <listValue>false</listValue>
            <listId/>
            <propertyId/>
            <hidden>true</hidden>
        </docKeyInfo>
    </docKeyInfos>
    <dictionaryElements>
        <dictionaryElement>
            <id>321YY6E_000KQNESJ00000H</id>
            <name>Vendor Name</name>
            <mappedFields>
                <mappedField>
                    <fieldKey>DOC_FIELD2</fieldKey>
                </mappedField>
                <mappedField>
                    <fieldKey>DOC_PROPERTY</fieldKey>
                    <propertyId>321YY7C_000LGNM2X000001</propertyId>
                </mappedField>
                <mappedField/>
            </mappedFields>
        </dictionaryElement>
        <dictionaryElement>
            <id>321YY7J_000N0HXBG000029</id>
            <name>Address</name>
            <mappedFields/>
        </dictionaryElement>
    </dictionaryElements>
</applicationPlan>

ApplicationPlan (Version 5)

GET/v5/applicationPlan Gets all application plans if no type parameter provided or only those application plans of the t...

Expand Operation / Collapse Operation

Gets all application plans if no type parameter provided or only those application plans of the type or category type provided.

Available from version: 1.0.0

Call Properties

Query Parameters
learnModeType type (optional) Limits the response to the type of application plan provided
categoryType categoryType (optional) Limits the response to the category of applicaion plan provided
Response
Content
List of applicationPlan [applicationPlan]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

Represents a detailed application plan

Field Name Data Type Expected Description
canLink Boolean Yes This indicates whether the user can use this application plan to link documents.
canView Boolean Yes This indicates whether the user can use this application plan to search for documents.
id String Yes The unique ID of the application plan.
learnModeCategoryType categoryType Yes This indicates the category type of application plan. The learnModeCategoryType enumeration contains the possible values for this data element.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.
EXTERNAL_USER This is the External User LearnMode method, which is used for external applications, such as a scan application.

JSON Samples

Sample 1
Request URL
/v5/applicationPlan?learnModeType=WINDOW_WALKER
Response
{"applicationPlans":[{"id":"321YZDN_000076K3S000004","name":"Accounts Payable","learnModeType":"WINDOW_WALKER","learnModeCategoryType":"DOCUMENT","canLink":true,"canView":true},{"id":"321YZDN_000079K3S000008","name":"HRIS","learnModeType":"WINDOW_WALKER","learnModeCategoryType":"DOCUMENT","canLink":true,"canView":false}]}

XML Samples

Sample 1
Request URL
/v5/applicationPlan?learnModeType=WINDOW_WALKER
Response
<applicationPlans>
    <applicationPlan>
        <id>321YZDN_000076K3S000004</id>
        <name>Accounts Payable</name>
        <learnModeType>WINDOW_WALKER</learnModeType>
        <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
        <canLink>true</canLink>
        <canView>true</canView>
    </applicationPlan>
    <applicationPlan>
        <id>321YZDN_000079K3S000008</id>
        <name>HRIS</name>
        <learnModeType>WINDOW_WALKER</learnModeType>
        <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
        <canLink>true</canLink>
        <canView>false</canView>
    </applicationPlan>
</applicationPlans>

GET/v5/applicationPlan/script/{scriptId} Gets the script for the provided ID.

Expand Operation / Collapse Operation

Gets the script for the provided ID.

Available from version: 1.0.0

Call Properties

Response
Content
script
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

script type

Represents an Application Plan script.

Field Name Data Type Expected Description
text String Yes The text of the script.

JSON Samples

Sample 1
Request URL
/v5/applicationPlan/script/321Z01L_0001FZN29000001
Response
{"text":"workingValue='123.5'"}

XML Samples

Sample 1
Request URL
/v5/applicationPlan/script/321Z01L_0001FZN29000001
Response
<script>
    <text>workingValue='123.5'</text>
</script>

GET/v5/applicationPlan/{appPlanId} Gets an application plan with the given ID.

Expand Operation / Collapse Operation

Gets an application plan with the given ID.

Available from version: 1.0.0

Call Properties

Response
Content
applicationPlan
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

alphaNumericSettings type

Represents the settings for the alpha numeric macro.

Field Name Data Type Expected Description
type trimType Yes For alpha numeric macros, the type of characters to accept.
applicationPlan type

Represents a detailed application plan

Field Name Data Type Expected Description
description String Yes The description of the application plan.
dictionary List of dictionaryItem [dictionaryItem] Yes List of dictionary items for the application plan.
id String Yes The unique ID of the application plan.
learnModeCategoryType categoryType Yes This indicates the category type of application plan. The learnModeCategoryType enumeration contains the possible values for this data element.
learnModeIdentification learnModeIdentification No For LearnMode application plans, the information to identify the application
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan.
screens List of screen [screen] Yes list of screens for the application plan.
applicationPlanFolderInfo type

Represents the definition of a folder in an application plan

Field Name Data Type Expected Description
folderKeyInfos List of keyInfo [folderKeyInfo] Yes List of folder key info objects.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
concatenationSettings type

Represents the settings for the concatenation macro.

Field Name Data Type Expected Description
format String Yes For the concatenation macro, the format used to produce the output.
contextMap type

Represents a context map on a screen.

Field Name Data Type Expected Description
destinationType destinationType Yes The destination type of the context map.
docKeyInfos List of keyInfo [docKeyInfo] Yes List of objects describing each document key.
drawerInfo keyInfo Yes The information describing the drawer for the document
id String Yes The ID of the context map.
path List of applicationPlanFolderInfo [folderInfo] Yes This describes the folder path for the document.
dateSettings type

Represents the settings for the date macro.

Field Name Data Type Expected Description
format String Yes For the date macro, the date format used to parse the input.
deleteCharsSettings type

Represents the settings for the delete characters macro.

Field Name Data Type Expected Description
characters String Yes For the delete characters macro, the set of characters to remove.
destinationType enumeration

Describes the destination type of a context map.

Constant Name Description
DOCUMENT The context map contains information for a document.
FOLDER The context map contains information for a folder
SHORTCUT The context map contains information for a shortcut
RECORD The context map contains information for a record
dictionaryItem type

Represents an item in the dictionary of an application plan.

Field Name Data Type Expected Description
id String Yes The unique ID of the dictionary item.
macros List of macro [macro] Yes The macros and scripts on the dictionary item.
name String Yes The name of the dictionary item.
direction enumeration

Indicates which part of the string to remove characters.

Constant Name Description
FROM_LEFT Remove characters from the beginning of the string.
FROM_RIGHT Remove characters from the end of the string.
fixedLengthSettings type

Represents the settings for the fixed length macro.

Field Name Data Type Expected Description
direction direction Yes For fixed length macros, the direction to trim characters from.
length Integer Yes For fixed length macros, the character length to trim the string to.
keyInfo type

Represents an application plan's key info.

Field Name Data Type Expected Description
allowBlank boolean Yes This indicates whether this key value can be blank.
hidden boolean No This indicates Whether to hide this field/property from display.
listId String No The id of the list if this key info is a list.
listValue boolean Yes This indicates whether this key info is a list.
name String Yes The name of the key info.
propertyId String No The id of the property if this key info is a property.
rememberLastValue boolean Yes This indicates whether the key remembers the last value.
sourceData String No The source data value of the key info.
sourceType sourceType Yes The source type of the key info.
type keyType Yes The type of the key info.
userModifiable boolean Yes This indicates whether the user can modify this value.
keyType enumeration

Describes the type of the key.

Constant Name Description
DOC_TYPE Document type
DOC_DRAWER Drawer
DOC_FIELD1 Field1
DOC_FIELD2 Field2
DOC_FIELD3 Field3
DOC_FIELD4 Field4
DOC_FIELD5 Field5
DOC_PROPERTY Property
FOLDER_NAME Folder name
FOLDER_TYPE Folder type
FOLDER_PROPERTY Folder property
DOC_NAME Document name
DOC_SHORTCUT Document shortcut
RECORD_FILE_PLAN File plan
RECORD_CATEGORY Record Category
RECORD_FOLDER_NAME Folder name
RECORD_FOLDER_TYPE Folder type
RECORD_TYPE Type
RECORD_AUTHOR Author
RECORD_ORIGINATING_ORG Originating org
RECORD_PUBLICATION_DATE Publication date
RECORD_MEDIA_TYPE Media type
RECORD_FORMAT Format
RECORD_DATE_RECEIVED Date received
RECORD_ADDRESSEES Addressees
RECORD_OTHER_ADDRESSEES Other addressees
RECORD_LOCATION Location
RECORD_FOLDER_LOCATION Folder location
learnModeIdentification type

For LearnMode application plans, the information to identify the application window

Field Name Data Type Expected Description
type type Yes For LearnMode application plans, the method used to identify the application
value String Yes For LearnMode application plans, the value used to identify the application.
lineOffset enumeration

Indicates the line offset from the anchor text to process.

Constant Name Description
NONE No line offset; process the line containing the anchor text.
ABOVE_ANCHOR Process a line above the line with the anchor text.
BELOW_ANCHOR Process a line below the line with the anchor text.
lineSearchSettings type

Represents the settings for the line search macro.

Field Name Data Type Expected Description
direction searchDirection Yes For the line search macro, the direction to process lines.
lineCount Integer Yes For the line search macro, the number of lines to skip.
startCharacter Integer Yes For the line search macro, the character offset at which to start processing the line.
stopCharacters String Yes For the line search macro, the characters at which to stop processing.
stopLength Integer Yes For the line search macro, the number of characters to process.
stopMethod stopMethod Yes For the line search macro, the method used to stop processing.
macro type

Represents a macro in a dictionary item of an application plan.

Field Name Data Type Expected Description
alphaNumericSettings alphaNumericSettings No The settings for the alpha numeric macro.
concatenationSettings concatenationSettings No The settings for the concatenation macro.
dateSettings dateSettings No The settings for the date macro.
deleteCharsSettings deleteCharsSettings No The settings for the delete characters macro.
fixedLengthSettings fixedLengthSettings No The settings for the fixed length macro.
id String Yes The ID of the macro.
lineSearchSettings lineSearchSettings No The settings for the line search macro.
name String Yes The name of the macro.
numberSettings numberSettings No The settings for the number macro.
scriptSettings scriptSettings No The settings for the script macro.
staticSearchSettings staticSearchSettings No The settings for the static search macro.
tokenizerSettings tokenizerSettings No The settings for the tokenizer macro.
trimSettings trimSettings No The settings for the trim macro.
type macroType Yes Type type of the macro.
macroType enumeration

This is the macro type for a dictionary item

Constant Name Description
TRIM Trims leading or trailing characters from a string.
ALPHA_NUMERIC Removes characters from a string that are not numeric or alphabetic.
FIXED_LENGTH Removes characters from a string to reduce it to a fixed length.
DELETE_CHARACTERS Removes specified characters from a string.
DATE Parses a date and formats it to a fixed format.
NUMBER Formats a number.
SCRIPT Runs a LearnMode script.
STATIC_SEARCH Searches for text in a string.
LINE_SEARCH Returns a line from multi-line text.
CONCATENATION Concatenates text into a single string.
TOKENIZER Splits a string at a delimiter and returns a segment.
metadataType enumeration

Describes the source of a value for a metadata application plan.

Constant Name Description
FAX_SENDER For Fax Agent application plans, the senders ID.
FAX_DID For Fax Agent application plans, the DID.
FAX_CHANNEL For Fax Agent application plans, the fax channel.
EMAIL_TO For Email Agent application plans, the To field.
EMAIL_FROM For Email Agent application plans, the From field.
EMAIL_CC For Email Agent application plans, the CC field.
EMAIL_SUBJECT For Email Agent application plans, the Subject field.
EMAIL_REPLY_TO For Email Agent application plans, the Reply To field.
EMAIL_DATA For Email Agent application plans, the Data field.
EMAIL_ATTACHMENT_COUNT For Email Agent application plans, the number of attachments.
IMPORT_INDEX_LINE For Import Agent application plans, the text from the index file.
IMPORT_FILE_PATH For Import Agent application plans, the path of the imported file.
IMPORT_TEXT_FILE_PATH For Import Agent application plans, the text from the associated file.
SAP_DOC_CLIENT_DOC_ID For SAP Archivelink application plans, the SAP document ID.
SAP_DOC_REPOSITORY For SAP Archivelink application plans, the SAP content repository.
SAP_DOC_ADATE For SAP Archivelink application plans, the creation date.
SAP_DOC_ATIME For SAP Archivelink application plans, the creation time.
SAP_DOC_MDATE For SAP Archivelink application plans, the modification date.
SAP_DOC_MTIME For SAP Archivelink application plans, the modification time.
SAP_DOC_PROTECTION For SAP Archivelink application plans, the protection rules.
SAP_DOC_ALVERSION For SAP Archivelink application plans, the ArchiveLink version.
SAP_DOC_BARCODE For SAP Archivelink application plans, the barcode value.
INTERACT_OUTLOOK_TO For Interact Outlook application plans, the To field.
INTERACT_OUTLOOK_FROM For Interact Outlook application plans, the From field.
INTERACT_OUTLOOK_CC For Interact Outlook application plans, the CC field.
INTERACT_OUTLOOK_REPLY_TO For Interact Outlook application plans, the Reply To field.
INTERACT_OUTLOOK_SUBJECT For Interact Outlook application plans, the Subject.
INTERACT_OUTLOOK_ATTACHMENT_COUNT For Interact Outlook application plans, the number of attachments.
INTERACT_OUTLOOK_SEND_DATE For Interact Outlook application plans, the send date.
INTERACT_OUTLOOK_RECEIVE_DATE For Interact Outlook application plans, the received date.
INTERACT_OUTLOOK_PRIORITY For Interact Outlook application plans, the priority.
MOBILE_LATITUDE For mobile application plans, the latitude.
MOBILE_LONGITUDE For mobile application plans, the longitude.
MOBILE_HORIZONTAL_ACCURACY For mobile application plans, the horizontal accuracy.
numberSettings type

Represents the settings for the number macro.

Field Name Data Type Expected Description
decimalPlaces Integer Yes For the number macro, the number of decimal places to display.
decimalSymbol String Yes For the number macro, the decimal symbol.
screen type

Represents a screen of an application plan.

Field Name Data Type Expected Description
contextMaps List of contextMap [contextMap] Yes List of context maps for the screen.
id String Yes The ID of the screen.
label String Yes The label used to identify the screen.
learnModeSettings screenLearnMode No The settings for Learnmode screens.
name String Yes The screen name.
screenElements List of screenElement [screenElement] Yes List of screen elements for the screen.
viewCategory viewCategory No The view category for the screen view action.
viewId String No The view ID of the view for the screen view action.
viewText String No The VSL search string for the screen view action.
screenElement type

Represents the LearnMode mapping for a screen element of an application plan screen.

Field Name Data Type Expected Description
dictionaryItemId String Yes The ID of the dictionary item to assign the value to.
hyperlearnBitmapCoords String No For HyperLearn LearnMode, the coordinates of the bitmap.
hyperlearnFontInfo String No For HyperLearn LearnMode, the font information.
id String Yes The ID for the screen element.
ieControlName String No For Internet Explorer LearnMode, the control name.
metadataType metadataType No For Agent, Interact or Mobile application plans, the date value to use.
terminalKeyPosition Integer No For Terminal Capture LearnMode, the position in the screen buffer of the text.
terminalTextLength Integer No For Terminal Capture LearnMode, the length of the text in the screen buffer.
viewpointKeyInfo String No For Viewpoint LearnMode, the location of the control.
windowWalkerClassName String No For Window Walker LearnMode, the class name of the control to learn.
windowWalkerControlId String No For Window Walker LearnMode, the id of the control to learn.
windowWalkerDirections String No For Window Walker LearnMode, the hierarchy direction to the control to learn.
screenLearnMode type

For LearnMode application plans, the information to identify and learn a screen

Field Name Data Type Expected Description
clickPoint String No When using a click point, the coordinates.
connectDelay Integer No For terminal screens, the connect delay to use in milliseconds.
connectRetries Integer No For terminal screens, the number of retries to use.
connectString String No For terminal screens, the connect string to use.
identityElement screenElement No For screens using a screen identifier, the screen element used for identification.
scriptId String Yes For screens using a script to identify, the script ID.
useDefaultDelay Boolean No For terminal screens, use the default connect delay.
useDefaultRetries Boolean No For terminal screens, use the default retries.
scriptSettings type

Represents the settings for the script macro.

Field Name Data Type Expected Description
scriptId String Yes For the script macro, the ID of the script to execute.
searchDirection enumeration

Indicates the direction to search in the string.

Constant Name Description
FORWARD Search forward from the beginning.
BACKWARD Search backward from the end.
sourceType enumeration

Describes the type for a context map item source.

Constant Name Description
NONE No mapping.
DICTIONARY Mapped to a dictionary item.
LITERAL Mapped to a string literal.
USER_ENTRY Requires user entry.
PREDEFINED_LIST Mapped to a predefined list.
USER_NAME_SELECT Mapped to a list of user names.
USER_NAME_CURRENT Mapped to current user name.
USER_ID Mapped to user id.
DATE_TIME Mapped to a date.
SEQUENCE_NUM Mapped to a sequence number.
UNIQUE_ID Mapped to a unique id generator.
SCRIPT Mapped to a script.
BATCH_ID Mapped to a batch id.
SYSTEM_DRAWER Mapped to a drawer.
SYSTEM_DRAWER_LIST Mapped to a drawer list.
DOC_TYPE Mapped to a document type.
DOC_TYPE_LIST Mapped to a document type list.
FOLDER_TYPE Mapped to a folder type.
FOLDER_TYPE_LIST Mapped to a folder type list.
DOC_KEY Mapped to a document key.
DOC_PROPERTY Mapped to a document property.
LEGACY_FOLDER_TYPE Mapped to a folder type.
TARGET_NAME Mapped to a shortcut target name.
RECORD_FILE_PLAN Mapped to a record file plan.
RECORD_FOLDER_TYPE Mapped to a record folder type.
RECORD_TYPE Mapped to a record type.
RECORD_CATEGORY Mapped to a record category.
BARCODE Mapped to a name for a barcode value.
staticSearchSettings type

Represents the settings for the static search macro.

Field Name Data Type Expected Description
anchorText String Yes For the static search macro, the anchor text to search for.
lineOffset lineOffset Yes For the static search macro, the line offset from the anchor text to process.
lineOffsetCount Integer Yes For the static search macro, the number of lines to offset from the anchor text.
searchDirection searchDirection Yes For the static search macro, the direction from the anchor text to process.
stopCharacters String Yes For the static search macro, the characters at which to stop processing.
stopLength Integer Yes For the static search macro, the number of characters to process.
stopMethod stopMethod Yes For the static search macro, the method used to stop processing.
stopMethod enumeration

Indicates when to stop processing.

Constant Name Description
END_OF_LINE Process until the end of the line.
CHARACTER_LENGTH Process a fixed length.
STOPPING_CHARACTERS Process until the stopping characters.
tokenizerSettings type

Represents the settings for the tokenizer macro.

Field Name Data Type Expected Description
delimiter String Yes For the tokenizer macro, the string used to split the input into tokens.
position Integer Yes For the tokenizer macro, the index of the token to return.
trimDirection enumeration

Indicates where the trim macro should remove characters.

Constant Name Description
FROM_LEFT Remove trim characters from the beginning of the string.
FROM_RIGHT Remove trim characters from the end of the string.
BOTH Remove trim characters from both the beginning and the end of the string.
trimSettings type

Represents the settings for the trim macro.

Field Name Data Type Expected Description
characters String Yes For trim macros, the characters to trim.
direction trimDirection Yes For trim macros, the direction to trim.
lineNumber Integer Yes For trim macros, the line number of the input to process.
trimType enumeration

The class of characters the alpha numeric macro should preserve.

Constant Name Description
ALPHA_ONLY Only preserve alphabetic characters.
NUMERIC_ONLY Only preserve numeric characters.
ALPHA_NUMERIC_ONLY Only preserve alphabetic and numeric characters.
type enumeration

These are the possible identificationType values that describe how LearnMode searches for an application window.

Constant Name Description
APPLICATION_NAME This is the application name method which uses the process name to find the application.
CLASS_ID This is the class method which uses the window class name to find the application.
WINDOW_TITLE This is the window title method which uses the title text of the window to match the application.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.
EXTERNAL_USER This is the External User LearnMode method, which is used for external applications, such as a scan application.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the type of application plan view.

Constant Name Description
NONE No view action is defined.
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
RECORD_FOLDER_CONTENT The view is the record folder content view type.
RECORD The view is the record view type.
RECORD_FOLDER The view is the record folder view type.

JSON Samples

Sample 1
Request URL
/v5/applicationPlan/321Z01G_00017H6HM000001
Response
{"id":"321Z01G_00017H6HM000001","name":"Accounts Payable","description":"capture invoices by vendor or search for invoices by vendor","learnModeType":"WINDOW_WALKER","learnModeCategoryType":"DOCUMENT","learnModeIdentification":{"type":"WINDOW_TITLE","value":"Accounts Payable*"},"dictionary":[{"id":"321YZDN_000079K3S000009","name":"Vendor","macros":[{"id":"321Z01T_0001QBV0N000004","name":"Alpha Numeric","type":"ALPHA_NUMERIC","trimSettings":null,"alphaNumericSettings":{"type":"NUMERIC_ONLY"},"fixedLengthSettings":null,"deleteCharsSettings":null,"dateSettings":null,"numberSettings":null,"scriptSettings":null,"staticSearchSettings":null,"lineSearchSettings":null,"concatenationSettings":null,"tokenizerSettings":null},{"id":"321Z01T_0001QDV0X000004","name":"Number Format","type":"NUMBER","trimSettings":null,"alphaNumericSettings":null,"fixedLengthSettings":null,"deleteCharsSettings":null,"dateSettings":null,"numberSettings":{"decimalSymbol":".","decimalPlaces":2},"scriptSettings":null,"staticSearchSettings":null,"lineSearchSettings":null,"concatenationSettings":null,"tokenizerSettings":null}]},{"id":"321YZDN_00007FK3S000003","name":"Invoice ID","macros":[{"id":"321Z01T_0001QFYZV000004","name":"Script","type":"SCRIPT","trimSettings":null,"alphaNumericSettings":null,"fixedLengthSettings":null,"deleteCharsSettings":null,"dateSettings":null,"numberSettings":null,"scriptSettings":{"scriptId":"321Z01T_0001QHZ2E000004"},"staticSearchSettings":null,"lineSearchSettings":null,"concatenationSettings":null,"tokenizerSettings":null}]}],"screens":[{"id":"321Z01T_0001QKZ7D000004","name":"Vendor Search","label":"AP - Vendor Search","learnModeSettings":{"scriptId":null,"identityElement":null,"clickPoint":null,"connectString":null,"connectDelay":null,"connectRetries":null,"useDefaultDelay":null,"useDefaultRetries":null},"viewId":"321Z01T_0001QM9KC000004","viewCategory":"DOCUMENT","viewText":null,"screenElements":[{"id":"321Z01T_0001QREBQ000004","dictionaryItemId":"321YZDN_000079K3S000009","ieControlName":null,"hyperlearnFontInfo":null,"hyperlearnBitmapCoords":null,"viewpointKeyInfo":null,"windowWalkerClassName":"APTextBox","windowWalkerControlId":"74","windowWalkerDirections":"D3;L8;D1;L4;","terminalKeyPosition":null,"terminalTextLength":null,"metadataType":null},{"id":"321Z01T_0001QREBQ000004","dictionaryItemId":"321YZDN_000079K3S000009","ieControlName":null,"hyperlearnFontInfo":null,"hyperlearnBitmapCoords":null,"viewpointKeyInfo":null,"windowWalkerClassName":"APTextBox","windowWalkerControlId":"74","windowWalkerDirections":"D3;L8;D1;L4;","terminalKeyPosition":null,"terminalTextLength":null,"metadataType":null}],"contextMaps":[{"id":"321Z01T_0001QM9KC000004","destinationType":"DOCUMENT","drawerInfo":{"name":"","type":"DOC_DRAWER","sourceType":"SYSTEM_DRAWER","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true},"path":[{"folderKeyInfos":[{"name":"","type":"FOLDER_NAME","sourceType":"BARCODE","sourceData":"BarcodeName","userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"FOLDER_TYPE","sourceType":"FOLDER_TYPE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"FOLDER_PROPERTY","sourceType":"DATE_TIME","sourceData":null,"userModifiable":true,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false}]}],"docKeyInfos":[{"name":"","type":"DOC_NAME","sourceType":"DICTIONARY","sourceData":null,"userModifiable":true,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_FIELD1","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_FIELD2","sourceType":"UNIQUE_ID","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true},{"name":"","type":"DOC_FIELD3","sourceType":"DATE_TIME","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true},{"name":"","type":"DOC_FIELD4","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_FIELD5","sourceType":"NONE","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":true,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_TYPE","sourceType":"DICTIONARY","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":false},{"name":"","type":"DOC_PROPERTY","sourceType":"PREDEFINED_LIST","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":true,"listId":"321YZ2T_0000FFGPJ000002","propertyId":"","hidden":false},{"name":"","type":"DOC_PROPERTY","sourceType":"DICTIONARY","sourceData":null,"userModifiable":false,"rememberLastValue":false,"allowBlank":false,"listValue":false,"listId":"","propertyId":"","hidden":true}]}]}]}

XML Samples

Sample 1
Request URL
/v5/applicationPlan/321Z01G_00017H6HM000001
Response
<applicationPlan>
    <id>321Z01G_00017H6HM000001</id>
    <name>Accounts Payable</name>
    <description>capture invoices by vendor or search for invoices by vendor</description>
    <learnModeType>WINDOW_WALKER</learnModeType>
    <learnModeCategoryType>DOCUMENT</learnModeCategoryType>
    <learnModeIdentification>
        <type>WINDOW_TITLE</type>
        <value>Accounts Payable*</value>
    </learnModeIdentification>
    <dictionary>
        <dictionaryItem>
            <id>321YZDN_000079K3S000009</id>
            <name>Vendor</name>
            <macros>
                <macro>
                    <id>321Z01T_0001QBV0N000004</id>
                    <name>Alpha Numeric</name>
                    <type>ALPHA_NUMERIC</type>
                    <alphaNumericSettings>
                        <type>NUMERIC_ONLY</type>
                    </alphaNumericSettings>
                </macro>
                <macro>
                    <id>321Z01T_0001QDV0X000004</id>
                    <name>Number Format</name>
                    <type>NUMBER</type>
                    <numberSettings>
                        <decimalSymbol>.</decimalSymbol>
                        <decimalPlaces>2</decimalPlaces>
                    </numberSettings>
                </macro>
            </macros>
        </dictionaryItem>
        <dictionaryItem>
            <id>321YZDN_00007FK3S000003</id>
            <name>Invoice ID</name>
            <macros>
                <macro>
                    <id>321Z01T_0001QFYZV000004</id>
                    <name>Script</name>
                    <type>SCRIPT</type>
                    <scriptSettings>
                        <scriptId>321Z01T_0001QHZ2E000004</scriptId>
                    </scriptSettings>
                </macro>
            </macros>
        </dictionaryItem>
    </dictionary>
    <screens>
        <screen>
            <id>321Z01T_0001QKZ7D000004</id>
            <name>Vendor Search</name>
            <label>AP - Vendor Search</label>
            <learnModeSettings/>
            <viewId>321Z01T_0001QM9KC000004</viewId>
            <viewCategory>DOCUMENT</viewCategory>
            <screenElements>
                <screenElement>
                    <id>321Z01T_0001QREBQ000004</id>
                    <dictionaryItemId>321YZDN_000079K3S000009</dictionaryItemId>
                    <windowWalkerClassName>APTextBox</windowWalkerClassName>
                    <windowWalkerControlId>74</windowWalkerControlId>
                    <windowWalkerDirections>D3;L8;D1;L4;</windowWalkerDirections>
                </screenElement>
                <screenElement>
                    <id>321Z01T_0001QREBQ000004</id>
                    <dictionaryItemId>321YZDN_000079K3S000009</dictionaryItemId>
                    <windowWalkerClassName>APTextBox</windowWalkerClassName>
                    <windowWalkerControlId>74</windowWalkerControlId>
                    <windowWalkerDirections>D3;L8;D1;L4;</windowWalkerDirections>
                </screenElement>
            </screenElements>
            <contextMaps>
                <contextMap>
                    <id>321Z01T_0001QM9KC000004</id>
                    <destinationType>DOCUMENT</destinationType>
                    <drawerInfo>
                        <name/>
                        <type>DOC_DRAWER</type>
                        <sourceType>SYSTEM_DRAWER</sourceType>
                        <userModifiable>false</userModifiable>
                        <rememberLastValue>false</rememberLastValue>
                        <allowBlank>false</allowBlank>
                        <listValue>false</listValue>
                        <listId/>
                        <propertyId/>
                        <hidden>true</hidden>
                    </drawerInfo>
                    <path>
                        <folderInfo>
                            <folderKeyInfos>
<folderKeyInfo>
    <name/>
    <type>FOLDER_NAME</type>
    <sourceType>BARCODE</sourceType>
    <sourceData>BarcodeName</sourceData>
    <userModifiable>false</userModifiable>
    <rememberLastValue>false</rememberLastValue>
    <allowBlank>false</allowBlank>
    <listValue>false</listValue>
    <listId/>
    <propertyId/>
    <hidden>false</hidden>
</folderKeyInfo>
<folderKeyInfo>
    <name/>
    <type>FOLDER_TYPE</type>
    <sourceType>FOLDER_TYPE</sourceType>
    <userModifiable>false</userModifiable>
    <rememberLastValue>false</rememberLastValue>
    <allowBlank>false</allowBlank>
    <listValue>false</listValue>
    <listId/>
    <propertyId/>
    <hidden>false</hidden>
</folderKeyInfo>
<folderKeyInfo>
    <name/>
    <type>FOLDER_PROPERTY</type>
    <sourceType>DATE_TIME</sourceType>
    <userModifiable>true</userModifiable>
    <rememberLastValue>false</rememberLastValue>
    <allowBlank>false</allowBlank>
    <listValue>false</listValue>
    <listId/>
    <propertyId/>
    <hidden>false</hidden>
</folderKeyInfo>
                            </folderKeyInfos>
                        </folderInfo>
                    </path>
                    <docKeyInfos>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_NAME</type>
                            <sourceType>DICTIONARY</sourceType>
                            <userModifiable>true</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>false</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>false</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_FIELD1</type>
                            <sourceType>NONE</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>true</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>false</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_FIELD2</type>
                            <sourceType>UNIQUE_ID</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>false</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>true</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_FIELD3</type>
                            <sourceType>DATE_TIME</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>false</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>true</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_FIELD4</type>
                            <sourceType>NONE</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>true</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>false</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_FIELD5</type>
                            <sourceType>NONE</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>true</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>false</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_TYPE</type>
                            <sourceType>DICTIONARY</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>false</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>false</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_PROPERTY</type>
                            <sourceType>PREDEFINED_LIST</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>false</allowBlank>
                            <listValue>true</listValue>
                            <listId>321YZ2T_0000FFGPJ000002</listId>
                            <propertyId/>
                            <hidden>false</hidden>
                        </docKeyInfo>
                        <docKeyInfo>
                            <name/>
                            <type>DOC_PROPERTY</type>
                            <sourceType>DICTIONARY</sourceType>
                            <userModifiable>false</userModifiable>
                            <rememberLastValue>false</rememberLastValue>
                            <allowBlank>false</allowBlank>
                            <listValue>false</listValue>
                            <listId/>
                            <propertyId/>
                            <hidden>true</hidden>
                        </docKeyInfo>
                    </docKeyInfos>
                </contextMap>
            </contextMaps>
        </screen>
    </screens>
</applicationPlan>

CaptureGroup (Version 1)

POST/v1/captureGroup/ Creates a capture group that can be used to capture a group of pages into one or more documents

Expand Operation / Collapse Operation

Creates a capture group that can be used to capture a group of pages into one or more documents

Available from version: 1.0.0

Call Properties

Request
Content captureGroupInfo
Content-Types
  • application/xml
  • application/json
Response
Content
captureGroup
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureGroup type

Field Name Data Type Expected Description
context captureGroupContext Yes
id String Yes
captureGroupContext type

Field Name Data Type Expected Description
documentContext documentContext No
drawerName String Yes
folderContexts List of folderContext [folderContext] Yes
shortcutContexts List of shortcutContext [shortcutContext] Yes
captureGroupInfo type

Field Name Data Type Expected Description
captureProfileId String Yes
sourceMetadataPairs List of keyValuePair [sourceMetadataPair] No
documentContext type

Field Name Data Type Expected Description
documentName String Yes
documentType String Yes
field1 String Yes
field2 String Yes
field3 String Yes
field4 String Yes
field5 String Yes
propertyValues List of propertyValue [propertyValue] Yes
folderContext type

Field Name Data Type Expected Description
folderTypeName String Yes
name String Yes
propertyValues List of propertyValue [propertyValue] Yes
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
propertyValue type

Field Name Data Type Expected Description
id String Yes
value String Yes
shortcutContext type

Field Name Data Type Expected Description
drawerName String Yes
folderContexts List of folderContext [folderContext] Yes
shortcutName String Yes

JSON Samples

Sample 1
Request URL
/v1/captureGroup
Request
{"captureProfileId":"","sourceMetadataPairs":[{"key":"interact.outlook.property.to","value":"admin@domain.com"},{"key":"interact.outlook.property.from","value":"user@domain.com"}]}
Response
{"id":"301YW37_0001D9CBG0000FN","context":{"drawerName":"Default","documentContext":{"field1":"admin@domain.com","field2":"user@domain.com","field3":"","field4":"","field5":"","documentType":"Default","documentName":"Benefits Summary","propertyValues":[]},"folderContexts":[{"name":"Archive Email","folderTypeName":"Default","propertyValues":[]}],"shortcutContexts":[{"drawerName":"Default","shortcutName":"","folderContexts":[]}]}}

XML Samples

Sample 1
Request URL
/v1/captureGroup
Request
<captureGroupInfo>
    <captureProfileId/>
    <sourceMetadataPairs>
        <sourceMetadataPair>
            <key>interact.outlook.property.to</key>
            <value>admin@domain.com</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>interact.outlook.property.from</key>
            <value>user@domain.com</value>
        </sourceMetadataPair>
    </sourceMetadataPairs>
</captureGroupInfo>
Response
<captureGroup>
    <id>301YW37_0001D9CBG0000FN</id>
    <context>
        <drawerName>Default</drawerName>
        <folderContexts>
            <folderContext>
                <name>Archive Email</name>
                <folderTypeName>Default</folderTypeName>
                <propertyValues/>
            </folderContext>
        </folderContexts>
        <documentContext>
            <field1>admin@domain.com</field1>
            <field2>user@domain.com</field2>
            <field3/>
            <field4/>
            <field5/>
            <documentType>Default</documentType>
            <documentName>Benefits Summary</documentName>
            <propertyValues/>
        </documentContext>
        <shortcutContexts>
            <shortcutContext>
                <drawerName>Default</drawerName>
                <folderContexts/>
                <shortcutName/>
            </shortcutContext>
        </shortcutContexts>
    </context>
</captureGroup>

PUT/v1/captureGroup/{id} Completes the capture process for a captured document group.

Expand Operation / Collapse Operation

Completes the capture process for a captured document group.

Available from version: 1.0.0

Call Properties

Query Parameter
captureProfileId The capture profile associated with the capture group to be committed.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/captureGroup/301YW1E_00077ZVD900003H?captureProfileId=301YT3D_003ESEWKF000017

XML Samples

Sample 1
Request URL
/v1/captureGroup/301YW1E_00077ZVD900003H?captureProfileId=301YT3D_003ESEWKF000017

POST/v1/captureGroup/{id}/page Captures a page to a capture group

Expand Operation / Collapse Operation

Captures a page to a capture group

Available from version: 1.0.0

Call Properties

Request
Content Multipart
Content-Type
  • multipart/form-data
Additional Header
X-IntegrationServer-File-Size The size of the page being added to the capture group.
Multipart Parameters
captureGroupPageInfo captureGroupPageInfo The location, keys, and custom properties of the document to which the page will be captured.
pageData Binary The page (binary data) to be captured.
Response
Content
captureGroupPage
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureGroupPage type

Field Name Data Type Expected Description
documentId String Yes
emailMetadataId String No
logobId String Yes
pageNumber Integer Yes
shortcutIds List of String [shortcutId] Yes
captureGroupPageContext type

Field Name Data Type Expected Description
documentContext documentContext Yes
drawerName String No
folderContexts List of folderContext [folderContext] No
parentFolderId String No
shortcutContexts List of shortcutContext [shortcutContext] No
captureGroupPageEmailMetadata type

Represents the email metadata that we capture.

Field Name Data Type Expected Description
bccAddresses List of String [bccAddress] No A List of the bcc addresses.
ccAddresses List of String [ccAddress] No A List of the cc addresses.
fromAddress String Yes The address of the sender.
receivedTime Long No The time the email was recevied.
replyToAddresses List of String [replyToAddress] No A List of the reply to addresses.
sentTime Long No The time the email was sent.
subject String No The subject of the email.
toAddresses List of String [toAddress] No A List of the to addresses.
captureGroupPageInfo type

Field Name Data Type Expected Description
emailMetadata captureGroupPageEmailMetadata No If the page being captured is an email, the email metadata can be included so that the email can be stored as a record.
emailMetadataId String No If the page being captured is an email, the email metadata ID can be included so that the email can be stored as a record.
pageContext captureGroupPageContext Yes
pageMetadata captureGroupPageMetadata No
captureGroupPageMetadata type

Field Name Data Type Expected Description
fileType String Yes
scanTime Long Yes
scanUserId String Yes
scanUserName String Yes
sourcePageNumber Integer Yes
sourceType phsobSourceType Yes
workingName String Yes
documentContext type

Field Name Data Type Expected Description
documentName String No
documentType String Yes
field1 String No
field2 String No
field3 String No
field4 String No
field5 String No
propertyValues List of propertyValue [propertyValue] No
folderContext type

Field Name Data Type Expected Description
folderTypeName String Yes
name String Yes
propertyValues List of propertyValue [propertyValue] No
phsobSourceType enumeration

Represents the type of the source for the phsob

Constant Name Description
NONE
BATCH_SCAN
BATCH_IMPORT
BATCH_INPRINT
SINGLE_SCAN
SINGLE_IMPORT
SINGLE_INPRINT
PACKAGE
VIEWER_ADD_SCAN
VIEWER_ADD_IMPORT
COPY_PAGE
FAX_AGENT
IMP_AGENT
MSG_AGENT
MAIL_AGENT
EOB_AGENT
ISIR_AGENT
ISCRIPT
EH_AGENT
REDACTION
propertyValue type

Field Name Data Type Expected Description
id String Yes
value String Yes
shortcutContext type

Field Name Data Type Expected Description
drawerName String Yes
folderContexts List of folderContext [folderContext] Yes
shortcutName String Yes

JSON Samples

Sample 1
Request URL
/v1/captureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="captureGroupPageInfo"
Content-Transfer-Encoding: binary

{"pageContext":{"drawerName":"Accounting","parentFolderId":null,"documentContext":{"field1":"admin@domain.com","field2":"user@domain.com","field3":"","field4":"","field5":"","documentType":"Expenses","documentName":"Document1","propertyValues":[]},"folderContexts":[{"name":"Archive 301YW37_0001D7CBG0000F2","folderTypeName":"Default","propertyValues":[]}],"shortcutContexts":[{"drawerName":"Default","shortcutName":"","folderContexts":[]}]},"pageMetadata":{"fileType":"TXT","workingName":"text.txt","scanUserName":null,"scanUserId":null,"scanTime":null,"sourceType":null,"sourcePageNumber":null},"emailMetadataId":null,"emailMetadata":null}
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"documentId":"301YW37_0001DPCBH0000K2","pageNumber":1,"logobId":"301YW37_0001DPCBH0000K5","emailMetadataId":null,"shortcutIds":["301YW37_0001DPCBH0000K8"]}

XML Samples

Sample 1
Request URL
/v1/captureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="captureGroupPageInfo"
Content-Transfer-Encoding: binary

<captureGroupPageInfo>
    <pageContext>
        <drawerName>Accounting</drawerName>
        <folderContexts>
            <folderContext>
                <name>Archive 301YW37_0001D7CBG0000F2</name>
                <folderTypeName>Default</folderTypeName>
                <propertyValues/>
            </folderContext>
        </folderContexts>
        <documentContext>
            <field1>admin@domain.com</field1>
            <field2>user@domain.com</field2>
            <field3/>
            <field4/>
            <field5/>
            <documentType>Expenses</documentType>
            <documentName>Document1</documentName>
            <propertyValues/>
        </documentContext>
        <shortcutContexts>
            <shortcutContext>
                <drawerName>Default</drawerName>
                <folderContexts/>
                <shortcutName/>
            </shortcutContext>
        </shortcutContexts>
    </pageContext>
    <pageMetadata>
        <fileType>TXT</fileType>
        <workingName>text.txt</workingName>
    </pageMetadata>
</captureGroupPageInfo>
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<captureGroupPage>
    <documentId>301YW37_0001DPCBH0000K2</documentId>
    <pageNumber>1</pageNumber>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <shortcutIds>
        <shortcutId>301YW37_0001DPCBH0000K8</shortcutId>
    </shortcutIds>
</captureGroupPage>

CaptureProfile (Version 1)

GET/v1/captureProfile This API call requests the list of active capture profiles stored in ImageNow Server. Integration...

Expand Operation / Collapse Operation

This API call requests the list of active capture profiles stored in ImageNow Server. Integration Server structures the response using the captureProfile type, which includes the capture profile ID, name, description, and type, along with the capture source type. The captureProfileType enumeration provides the possible values for the general capture profile type, such as INTERACT or AGENT, and the captureSourceType enumeration provides the possible values for the capture source, such as INTERACT_OUTLOOK or IMPORT_AGENT.

Available from version: 1.0.0

Example 1 in the following table shows a response from a query without the sourceType parameter. Example 2 shows a response from a query where the sourceType parameter is INTERACT_OUTLOOK.

Call Properties

Query Parameter
sourceType sourceType (optional) Source type filtering
You can filter capture profiles by capture source type using the optional sourceType query parameter. In this case, ImageNow Server returns the capture profiles that match the specific source type, such as Interact for Outlook or Import Agent. The captureSourceType enumeration provides the possible values for the sourceType parameter.
Response
Content
List of captureProfile [captureProfile]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureProfile type

The captureProfile type provides the structure for the data Integration Server returns for an ImageNow capture profile.

Field Name Data Type Expected Description
description String Yes The description of the capture profile as it is in your ImageNow system.
id String Yes The unique ID of the capture profile.
name String Yes The name of the capture profile as it is in your ImageNow system.
sourceType sourceType Yes The capture source for the capture profile, such as INTERACT_OUTLOOK for Interact for Outlook.
type captureProfileType Yes The general type of capture profile, such as AGENT for Fax Agent or Import Agent.
captureProfileType enumeration

This table lists the possible values for the captureProfile enumeration, which provides the general capture profile type.

Constant Name Description
AGENT The capture profile type is an ImageNow agent, such as Fax Agent or Import Agent.
INTERACT The capture profile type is an ImageNow interact, such as Interact for Outlook.
EXTERNAL The capture profile type is an ImageNow external, such as External Interface.
MOBILE The capture profile type is an ImageNow mobile. This is not documented in version one of the call to get all capture profiles.
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.

JSON Samples

Sample 1 - sourceType parameter excluded
Request URL
/v1/captureProfile
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook","description":"Interact for Outlook capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK"},{"id":"301YW1B_0005SKH3J00001V","name":"SAP","description":"Connector for SAP capture profile","type":"INTERACT","sourceType":"CONNECTOR_SAP"},{"id":"301YW1C_0005SFH3J00003T","name":"Import Agent","description":"Import Agent capture profile","type":"AGENT","sourceType":"IMPORT_AGENT"}]}
Sample 2 - sourceType parameter included
Request URL
/v1/captureProfile?sourceType=INTERACT_OUTLOOK
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook_AP","description":"Interact for Outlook profile: Accounts Payable","type":"INTERACT","sourceType":"INTERACT_OUTLOOK"},{"id":"301YW1B_0005S9H3J00003E","name":"Interact for Outlook_DEV","description":"Interact for Outlook profile: Development","type":"INTERACT","sourceType":"INTERACT_OUTLOOK"},{"id":"301YW1C_0005SEH3J000044","name":"Interact for Outlook_HR","description":"Interact for Outlook profile: Human Resources","type":"INTERACT","sourceType":"INTERACT_OUTLOOK"}]}

XML Samples

Sample 1 - sourceType parameter excluded
Request URL
/v1/captureProfile
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook</name>
        <description>Interact for Outlook capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
    </captureProfile>
    <captureProfile>
        <id>301YW1B_0005SKH3J00001V</id>
        <name>SAP</name>
        <description>Connector for SAP capture profile</description>
        <type>INTERACT</type>
        <sourceType>CONNECTOR_SAP</sourceType>
    </captureProfile>
    <captureProfile>
        <id>301YW1C_0005SFH3J00003T</id>
        <name>Import Agent</name>
        <description>Import Agent capture profile</description>
        <type>AGENT</type>
        <sourceType>IMPORT_AGENT</sourceType>
    </captureProfile>
</captureProfiles>
Sample 2 - sourceType parameter included
Request URL
/v1/captureProfile?sourceType=INTERACT_OUTLOOK
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook_AP</name>
        <description>Interact for Outlook profile: Accounts Payable</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
    </captureProfile>
    <captureProfile>
        <id>301YW1B_0005S9H3J00003E</id>
        <name>Interact for Outlook_DEV</name>
        <description>Interact for Outlook profile: Development</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
    </captureProfile>
    <captureProfile>
        <id>301YW1C_0005SEH3J000044</id>
        <name>Interact for Outlook_HR</name>
        <description>Interact for Outlook profile: Human Resources</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
    </captureProfile>
</captureProfiles>

GET/v1/captureProfile/applicationPlan/itemList/{id} This API call requests the context map item list stored in ImageNow Server that matches the given...

Expand Operation / Collapse Operation

This API call requests the context map item list stored in ImageNow Server that matches the given list source type. Note that the request must include one of the following values in the listSourceType query parameter, which is the source type of the list to retrieve.

Available from version: 1.0.0

Call Properties

Query Parameter
listSourceType listSourceType The source type of the list to fetch.
Response
Content
itemList
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

itemList type

Represents a context map item list.

Field Name Data Type Expected Description
id String Yes The item list id.
items List of String [item] Yes Represent the items in the list, which can be usernames, document type names, or items from a predefined list.
listSourceType listSourceType Yes The item list type.
listSourceType enumeration

Represents the context map item source type for a list based source type.

Constant Name Description
PREDEFINED_LIST The context map item accepts an item from a predefined list of items.
USER_NAME_SELECT The context map item accepts a username from a group of users.
DOC_TYPE_LIST The context map item accepts a doc type from a doc type list.

JSON Samples

Sample 1
Request URL
/v1/captureProfile/applicationPlan/itemList/agents?listSourceType=USER_NAME_SELECT
Response
{"id":"agents","listSourceType":"USER_NAME_SELECT","items":["alarm.agent","batch.agent"]}

XML Samples

Sample 1
Request URL
/v1/captureProfile/applicationPlan/itemList/agents?listSourceType=USER_NAME_SELECT
Response
<itemList>
    <id>agents</id>
    <listSourceType>USER_NAME_SELECT</listSourceType>
    <items>
        <item>alarm.agent</item>
        <item>batch.agent</item>
    </items>
</itemList>

GET/v1/captureProfile/{id} This API call requests the capture profile stored in ImageNow Server that matches the given ID. I...

Expand Operation / Collapse Operation

This API call requests the capture profile stored in ImageNow Server that matches the given ID. Integration Server structures the response using the captureProfile type, which provides detailed information about the capture profile and includes the applicationPlan type, which provides information about the associated application plan.

Available from version: 1.0.0

Call Properties

Response
Content
captureProfile
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

The applicationPlan type provides the structure for the data ImageNow Server returns for an ImageNow application plan.

Field Name Data Type Expected Description
description String Yes The description of the application plan type in your ImageNow system.
docKeyInfos List of docKeyInfo [docKeyInfo] Yes List of document key info objects which contain information about configuration of document keys.
id String Yes The unique ID of the application plan type.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan type in your ImageNow system.
captureProfile type

The captureProfile type provides the structure for the data Integration Server returns for an ImageNow capture profile.

Field Name Data Type Expected Description
addToVersionControl boolean Yes This indicates whether ImageNow Server adds the documents to version control when using this capture profile.
applicationPlan applicationPlan Yes The application plan associated with the capture profile.
description String Yes The description of the capture profile as it is in your ImageNow system.
id String Yes The unique ID of the capture profile.
name String Yes The name of the capture profile as it is in your ImageNow system.
sourceProfileId String No The ID of the capture source profile associated with the capture profile.
sourceType sourceType Yes The capture source for the capture profile, such as INTERACT_OUTLOOK for Interact for Outlook.
submitToContent boolean Yes This indicates whether ImageNow Server submits the documents to Content Server when using this capture profile.
type captureProfileType Yes The general type of capture profile, such as AGENT for Fax Agent or Import Agent.
wfQueueId String No This is the ID of the workflow queue in which ImageNow Server places the documents when using this capture profile.
captureProfileType enumeration

This table lists the possible values for the captureProfile enumeration, which provides the general capture profile type.

Constant Name Description
AGENT The capture profile type is an ImageNow agent, such as Fax Agent or Import Agent.
INTERACT The capture profile type is an ImageNow interact, such as Interact for Outlook.
EXTERNAL The capture profile type is an ImageNow external, such as External Interface.
MOBILE The capture profile type is an ImageNow mobile. This is not documented in version one of the call to get all capture profiles.
docKeyInfo type

Represents an application plan's document key info.

Field Name Data Type Expected Description
allowBlank boolean Yes Can this value be blank
listId String No If a list, the id of the list
listValue boolean Yes Is this a list
name String Yes The caption name
sourceType sourceType Yes The source type
type keyType Yes The caption type
userModifiable boolean Yes Can the user modify this value
keyType enumeration

Describes the type of the key.

Constant Name Description
DOC_TYPE Document type
DOC_DRAWER Drawer
DOC_FIELD1 Field1
DOC_FIELD2 Field2
DOC_FIELD3 Field3
DOC_FIELD4 Field4
DOC_FIELD5 Field5
DOC_PROPERTY Property
FOLDER_NAME Folder name
FOLDER_TYPE Folder type
FOLDER_PROPERTY Folder property
DOC_NAME Document name
DOC_SHORTCUT Document shortcut
sourceType enumeration

Describes the type for a context map item source.

Constant Name Description
NONE No mapping.
DICTIONARY Mapped to a dictionary item.
LITERAL Mapped to a string literal.
USER_ENTRY Requires user entry.
PREDEFINED_LIST Mapped to a predefined list.
USER_NAME_SELECT Mapped to a list of user names.
USER_NAME_CURRENT Mapped to current user name.
USER_ID Mapped to user id.
DATE_TIME Mapped to a date.
SEQUENCE_NUM Mapped to a sequence number.
UNIQUE_ID Mapped to a unique id generator.
SCRIPT Mapped to a script.
BATCH_ID Mapped to a batch id.
SYSTEM_DRAWER Mapped to a drawer.
SYSTEM_DRAWER_LIST Mapped to a drawer list.
DOC_TYPE Mapped to a document type.
DOC_TYPE_LIST Mapped to a document type list.
FOLDER_TYPE Mapped to a folder type.
FOLDER_TYPE_LIST Mapped to a folder type list.
DOC_KEY Mapped to a document key.
DOC_PROPERTY Mapped to a document property.
LEGACY_FOLDER_TYPE Mapped to a folder type.
TARGET_NAME Mapped to a shortcut target name.
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.

JSON Samples

Sample 1
Request URL
/v1/captureProfile/301YV77_0001EF54P000001
Response
{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook","description":"Interact for Outlook capture profile","type":"INTERACT","wfQueueId":"301YU1C_0005SCH3K005069","sourceType":"INTERACT_OUTLOOK","sourceProfileId":"301YW1C_0005SJH3J00006H","applicationPlan":{"id":"301YW1C_0005SJH3J000063","name":"Interact for Outlook Plan","description":"Interact for Outlook application plan","learnModeType":"INTERACT_OUTLOOK","docKeyInfos":[{"name":"Label1","type":"DOC_NAME","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""},{"name":"Label2","type":"DOC_FIELD1","sourceType":"LITERAL","userModifiable":true,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label3","type":"DOC_FIELD2","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label4","type":"DOC_FIELD3","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label5","type":"DOC_FIELD4","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label6","type":"DOC_FIELD5","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label7","type":"DOC_TYPE","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""}]},"addToVersionControl":false,"submitToContent":false}

XML Samples

Sample 1
Request URL
/v1/captureProfile/301YV77_0001EF54P000001
Response
<captureProfile>
    <id>301YVD5_0001SVVK100000V</id>
    <name>Interact for Outlook</name>
    <description>Interact for Outlook capture profile</description>
    <type>INTERACT</type>
    <wfQueueId>301YU1C_0005SCH3K005069</wfQueueId>
    <sourceType>INTERACT_OUTLOOK</sourceType>
    <sourceProfileId>301YW1C_0005SJH3J00006H</sourceProfileId>
    <applicationPlan>
        <id>301YW1C_0005SJH3J000063</id>
        <name>Interact for Outlook Plan</name>
        <description>Interact for Outlook application plan</description>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
        <docKeyInfos>
            <docKeyInfo>
                <name>Label1</name>
                <type>DOC_NAME</type>
                <sourceType>DICTIONARY</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>false</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label2</name>
                <type>DOC_FIELD1</type>
                <sourceType>LITERAL</sourceType>
                <userModifiable>true</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label3</name>
                <type>DOC_FIELD2</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label4</name>
                <type>DOC_FIELD3</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label5</name>
                <type>DOC_FIELD4</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label6</name>
                <type>DOC_FIELD5</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label7</name>
                <type>DOC_TYPE</type>
                <sourceType>DICTIONARY</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>false</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
        </docKeyInfos>
    </applicationPlan>
    <addToVersionControl>false</addToVersionControl>
    <submitToContent>false</submitToContent>
</captureProfile>

CaptureProfile (Version 2)

GET/v2/captureProfile This API call requests the list of active capture profiles stored in ImageNow Server. Integration...

Expand Operation / Collapse Operation

This API call requests the list of active capture profiles stored in ImageNow Server. Integration Server structures the response using the captureProfile type, which includes the capture profile ID, name, description, and type, along with the capture source type. The captureProfileType enumeration provides the possible values for the general capture profile type, such as INTERACT or AGENT, and the captureSourceType enumeration provides the possible values for the capture source, such as INTERACT_OUTLOOK or IMPORT_AGENT.

Available from version: 1.0.0

Example 1 in the following table shows a response from a query without the sourceType parameter. Example 2 shows a response from a query where the sourceType parameter is INTERACT_OUTLOOK. Example 3 shows a response from a query where the categoryType parameter is DOCUMENT.

Call Properties

Query Parameters
sourceType sourceType (optional) Source type filtering
You can filter capture profiles by capture source type using the optional sourceType query parameter. In this case, ImageNow Server returns the capture profiles that match the specific source type, such as Interact for Outlook or Import Agent. The captureSourceType enumeration provides the possible values for the sourceType parameter.
categoryType categoryType (optional) Category type filtering
You can filter capture profiles by capture category type using the optional categoryType query parameter. In this case, ImageNow Server returns the capture profiels that match the specific category type. The categoryType enumeration provides the possible values for the categoryType parameter.
Response
Content
List of captureProfile [captureProfile]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureProfile type

The captureProfile type provides the structure for the data Integration Server returns for an ImageNow capture profile.

Field Name Data Type Expected Description
categoryType categoryType Yes The category for the capture profile, such as RECORD or DOCUMENT.
description String Yes The description of the capture profile as it is in your ImageNow system.
id String Yes The unique ID of the capture profile.
name String Yes The name of the capture profile as it is in your ImageNow system.
sourceType sourceType Yes The capture source for the capture profile, such as INTERACT_OUTLOOK for Interact for Outlook.
type captureProfileType Yes The general type of capture profile, such as AGENT for Fax Agent or Import Agent.
captureProfileType enumeration

This table lists the possible values for the captureProfile enumeration, which provides the general capture profile type.

Constant Name Description
AGENT The capture profile type is an ImageNow agent, such as Fax Agent or Import Agent.
INTERACT The capture profile type is an ImageNow interact, such as Interact for Outlook.
EXTERNAL The capture profile type is an ImageNow external, such as External Interface.
MOBILE The capture profile type is Mobile.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.

JSON Samples

Sample 1 - sourceType parameter excluded
Request URL
/v2/captureProfile
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook: Documents","description":"Interact for Outlook documents capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT"},{"id":"301YW1B_0005SKH3J00001V","name":"Interact for Outlook: Records","description":"Interact for Outlook records capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"RECORD"},{"id":"301YW1C_0005SFH3J00003T","name":"Import Agent","description":"Import Agent capture profile","type":"AGENT","sourceType":"IMPORT_AGENT","categoryType":"DOCUMENT"}]}
Sample 2 - sourceType parameter included
Request URL
/v2/captureProfile?sourceType=INTERACT_OUTLOOK
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook: Documents","description":"Interact for Outlook documents capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT"},{"id":"301YW1B_0005SKH3J00001V","name":"Interact for Outlook: Records","description":"Interact for Outlook records capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"RECORD"}]}
Sample 3 - categoryType parameter included
Request URL
/v2/captureProfile?categoryType=DOCUMENT
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook: Documents","description":"Interact for Outlook documents capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT"}]}

XML Samples

Sample 1 - sourceType parameter excluded
Request URL
/v2/captureProfile
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook: Documents</name>
        <description>Interact for Outlook documents capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
    <captureProfile>
        <id>301YW1B_0005SKH3J00001V</id>
        <name>Interact for Outlook: Records</name>
        <description>Interact for Outlook records capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>RECORD</categoryType>
    </captureProfile>
    <captureProfile>
        <id>301YW1C_0005SFH3J00003T</id>
        <name>Import Agent</name>
        <description>Import Agent capture profile</description>
        <type>AGENT</type>
        <sourceType>IMPORT_AGENT</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
</captureProfiles>
Sample 2 - sourceType parameter included
Request URL
/v2/captureProfile?sourceType=INTERACT_OUTLOOK
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook: Documents</name>
        <description>Interact for Outlook documents capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
    <captureProfile>
        <id>301YW1B_0005SKH3J00001V</id>
        <name>Interact for Outlook: Records</name>
        <description>Interact for Outlook records capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>RECORD</categoryType>
    </captureProfile>
</captureProfiles>
Sample 3 - categoryType parameter included
Request URL
/v2/captureProfile?categoryType=DOCUMENT
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook: Documents</name>
        <description>Interact for Outlook documents capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
</captureProfiles>

GET/v2/captureProfile/{id} This API call requests the capture profile stored in ImageNow Server that matches the given ID. I...

Expand Operation / Collapse Operation

This API call requests the capture profile stored in ImageNow Server that matches the given ID. Integration Server structures the response using the captureProfile type, which provides detailed information about the capture profile and includes the applicationPlan type, which provides information about the associated application plan.

Available from version: 1.0.0

Call Properties

Response
Content
captureProfile
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

applicationPlan type

The applicationPlan type provides the structure for the data ImageNow Server returns for an ImageNow application plan.

Field Name Data Type Expected Description
description String Yes The description of the application plan type in your ImageNow system.
docKeyInfos List of docKeyInfo [docKeyInfo] Yes List of document key info objects which contain information about configuration of document keys.
id String Yes The unique ID of the application plan type.
learnModeType type Yes This indicates the type of application plan. The learnModeType enumeration contains the possible values for this data element.
name String Yes The name of the application plan type in your ImageNow system.
captureProfile type

The captureProfile type provides the structure for the data Integration Server returns for an ImageNow capture profile.

Field Name Data Type Expected Description
addToVersionControl boolean Yes This indicates whether ImageNow Server adds the documents to version control when using this capture profile.
applicationPlan applicationPlan Yes The application plan associated with the capture profile.
categoryType categoryType Yes The category for the capture profile, such as DOCUMENT or RECORD.
description String Yes The description of the capture profile as it is in your ImageNow system.
id String Yes The unique ID of the capture profile.
name String Yes The name of the capture profile as it is in your ImageNow system.
sourceProfileId String No The ID of the capture source profile associated with the capture profile.
sourceType sourceType Yes The capture source for the capture profile, such as INTERACT_OUTLOOK for Interact for Outlook.
submitToContent boolean Yes This indicates whether ImageNow Server submits the documents to Content Server when using this capture profile.
type captureProfileType Yes The general type of capture profile, such as AGENT for Fax Agent or Import Agent.
wfQueueId String No This is the ID of the workflow queue in which ImageNow Server places the documents when using this capture profile.
captureProfileType enumeration

This table lists the possible values for the captureProfile enumeration, which provides the general capture profile type.

Constant Name Description
AGENT The capture profile type is an ImageNow agent, such as Fax Agent or Import Agent.
INTERACT The capture profile type is an ImageNow interact, such as Interact for Outlook.
EXTERNAL The capture profile type is an ImageNow external, such as External Interface.
MOBILE The capture profile type is Mobile.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
docKeyInfo type

Represents an application plan's document key info.

Field Name Data Type Expected Description
allowBlank boolean Yes Can this value be blank
listId String No If a list, the id of the list
listValue boolean Yes Is this a list
name String Yes The caption name
sourceType sourceType Yes The source type
type keyType Yes The caption type
userModifiable boolean Yes Can the user modify this value
keyType enumeration

Describes the type of the key.

Constant Name Description
DOC_TYPE Document type
DOC_DRAWER Drawer
DOC_FIELD1 Field1
DOC_FIELD2 Field2
DOC_FIELD3 Field3
DOC_FIELD4 Field4
DOC_FIELD5 Field5
DOC_PROPERTY Property
FOLDER_NAME Folder name
FOLDER_TYPE Folder type
FOLDER_PROPERTY Folder property
DOC_NAME Document name
DOC_SHORTCUT Document shortcut
RECORD_FILE_PLAN File plan
RECORD_CATEGORY Record Category
RECORD_FOLDER_NAME Folder name
RECORD_FOLDER_TYPE Folder type
RECORD_TYPE Type
RECORD_AUTHOR Author
RECORD_ORIGINATING_ORG Originating org
RECORD_PUBLICATION_DATE Publication date
RECORD_MEDIA_TYPE Media type
RECORD_FORMAT Format
RECORD_DATE_RECEIVED Date received
RECORD_ADDRESSEES Addressees
RECORD_OTHER_ADDRESSEES Other addressees
RECORD_LOCATION Location
RECORD_FOLDER_LOCATION Folder location
sourceType enumeration

Describes the type for a context map item source.

Constant Name Description
NONE No mapping.
DICTIONARY Mapped to a dictionary item.
LITERAL Mapped to a string literal.
USER_ENTRY Requires user entry.
PREDEFINED_LIST Mapped to a predefined list.
USER_NAME_SELECT Mapped to a list of user names.
USER_NAME_CURRENT Mapped to current user name.
USER_ID Mapped to user id.
DATE_TIME Mapped to a date.
SEQUENCE_NUM Mapped to a sequence number.
UNIQUE_ID Mapped to a unique id generator.
SCRIPT Mapped to a script.
BATCH_ID Mapped to a batch id.
SYSTEM_DRAWER Mapped to a drawer.
SYSTEM_DRAWER_LIST Mapped to a drawer list.
DOC_TYPE Mapped to a document type.
DOC_TYPE_LIST Mapped to a document type list.
FOLDER_TYPE Mapped to a folder type.
FOLDER_TYPE_LIST Mapped to a folder type list.
DOC_KEY Mapped to a document key.
DOC_PROPERTY Mapped to a document property.
LEGACY_FOLDER_TYPE Mapped to a folder type.
TARGET_NAME Mapped to a shortcut target name.
RECORD_FILE_PLAN Mapped to a record file plan.
RECORD_FOLDER_TYPE Mapped to a record folder type.
RECORD_TYPE Mapped to a record type.
RECORD_CATEGORY Mapped to a record category.
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.
type enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
DOS This is the DOS Command Prompt LearnMode method, which captures data from DOS-based programs.
MANUAL_ENTRY This is the Manual LearnMode method, which is a stand-alone application plan where images can be indexed and retrieved without the use of a business application, and where the user enters document keys manually.
WINDOW_WALKER This is the Window Walker LearnMode method, which allows for data capture from graphical user interface applications that conform to the Microsoft Windows interface design guidelines.
HYPERLEARN This is the HyperLearn LearnMode method, which essentially takes a screen shot of the business application window, analyzes its content, and converts the screen characters into text.
VIEWPOINT This is the Viewpoint LearnMode method, which is a hybrid between the Window Walker and HyperLearn methods that is used with some Windows applications. It is similar to Window Walker in that it is control-based. However, instead of using address of node in the control tree to identify and locate data, Viewpoint uses x,y coordinates (similar to HyperLearn) to locate a control.
INTERNET_EXPLORER This is the Internet Explorer LearnMode method, which is for web-based applications: programs that are rendered via HTML, ActiveX, Java, Macromedia Flash, or some combination of these.
TERMINAL This is the Terminal Capture LearnMode method, which copies application screen contents to the system clipboard. This LearnMode method is most commonly used with terminal emulator programs and mainframe programs.
FAX_AGENT This is the Fax Agent LearnMode method, which enables you to process incoming faxes directly into ImageNow by converting them into documents. This method uses data available from the Fax Agent to identify possible index values. Fax-specific data includes the fax sender number, fax sender DID, and incoming fax channel.
MAIL_AGENT This is the Mail Agent LearnMode method, which uses ImageNow Mail Agent to capture and index e-mail messages.
IMPORT_AGENT This is the Import Agent LearnMode method, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
CONNECTOR_SAP This is the SAP ArchiveLink LearnMode method, which allows you to upload metadata stored in ImageNow to SAP software.
INTERACT_OUTLOOK This is the Interact for Outlook LearnMode method, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL This is the External LearnMode method, which allows you to capture from any external source.
MOBILE This is the Mobile LearnMode method, which allows you to capture from a mobile device.

JSON Samples

Sample 1
Request URL
/v2/captureProfile/301YV77_0001EF54P000001
Response
{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook","description":"Interact for Outlook capture profile","type":"INTERACT","wfQueueId":"301YU1C_0005SCH3K005069","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT","sourceProfileId":"301YW1C_0005SJH3J00006H","applicationPlan":{"id":"301YW1C_0005SJH3J000063","name":"Interact for Outlook Plan","description":"Interact for Outlook application plan","learnModeType":"INTERACT_OUTLOOK","docKeyInfos":[{"name":"Label1","type":"DOC_NAME","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""},{"name":"Label2","type":"DOC_FIELD1","sourceType":"LITERAL","userModifiable":true,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label3","type":"DOC_FIELD2","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label4","type":"DOC_FIELD3","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label5","type":"DOC_FIELD4","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label6","type":"DOC_FIELD5","sourceType":"NONE","userModifiable":false,"allowBlank":true,"listValue":false,"listId":""},{"name":"Label7","type":"DOC_TYPE","sourceType":"DICTIONARY","userModifiable":false,"allowBlank":false,"listValue":false,"listId":""}]},"addToVersionControl":false,"submitToContent":false}

XML Samples

Sample 1
Request URL
/v2/captureProfile/301YV77_0001EF54P000001
Response
<captureProfile>
    <id>301YVD5_0001SVVK100000V</id>
    <name>Interact for Outlook</name>
    <description>Interact for Outlook capture profile</description>
    <type>INTERACT</type>
    <wfQueueId>301YU1C_0005SCH3K005069</wfQueueId>
    <sourceType>INTERACT_OUTLOOK</sourceType>
    <categoryType>DOCUMENT</categoryType>
    <sourceProfileId>301YW1C_0005SJH3J00006H</sourceProfileId>
    <applicationPlan>
        <id>301YW1C_0005SJH3J000063</id>
        <name>Interact for Outlook Plan</name>
        <description>Interact for Outlook application plan</description>
        <learnModeType>INTERACT_OUTLOOK</learnModeType>
        <docKeyInfos>
            <docKeyInfo>
                <name>Label1</name>
                <type>DOC_NAME</type>
                <sourceType>DICTIONARY</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>false</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label2</name>
                <type>DOC_FIELD1</type>
                <sourceType>LITERAL</sourceType>
                <userModifiable>true</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label3</name>
                <type>DOC_FIELD2</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label4</name>
                <type>DOC_FIELD3</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label5</name>
                <type>DOC_FIELD4</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label6</name>
                <type>DOC_FIELD5</type>
                <sourceType>NONE</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>true</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
            <docKeyInfo>
                <name>Label7</name>
                <type>DOC_TYPE</type>
                <sourceType>DICTIONARY</sourceType>
                <userModifiable>false</userModifiable>
                <allowBlank>false</allowBlank>
                <listValue>false</listValue>
                <listId/>
            </docKeyInfo>
        </docKeyInfos>
    </applicationPlan>
    <addToVersionControl>false</addToVersionControl>
    <submitToContent>false</submitToContent>
</captureProfile>

CaptureProfile (Version 3)

GET/v3/captureProfile This API call requests the list of active capture profiles stored in ImageNow Server. Integration...

Expand Operation / Collapse Operation

This API call requests the list of active capture profiles stored in ImageNow Server. Integration Server structures the response using the captureProfile type, which includes the capture profile ID, name, description, and type, along with the capture source type. The captureProfileType enumeration provides the possible values for the general capture profile type, such as INTERACT or AGENT, and the captureSourceType enumeration provides the possible values for the capture source, such as INTERACT_OUTLOOK or IMPORT_AGENT.

Available from version: 1.0.0

Example 1 in the following table shows a response from a query without the sourceType parameter. Example 2 shows a response from a query where the sourceType parameter is INTERACT_OUTLOOK. Example 3 shows a response from a query where the categoryType parameter is DOCUMENT.

Call Properties

Query Parameters
sourceType sourceType (optional) Source type filtering
You can filter capture profiles by capture source type using the optional sourceType query parameter. In this case, ImageNow Server returns the capture profiles that match the specific source type, such as Interact for Outlook or Import Agent. The captureSourceType enumeration provides the possible values for the sourceType parameter.
categoryType categoryType (optional) Category type filtering
You can filter capture profiles by capture category type using the optional categoryType query parameter. In this case, ImageNow Server returns the capture profiels that match the specific category type. The categoryType enumeration provides the possible values for the categoryType parameter.
Response
Content
List of captureProfile [captureProfile]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureProfile type

The captureProfile type provides the structure for the data Integration Server returns for an ImageNow capture profile.

Field Name Data Type Expected Description
categoryType categoryType Yes The category for the capture profile, such as RECORD or DOCUMENT.
description String Yes The description of the capture profile as it is in your ImageNow system.
id String Yes The unique ID of the capture profile.
name String Yes The name of the capture profile as it is in your ImageNow system.
sourceType sourceType Yes The capture source for the capture profile, such as INTERACT_OUTLOOK for Interact for Outlook.
type captureProfileType Yes The general type of capture profile, such as AGENT for Fax Agent or Import Agent.
captureProfileType enumeration

This table lists the possible values for the captureProfile enumeration, which provides the general capture profile type.

Constant Name Description
AGENT The capture profile type is an ImageNow agent, such as Fax Agent or Import Agent.
INTERACT The capture profile type is an ImageNow interact, such as Interact for Outlook.
EXTERNAL The capture profile type is an ImageNow external, such as External Interface.
MOBILE The capture profile type is Mobile.
EXTERNAL_USER The capture profile type is External User.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of the call to get all capture profiles.
EXTERNAL_SCANNER The source for the capture profile is the External Scanner type, which provides scanner configuration settings.

JSON Samples

Sample 1 - sourceType parameter excluded
Request URL
/v3/captureProfile
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook: Documents","description":"Interact for Outlook documents capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT"},{"id":"301YW1B_0005SKH3J00001V","name":"Interact for Outlook: Records","description":"Interact for Outlook records capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"RECORD"},{"id":"301YW1C_0005SFH3J00003T","name":"Import Agent","description":"Import Agent capture profile","type":"AGENT","sourceType":"IMPORT_AGENT","categoryType":"DOCUMENT"}]}
Sample 2 - sourceType parameter included
Request URL
/v3/captureProfile?sourceType=INTERACT_OUTLOOK
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook: Documents","description":"Interact for Outlook documents capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT"},{"id":"301YW1B_0005SKH3J00001V","name":"Interact for Outlook: Records","description":"Interact for Outlook records capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"RECORD"}]}
Sample 3 - categoryType parameter included
Request URL
/v3/captureProfile?categoryType=DOCUMENT
Response
{"captureProfiles":[{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook: Documents","description":"Interact for Outlook documents capture profile","type":"INTERACT","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT"}]}

XML Samples

Sample 1 - sourceType parameter excluded
Request URL
/v3/captureProfile
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook: Documents</name>
        <description>Interact for Outlook documents capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
    <captureProfile>
        <id>301YW1B_0005SKH3J00001V</id>
        <name>Interact for Outlook: Records</name>
        <description>Interact for Outlook records capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>RECORD</categoryType>
    </captureProfile>
    <captureProfile>
        <id>301YW1C_0005SFH3J00003T</id>
        <name>Import Agent</name>
        <description>Import Agent capture profile</description>
        <type>AGENT</type>
        <sourceType>IMPORT_AGENT</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
</captureProfiles>
Sample 2 - sourceType parameter included
Request URL
/v3/captureProfile?sourceType=INTERACT_OUTLOOK
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook: Documents</name>
        <description>Interact for Outlook documents capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
    <captureProfile>
        <id>301YW1B_0005SKH3J00001V</id>
        <name>Interact for Outlook: Records</name>
        <description>Interact for Outlook records capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>RECORD</categoryType>
    </captureProfile>
</captureProfiles>
Sample 3 - categoryType parameter included
Request URL
/v3/captureProfile?categoryType=DOCUMENT
Response
<captureProfiles>
    <captureProfile>
        <id>301YVD5_0001SVVK100000V</id>
        <name>Interact for Outlook: Documents</name>
        <description>Interact for Outlook documents capture profile</description>
        <type>INTERACT</type>
        <sourceType>INTERACT_OUTLOOK</sourceType>
        <categoryType>DOCUMENT</categoryType>
    </captureProfile>
</captureProfiles>

GET/v3/captureProfile/{id} This API call requests the capture profile stored in ImageNow Server that matches the given ID. I...

Expand Operation / Collapse Operation

This API call requests the capture profile stored in ImageNow Server that matches the given ID. Integration Server structures the response using the captureProfile type, which provides detailed information about the capture profile and includes the applicationPlan type, which provides information about the associated application plan.

Available from version: 1.0.0

Call Properties

Response
Content
captureProfile
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureProfile type

The captureProfile type provides the structure for the data Integration Server returns for an ImageNow capture profile.

Field Name Data Type Expected Description
addToVersionControl boolean Yes This indicates whether documents are added to version control when using this capture profile.
applicationPlanId String Yes The ID of application plan associated with the capture profile.
categoryType categoryType Yes The category for the capture profile, such as DOCUMENT or RECORD.
description String Yes The description of the capture profile as it is in your ImageNow system.
id String Yes The unique ID of the capture profile.
name String Yes The name of the capture profile as it is in your ImageNow system.
sourceProfileId String No The ID of the capture source profile associated with the capture profile.
sourceType sourceType Yes The capture source for the capture profile, such as INTERACT_OUTLOOK for Interact for Outlook.
submitToContent boolean Yes This indicates whether documents are submitted to Content Server when using this capture profile.
type captureProfileType Yes The general type of capture profile, such as AGENT for Fax Agent or Import Agent.
wfQueueId String No This is the ID of the workflow queue in which ImageNow Server places the documents when using this capture profile.
captureProfileType enumeration

This table lists the possible values for the captureProfile enumeration, which provides the general capture profile type.

Constant Name Description
AGENT The capture profile type is an ImageNow agent, such as Fax Agent or Import Agent.
INTERACT The capture profile type is an ImageNow interact, such as Interact for Outlook.
EXTERNAL The capture profile type is an ImageNow external, such as External Interface.
MOBILE The capture profile type is Mobile.
EXTERNAL_USER The capture profile type is External User.
categoryType enumeration

This table lists the possible values for the learnModeType enumeration, which provides the type of LearnMode application.

Constant Name Description
ALL The category type is ALL, which can be used to capture either documents or records.
DOCUMENT The category type is DOCUMENT, which is used to capture documents.
RECORD The category type is RECORD, which is used to capture records.
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of the call to get all capture profiles.
EXTERNAL_SCANNER The source for the capture profile is the External Scanner type, which provides scanner configuration settings.

JSON Samples

Sample 1
Request URL
/v3/captureProfile/301YV77_0001EF54P000001
Response
{"id":"301YVD5_0001SVVK100000V","name":"Interact for Outlook","description":"Interact for Outlook capture profile","type":"INTERACT","wfQueueId":"301YU1C_0005SCH3K005069","sourceType":"INTERACT_OUTLOOK","categoryType":"DOCUMENT","sourceProfileId":"301YW1C_0005SJH3J00006H","applicationPlanId":"301YW1C_0005SJH3J000063","addToVersionControl":false,"submitToContent":false}

XML Samples

Sample 1
Request URL
/v3/captureProfile/301YV77_0001EF54P000001
Response
<captureProfile>
    <id>301YVD5_0001SVVK100000V</id>
    <name>Interact for Outlook</name>
    <description>Interact for Outlook capture profile</description>
    <type>INTERACT</type>
    <wfQueueId>301YU1C_0005SCH3K005069</wfQueueId>
    <sourceType>INTERACT_OUTLOOK</sourceType>
    <categoryType>DOCUMENT</categoryType>
    <sourceProfileId>301YW1C_0005SJH3J00006H</sourceProfileId>
    <applicationPlanId>301YW1C_0005SJH3J000063</applicationPlanId>
    <addToVersionControl>false</addToVersionControl>
    <submitToContent>false</submitToContent>
</captureProfile>

CaptureSourceProfile (Version 1)

GET/v1/captureSourceProfile/{id} This API call requests the capture source profile from ImageNow Server that matches the given ID....

Expand Operation / Collapse Operation

This API call requests the capture source profile from ImageNow Server that matches the given ID. Integration Server structures the response using the captureSourceProfile type, which provides detailed information about a capture source profile, and includes the ID, name, description, type, and properties.

Available from version: 1.0.0

Call Properties

Response
Content
captureSourceProfile
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureSourceProfile type

A capture source profile for use with a capture profile

Field Name Data Type Expected Description
description String Yes A description of the capture source profile
id String Yes The ID of the capture source profile
name String Yes The name of the capture source profile
properties List of keyValuePair [property] Yes A list of key-value pair properites defined by the capture source profile. These are specific to the capture source type.
type sourceType Yes The type of capture source with which the capture source profile is associated
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.

JSON Samples

Sample 1
Request URL
/v1/captureSourceProfile/301YW1B_0005SEH3J00001Y
Response
{"id":"301YW1B_0005SEH3J00001Y","name":"Interact for Outlook","description":"Interact for Outlook Source Profile","type":"INTERACT_OUTLOOK","properties":[{"key":"attachment.mode","value":"OUTLOOK_USER_SELECTION_MODE"}]}

XML Samples

Sample 1
Request URL
/v1/captureSourceProfile/301YW1B_0005SEH3J00001Y
Response
<captureSourceProfile>
    <id>301YW1B_0005SEH3J00001Y</id>
    <name>Interact for Outlook</name>
    <description>Interact for Outlook Source Profile</description>
    <type>INTERACT_OUTLOOK</type>
    <properties>
        <property>
            <key>attachment.mode</key>
            <value>OUTLOOK_USER_SELECTION_MODE</value>
        </property>
    </properties>
</captureSourceProfile>

CaptureSourceProfile (Version 2)

GET/v2/captureSourceProfile/{id} This API call requests the capture source profile from ImageNow Server that matches the given ID....

Expand Operation / Collapse Operation

This API call requests the capture source profile from ImageNow Server that matches the given ID. Integration Server structures the response using the captureSourceProfile type, which provides detailed information about a capture source profile, and includes the ID, name, description, type, and properties.

Available from version: 1.0.0

Call Properties

Response
Content
captureSourceProfile
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureSourceProfile type

A capture source profile for use with a capture profile

Field Name Data Type Expected Description
description String Yes A description of the capture source profile
id String Yes The ID of the capture source profile
name String Yes The name of the capture source profile
properties List of keyValuePair [property] Yes A list of key-value pair properites defined by the capture source profile. These are specific to the capture source type.
type sourceType Yes The type of capture source with which the capture source profile is associated
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.

JSON Samples

Sample 1
Request URL
/v2/captureSourceProfile/301YW1B_0005SEH3J00001Y
Response
{"id":"301YW1B_0005SEH3J00001Y","name":"Interact for Outlook","description":"Interact for Outlook Source Profile","type":"INTERACT_OUTLOOK","properties":[{"key":"storage.mode","value":"OUTLOOK_STORAGE_SEPARATE_MODE"},{"key":"content.mode","value":"OUTLOOK_MSG_AND_ATTACHMENTS"},{"key":"removeEmbeddedAttachments","value":"true"},{"key":"connectionTypeId","value":"301YW1B_0005SEH3J00034G"}]}

XML Samples

Sample 1
Request URL
/v2/captureSourceProfile/301YW1B_0005SEH3J00001Y
Response
<captureSourceProfile>
    <id>301YW1B_0005SEH3J00001Y</id>
    <name>Interact for Outlook</name>
    <description>Interact for Outlook Source Profile</description>
    <type>INTERACT_OUTLOOK</type>
    <properties>
        <property>
            <key>storage.mode</key>
            <value>OUTLOOK_STORAGE_SEPARATE_MODE</value>
        </property>
        <property>
            <key>content.mode</key>
            <value>OUTLOOK_MSG_AND_ATTACHMENTS</value>
        </property>
        <property>
            <key>removeEmbeddedAttachments</key>
            <value>true</value>
        </property>
        <property>
            <key>connectionTypeId</key>
            <value>301YW1B_0005SEH3J00034G</value>
        </property>
    </properties>
</captureSourceProfile>

CaptureSourceProfile (Version 3)

GET/v3/captureSourceProfile/{id} This API call requests the capture source profile from ImageNow Server that matches the given ID....

Expand Operation / Collapse Operation

This API call requests the capture source profile from ImageNow Server that matches the given ID. Integration Server structures the response using the captureSourceProfile type, which provides detailed information about a capture source profile, and includes the ID, name, description, type, and properties.

Available from version: 1.0.0

Call Properties

Response
Content
captureSourceProfile
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureSourceProfile type

A capture source profile for use with a capture profile

Field Name Data Type Expected Description
description String Yes A description of the capture source profile
id String Yes The ID of the capture source profile
name String Yes The name of the capture source profile
properties List of keyValuePair [property] Yes A list of key-value pair properites defined by the capture source profile. These are specific to the capture source type.
type sourceType Yes The type of capture source with which the capture source profile is associated
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of the call to get all capture profiles.
EXTERNAL_SCANNER The source for the capture profile is the External Scanner type, which provides scanner configuration settings.

JSON Samples

Sample 1
Request URL
/v3/captureSourceProfile/301YW1B_0005SEH3J00001Y
Response
{"id":"301YW1B_0005SEH3J00001Y","name":"Interact for Outlook","description":"Interact for Outlook Source Profile","type":"INTERACT_OUTLOOK","properties":[{"key":"storage.mode","value":"OUTLOOK_STORAGE_SEPARATE_MODE"},{"key":"content.mode","value":"OUTLOOK_MSG_AND_ATTACHMENTS"},{"key":"removeEmbeddedAttachments","value":"true"},{"key":"connectionTypeId","value":"301YW1B_0005SEH3J00034G"}]}

XML Samples

Sample 1
Request URL
/v3/captureSourceProfile/301YW1B_0005SEH3J00001Y
Response
<captureSourceProfile>
    <id>301YW1B_0005SEH3J00001Y</id>
    <name>Interact for Outlook</name>
    <description>Interact for Outlook Source Profile</description>
    <type>INTERACT_OUTLOOK</type>
    <properties>
        <property>
            <key>storage.mode</key>
            <value>OUTLOOK_STORAGE_SEPARATE_MODE</value>
        </property>
        <property>
            <key>content.mode</key>
            <value>OUTLOOK_MSG_AND_ATTACHMENTS</value>
        </property>
        <property>
            <key>removeEmbeddedAttachments</key>
            <value>true</value>
        </property>
        <property>
            <key>connectionTypeId</key>
            <value>301YW1B_0005SEH3J00034G</value>
        </property>
    </properties>
</captureSourceProfile>

Connection (Version 1)

DELETE/v1/connection/ Disconnect current connection from the server.

Expand Operation / Collapse Operation

Disconnect current connection from the server.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/connection

XML Samples

Sample 1
Request URL
/v1/connection

GET/v1/connection/ This API call verifies the connection status of Integration Server to ImageNow Server. If a conne...

Expand Operation / Collapse Operation

This API call verifies the connection status of Integration Server to ImageNow Server. If a connection to ImageNow Server does not already exist, a new connection is made. Integration Server uses the connectionStatus type to provide the product version for the connection.

Available from version: 1.0.0

Call Properties

Response
Content
connectionStatus
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

connectionStatus type

This type indicates the connection status between Integration Server and ImageNow Server.

Field Name Data Type Expected Description
version String Yes The Integration Server product version.

JSON Samples

Sample 1
Request URL
/v1/connection
Response
{"version":"6.7.0.0"}

XML Samples

Sample 1
Request URL
/v1/connection
Response
<connectionStatus>
    <version>6.7.0.0</version>
</connectionStatus>

Connection (Version 2)

GET/v2/connection/ This API call verifies the connection status of Integration Server to ImageNow Server. If a conne...

Expand Operation / Collapse Operation

This API call verifies the connection status of Integration Server to ImageNow Server. If a connection to ImageNow Server does not already exist, a new connection is made. Integration Server uses the connectionStatus type to provide the product version, user ID, and user name for the connection.

Available from version: 1.0.0

Call Properties

Response
Content
connectionStatus
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

connectionStatus type

This type indicates the connection status between Integration Server and ImageNow Server.

Field Name Data Type Expected Description
userId String Yes The user ID of the connected user.
userName String Yes The user name of the connected user.
version String Yes The Integration Server product version.

JSON Samples

Sample 1
Request URL
/v2/connection
Response
{"version":"6.7.0.0","userId":"321YX7Q_0006CHR6300003H","userName":"jsmith"}

XML Samples

Sample 1
Request URL
/v2/connection
Response
<connectionStatus>
    <version>6.7.0.0</version>
    <userId>321YX7Q_0006CHR6300003H</userId>
    <userName>jsmith</userName>
</connectionStatus>

ConnectionType (Version 1)

GET/v1/connectionType Gets all connection types that the user has create privileges for.

Expand Operation / Collapse Operation

Gets all connection types that the user has create privileges for.

Available from version: 1.0.0

Call Properties

Response
Content
List of connectionType [connectionType]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

connectionType type

A connection type for forming relationships between records

Field Name Data Type Expected Description
description String Yes The description of the connection type
id String Yes The id of the connection type
name String Yes The name of the connection type
relationshipType relationshipType Yes The type of relationship between the source and target record
sourceLabel String Yes The label for the source record of the connection type
targetLabel String Yes The label for the target record of the connection type
relationshipType enumeration

Represents the different types of relationships that a connection type can have

Constant Name Description
PEER Represents a peer relationship between two records
INHERITED Represents an inheritance relationship between two records
SUPERSEDE Represents one record superseding another record
REVISION Represents one record being a revision of another record

JSON Samples

Sample 1
Request URL
/v1/connectionType
Response
{"connectionTypes":[{"id":"1013184795_6887711448","name":"Revision connection type","description":"Revision connection type","sourceLabel":"Previous","targetLabel":"Next","relationshipType":"REVISION"},{"id":"1ZZ384795_1227711448","name":"Peer connection type","description":"Peer connection type","sourceLabel":"Source Peer","targetLabel":"Target Peer","relationshipType":"PEER"},{"id":"1013184795_68003248","name":"Supersede connection type","description":"Supersede connection type","sourceLabel":"Supersedes","targetLabel":"Superseded by","relationshipType":"SUPERSEDE"},{"id":"1ZZ004795_6887711448","name":"Inherited connection type","description":"Inherited connection type","sourceLabel":"Ascendant","targetLabel":"Descendant","relationshipType":"INHERITED"}]}

XML Samples

Sample 1
Request URL
/v1/connectionType
Response
<connectionTypes>
    <connectionType>
        <id>1013184795_6887711448</id>
        <name>Revision connection type</name>
        <description>Revision connection type</description>
        <sourceLabel>Previous</sourceLabel>
        <targetLabel>Next</targetLabel>
        <relationshipType>REVISION</relationshipType>
    </connectionType>
    <connectionType>
        <id>1ZZ384795_1227711448</id>
        <name>Peer connection type</name>
        <description>Peer connection type</description>
        <sourceLabel>Source Peer</sourceLabel>
        <targetLabel>Target Peer</targetLabel>
        <relationshipType>PEER</relationshipType>
    </connectionType>
    <connectionType>
        <id>1013184795_68003248</id>
        <name>Supersede connection type</name>
        <description>Supersede connection type</description>
        <sourceLabel>Supersedes</sourceLabel>
        <targetLabel>Superseded by</targetLabel>
        <relationshipType>SUPERSEDE</relationshipType>
    </connectionType>
    <connectionType>
        <id>1ZZ004795_6887711448</id>
        <name>Inherited connection type</name>
        <description>Inherited connection type</description>
        <sourceLabel>Ascendant</sourceLabel>
        <targetLabel>Descendant</targetLabel>
        <relationshipType>INHERITED</relationshipType>
    </connectionType>
</connectionTypes>

Department (Version 1)

GET/v1/department Retrieve the list of departments.

Expand Operation / Collapse Operation

Retrieve the list of departments.

Available from version: 1.0.0

Call Properties

Response
Content
List of department [department]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

department type

The department type provides details for a department.

Field Name Data Type Expected Description
description String Yes The description for the department
id String Yes The ID of the department
name String Yes The name of the department
prefix String Yes The prefix for the department

JSON Samples

Sample 1
Request URL
/v1/department
Response
{"departments":[{"id":"301YVDM_0018XTGGH030301","name":"Human Resources","prefix":"HR","description":"Employee accounts and information."},{"id":"301YVDM_0018XTGGH030302","name":"Receipts","prefix":"REC","description":"Customer and internal invoices."}]}

XML Samples

Sample 1
Request URL
/v1/department
Response
<departments>
    <department>
        <id>301YVDM_0018XTGGH030301</id>
        <name>Human Resources</name>
        <prefix>HR</prefix>
        <description>Employee accounts and information.</description>
    </department>
    <department>
        <id>301YVDM_0018XTGGH030302</id>
        <name>Receipts</name>
        <prefix>REC</prefix>
        <description>Customer and internal invoices.</description>
    </department>
</departments>

POST/v1/department Creates a department.

Expand Operation / Collapse Operation

Creates a department.

Available from version: 1.0.0

Call Properties

Request
Content department
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the newly created department.

Call Types and Enumerations

department type

department to be created

Field Name Data Type Expected Description
description String Yes The description of the department
managerIds List of String [managerId] Yes The users to be promoted to be managers of the department
name String Yes The name of the department
prefix String Yes The prefix of the department

JSON Samples

Sample 1
Request URL
/v1/department
Request
{"name":"Human Resource","prefix":"HR","description":"This is a lengthy description of a human resource department","managerIds":["301YVDM_001THQZXH222212","301YVDM_001THQZXH222233"]}

XML Samples

Sample 1
Request URL
/v1/department
Request
<department>
    <name>Human Resource</name>
    <prefix>HR</prefix>
    <description>This is a lengthy description of a human resource department</description>
    <managerIds>
        <managerId>301YVDM_001THQZXH222212</managerId>
        <managerId>301YVDM_001THQZXH222233</managerId>
    </managerIds>
</department>

GET/v1/department/{id} Retrieve a department by ID.

Expand Operation / Collapse Operation

Retrieve a department by ID.

Available from version: 1.0.0

Call Properties

Response
Content
department
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

department type

The department type provides details for a department.

Field Name Data Type Expected Description
departmentManagers List of departmentManager [departmentManager] Yes A list of managers for the department
description String Yes The description for the department
id String Yes The ID of the department
name String Yes The name of the department
prefix String Yes The prefix for the department
departmentManager type

The departmentManager type provides the ID and name of a department manager.

Field Name Data Type Expected Description
id String Yes The ID of the department manager
name String Yes The name of the department manager

JSON Samples

Sample 1
Request URL
/v1/department/321YX26_00012HZZ2002315
Response
{"id":"301YVDM_0018XTZXH222301","name":"Human Resources","prefix":"HR","description":"Employee accounts and information.","departmentManagers":[{"id":"301YVDM_001THQZXH222211","name":"John Smith"},{"id":"301YVDM_001TX1ZXHZW6261","name":"Jane Doe"}]}

XML Samples

Sample 1
Request URL
/v1/department/321YX26_00012HZZ2002315
Response
<department>
    <id>301YVDM_0018XTZXH222301</id>
    <name>Human Resources</name>
    <prefix>HR</prefix>
    <description>Employee accounts and information.</description>
    <departmentManagers>
        <departmentManager>
            <id>301YVDM_001THQZXH222211</id>
            <name>John Smith</name>
        </departmentManager>
        <departmentManager>
            <id>301YVDM_001TX1ZXHZW6261</id>
            <name>Jane Doe</name>
        </departmentManager>
    </departmentManagers>
</department>

PUT/v1/department/{id} Updates an existing department.

Expand Operation / Collapse Operation

Updates an existing department.

Available from version: 1.0.0

Call Properties

Request
Content department
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

department type

department to be created

Field Name Data Type Expected Description
description String Yes The description of the department
managerIds managerIds Yes The users to be promoted to be managers of the department or demoted from managers
name String Yes The name of the department
prefix String Yes The prefix of the department
managerIds type

The users to be promoted to be managers of the department or demoted from managers

Field Name Data Type Expected Description
managersToAdd List of String [managerId] Yes The users to be promoted to department manager
managersToRemove List of String [managerId] Yes The users to be demoted from department manager

JSON Samples

Sample 1
Request URL
/v1/department/321YY3E_00002GQE5000002
Request
{"name":"Human Resource","prefix":"HR","description":"This department is for use by Human Resources","managerIds":{"managersToAdd":["321YY3E_000027QE5000002","321YY3E_000043QS8000004"],"managersToRemove":["321YY3E_000043QS800000B","321YY3E_000043QS800000E","321YY3E_000001QDE000002"]}}

XML Samples

Sample 1
Request URL
/v1/department/321YY3E_00002GQE5000002
Request
<department>
    <name>Human Resource</name>
    <prefix>HR</prefix>
    <description>This department is for use by Human Resources</description>
    <managerIds>
        <managersToAdd>
            <managerId>321YY3E_000027QE5000002</managerId>
            <managerId>321YY3E_000043QS8000004</managerId>
        </managersToAdd>
        <managersToRemove>
            <managerId>321YY3E_000043QS800000B</managerId>
            <managerId>321YY3E_000043QS800000E</managerId>
            <managerId>321YY3E_000001QDE000002</managerId>
        </managersToRemove>
    </managerIds>
</department>

DigitalId (Version 1)

POST/v1/digitalId This API call creates a digital ID for the user. Integration Server uses the digitalIdPasswordInf...

Expand Operation / Collapse Operation

This API call creates a digital ID for the user. Integration Server uses the digitalIdPasswordInfo type to structure the request, which includes the password and optional password hint that the user provided for their digital ID.

Available from version: 1.0.0

Call Properties

Request
Content digitalIdPasswordInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

digitalIdPasswordInfo type

Request object for passing password information for a digital id

Field Name Data Type Expected Description
password String Yes The password for the user's digital ID.
passwordHint String No The password hint for the user's digital ID.

JSON Samples

Sample 1
Request URL
/v1/digitalId
Request
{"password":"07911270","passwordHint":"Reverse birthday"}

XML Samples

Sample 1
Request URL
/v1/digitalId
Request
<digitalIdPasswordInfo>
    <password>07911270</password>
    <passwordHint>Reverse birthday</passwordHint>
</digitalIdPasswordInfo>

GET/v1/digitalId/validity This API call checks whether the user's digital ID is valid. Integration Server uses the digitalI...

Expand Operation / Collapse Operation

This API call checks whether the user's digital ID is valid. Integration Server uses the digitalIdValidity type to structure the response. You can also use this call to retrieve the user's password hint for their digital ID. If the user did not provide a password hint, Integration Server returns a null value for the passwordHint field.

Available from version: 1.0.0

Call Properties

Response
Content
digitalIdValidity
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

digitalIdValidity type

A user's digital ID validity.

Field Name Data Type Expected Description
passwordHint String No The password hint for the user's digital ID. If the user did not provide a password hint, Integration Server returns a null value.
valid boolean Yes If true, the user has a valid digital ID. If false, the user does not have a valid digital ID.

JSON Samples

Sample 1
Request URL
/v1/digitalId/validity
Response
{"valid":true,"passwordHint":"Reverse birthday"}

XML Samples

Sample 1
Request URL
/v1/digitalId/validity
Response
<digitalIdValidity>
    <valid>true</valid>
    <passwordHint>Reverse birthday</passwordHint>
</digitalIdValidity>

DigitalId (Version 2)

POST/v2/digitalId This API call creates a digital ID for the user. Integration Server uses the digitalIdPasswordInf...

Expand Operation / Collapse Operation

This API call creates a digital ID for the user. Integration Server uses the digitalIdPasswordInfo type to structure the request, which includes the password, first name, and last name and optional password hint, prefix, and suffix that the user provided for their digital ID.

Available from version: 1.0.0

Call Properties

Request
Content digitalIdPasswordInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

digitalIdPasswordInfo type

The request object for passing password information for a digital ID.

Field Name Data Type Expected Description
identityInfo identityInfo Yes The personal information for the user.
password String Yes The password for the user's digital ID.
passwordHint String No The password hint for the user's digital ID.
identityInfo type

Contains personal information for the user

Field Name Data Type Expected Description
firstName String Yes The first name of the user.
lastName String Yes The last name of the user.
prefix String No The prefix of the user.
suffix String No The suffix of the user.

JSON Samples

Sample 1
Request URL
/v2/digitalId
Request
{"password":"07911270","passwordHint":"Reverse birthday","identityInfo":{"firstName":"John","lastName":"Doe","prefix":"Dr.","suffix":"D.D"}}

XML Samples

Sample 1
Request URL
/v2/digitalId
Request
<digitalIdPasswordInfo>
    <password>07911270</password>
    <passwordHint>Reverse birthday</passwordHint>
    <identityInfo>
        <firstName>John</firstName>
        <lastName>Doe</lastName>
        <prefix>Dr.</prefix>
        <suffix>D.D</suffix>
    </identityInfo>
</digitalIdPasswordInfo>

GET/v2/digitalId/validity This API call checks whether the user's digital ID is valid. Integration Server uses the digitalI...

Expand Operation / Collapse Operation

This API call checks whether the user's digital ID is valid. Integration Server uses the digitalIdValidity type to structure the response. You can also use this call to retrieve the user's password hint for their digital ID. If the user did not provide a password hint, Integration Server returns a null value for the passwordHint field.

Available from version: 1.0.0

Call Properties

Response
Content
digitalIdValidity
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

digitalIdValidity type

A user's digital ID validity.

Field Name Data Type Expected Description
passwordHint String No The password hint for the user's digital ID. If the user did not provide a password hint, Integration Server returns a null value.
passwordPrompt passwordPrompt Yes Indicates how often users must enter their signing password.
valid boolean Yes If true, the user has a valid digital ID. If false, the user does not have a valid digital ID.
passwordPrompt enumeration

The possible values for the passwordPrompt enumeration, which indicates how often users must enter their signing password.

Constant Name Description
ALWAYS The user is prompted to enter their signing password every time a document is signed.
ONCE_PER_SESSION The user is prompted to enter their signing password once per login session.

JSON Samples

Sample 1
Request URL
/v2/digitalId/validity
Response
{"valid":true,"passwordHint":"Reverse birthday","passwordPrompt":"ONCE_PER_SESSION"}

XML Samples

Sample 1
Request URL
/v2/digitalId/validity
Response
<digitalIdValidity>
    <valid>true</valid>
    <passwordHint>Reverse birthday</passwordHint>
    <passwordPrompt>ONCE_PER_SESSION</passwordPrompt>
</digitalIdValidity>

Document (Version 1)

POST/v1/document Store a new Document in the Server.

Expand Operation / Collapse Operation

Store a new Document in the Server.

Available from version: 1.0.0

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The action to preform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content document
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json
Additional Header
Location The URI location of the newly created document.

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
document type

Object representing a document to be created

Field Name Data Type Expected Description
info info Yes Metadata information about the document
properties List of propertyInstance [property] Yes Custom property information about the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
keys documentKeys Yes The document's set of keys
locationId String No The document's location
name String No The document name
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1 - Request to create a document with a response indicating a naming conflict
Request URL
/v1/document
Request
{"info":{"name":"Document Name","locationId":"301YVCP_000294NLF000006","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}
Response
{"instanceType":"DOCUMENT","id":"301YW1E_00077ZVD900003H"}
Sample 2 - Request to replace the existing document with the new document
Request URL
/v1/document?action=REPLACE
Request
{"info":{"name":"Document Name","locationId":"301YVCP_000294NLF000006","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}

XML Samples

Sample 1 - Request to create a document with a response indicating a naming conflict
Request URL
/v1/document
Request
<document>
    <info>
        <name>Document Name</name>
        <locationId>301YVCP_000294NLF000006</locationId>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</document>
Response
<conflictItem>
    <instanceType>DOCUMENT</instanceType>
    <id>301YW1E_00077ZVD900003H</id>
</conflictItem>
Sample 2 - Request to replace the existing document with the new document
Request URL
/v1/document?action=REPLACE
Request
<document>
    <info>
        <name>Document Name</name>
        <locationId>301YVCP_000294NLF000006</locationId>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</document>

POST/v1/document/digitalSignature/{signatureId}/verify Verifies a signature on a document.

Expand Operation / Collapse Operation

Verifies a signature on a document.

Available from version: 1.0.0

Call Properties

Response
Content
verifyDigitalSignatureStatus
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

signatureStatus enumeration

The signature status

Constant Name Description
VERSION_SIGNATURE_VALID Indicates that a document signature is valid.
VERSION_SIGNATURE_EXPIRED Indicates that a document signature has expired.
VERSION_SIGNATURE_INVALID Indicates that a document signature is invalid.
VERSION_SIGNATURE_VOIDED Indicates that a document signature has been voided.
VERSION_SIGNATURE_VOIDED_KEY_PAIR Indicates that document signature has a voided key pair
verifyDigitalSignatureStatus type

The status of the signature.

Field Name Data Type Expected Description
signatureStatus signatureStatus Yes The status of the signature.

JSON Samples

Sample 1
Request URL
/v1/document/digitalSignature/301YW1J_000782XC40000S8/verify
Response
{"signatureStatus":"VERSION_SIGNATURE_VALID"}

XML Samples

Sample 1
Request URL
/v1/document/digitalSignature/301YW1J_000782XC40000S8/verify
Response
<verifyDigitalSignatureStatus>
    <signatureStatus>VERSION_SIGNATURE_VALID</signatureStatus>
</verifyDigitalSignatureStatus>

POST/v1/document/digitalSignature/{signatureId}/void Voids a digital signature.

Expand Operation / Collapse Operation

Voids a digital signature.

Available from version: 1.0.0

Call Properties

Request
Content voidSignatureInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

voidSignatureInfo type

The information needed to void a signature.

Field Name Data Type Expected Description
reasonId String Yes The ID of the reason for the signature.

JSON Samples

Sample 1
Request URL
/v1/document/digitalSignature/301YW1J_000782XC40000S8/void
Request
{"reasonId":"301YW1J_002782XZZ0000B5"}

XML Samples

Sample 1
Request URL
/v1/document/digitalSignature/301YW1J_000782XC40000S8/void
Request
<voidSignatureInfo>
    <reasonId>301YW1J_002782XZZ0000B5</reasonId>
</voidSignatureInfo>

GET/v1/document/export Exports one or more documents as an archive file.

Expand Operation / Collapse Operation

Exports one or more documents as an archive file.

Available from version: 1.0.0

Call Properties

Query Parameters
documentId Specifies the ID of the document to be exported. One or more document IDs are required.
versionNumber (optional) Version of the document. Can only be used when a single document is being exported.
queueId (optional) Verifies the user's process privilege for the workflow queue that the documents are in. Overrides the user's open content privilege for the drawer that documents are in.
conversionFormat documentExportConversionFormat (optional) The format to convert documents to before export. The default is NONE.
conversionOptions (optional) Specifies the document filters options separated by semi-colon for rendering the document.
archiveFormat documentExportArchiveFormat (optional) Specifies the format of the output archive file. The default is ZIP.
Response
Content
None
Content-Type
  • application/zip

Call Types and Enumerations

documentExportArchiveFormat enumeration

Represents the format of the export archive file.

Constant Name Description
ZIP ZIP archive format.
documentExportConversionFormat enumeration

Represents the format to convert documents to before being exported.

Constant Name Description
NONE Do not convert documents.
PDF Convert documents to PDF format.

JSON Samples

Sample 1 - Export a single document.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002
Sample 2 - Export more than one document.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&documentId=301YVD9_000703045000001
Sample 3 - Convert a document to PDF and export.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&conversionFormat=PDF
Sample 4 - Export a specific version of a document.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&versionNumber=1
Sample 5 - Export a document using a workflow context.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1 - Export a single document.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002
Sample 2 - Export more than one document.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&documentId=301YVD9_000703045000001
Sample 3 - Convert a document to PDF and export.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&conversionFormat=PDF
Sample 4 - Export a specific version of a document.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&versionNumber=1
Sample 5 - Export a document using a workflow context.
Request URL
/v1/document/export?documentId=301YVD9_000303045000002&queueId=321YZ46_000QEJ5XJ000021

DELETE/v1/document/{id} Delete a Document stored in the Server.

Expand Operation / Collapse Operation

Delete a Document stored in the Server.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H

GET/v1/document/{id} Gets the document information stored in the Server that matches the ID.

Expand Operation / Collapse Operation

Gets the document information stored in the Server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

document type

Represents an ImageNow document object

Field Name Data Type Expected Description
info info Yes Metadata information about the document
pages List of page [page] Yes Information about the pages in the document
properties List of propertyInstance [property] Yes Custom property information about the document
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow Item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
locationId String Yes The document's location
name String Yes The document's name
version Integer Yes The document's current version number
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"},"version":null,"locationId":"301YVCP_000294NLF000006"},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber paramater included
Request URL
/v1/document/301YW1E_00077ZVD900003H?versionNumber=1
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"},"version":null,"locationId":"301YVCP_000294NLF000006"},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"},"version":null,"locationId":"301YVCP_000294NLF000006"},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 2 - versionNumber paramater included
Request URL
/v1/document/301YW1E_00077ZVD900003H?versionNumber=1
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 3 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>

PUT/v1/document/{id} Update full document object. Missing information will clear out that portion of the document.

Expand Operation / Collapse Operation

Update full document object. Missing information will clear out that portion of the document.

Available from version: 1.0.0

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The action to preform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content document
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
document type

Object representing a document to be updated

Field Name Data Type Expected Description
info info Yes Metadata information about the document
properties List of propertyInstance [property] Yes Custom property information about the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
keys documentKeys Yes The document's set of keys
locationId String Yes The document's location
name String Yes The document name
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1 - Request to update a document with a response indicating a naming conflict
Request URL
/v1/document/301YW1J_000782VD90000B8
Request
{"info":{"locationId":"301YVCP_000294NLF000006","name":"Document Name","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}
Response
{"instanceType":"DOCUMENT","id":"301YW1E_00077ZVD900003H"}
Sample 2 - Request to replace the existing document with the updated document
Request URL
/v1/document/301YW1J_000782VD90000B8?action=REPLACE
Request
{"info":{"locationId":"301YVCP_000294NLF000006","name":"Document Name","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}

XML Samples

Sample 1 - Request to update a document with a response indicating a naming conflict
Request URL
/v1/document/301YW1J_000782VD90000B8
Request
<document>
    <info>
        <locationId>301YVCP_000294NLF000006</locationId>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</document>
Response
<conflictItem>
    <instanceType>DOCUMENT</instanceType>
    <id>301YW1E_00077ZVD900003H</id>
</conflictItem>
Sample 2 - Request to replace the existing document with the updated document
Request URL
/v1/document/301YW1J_000782VD90000B8?action=REPLACE
Request
<document>
    <info>
        <locationId>301YVCP_000294NLF000006</locationId>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</document>

GET/v1/document/{id}/conversion/{outputType} Converts a document into a single pdf or tiff. If a portion of the document is unable to be conve...

Expand Operation / Collapse Operation

Converts a document into a single pdf or tiff. If a portion of the document is unable to be converted then the successful portion is returned with a 500 status code and an error code of DOCUMENT_CONVERSION_PARTIAL_FAILURE. To use this call, File Conversion Service is required.

Available from version: 1.0.0

Call Properties

Path Parameters
outputType The file type to be converted to
Query Parameters
options (optional) Document filters options separated by semi-colon for rendering the document.
versionNumber (optional) Version number of the document
queueId Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
None
Content-Type
  • */*
Additional Header
X-IntegrationServer-Conversion-Failed-Pages A comma separated list of page IDs that failed to convert in the document.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/conversion/TIFF?options=GRAPHICS_DITHER=On;TIFF_COMPRESSION=LZW;
Sample 2
Request URL
/v1/document/301YW1J_000782VD90000B8/conversion/PDF?options=PDFANNOTATIONS=Off;PDFBOOKMARKS=On;PDFDEFAULTDPI=96;&versionNumber=2
Sample 3
Request URL
/v1/document/301YW1J_000782VD90000B8/conversion/PDF?options=PDFANNOTATIONS=Off;PDFBOOKMARKS=On;PDFDEFAULTDPI=96;&queueId=301YW1J_000682VD90000AI

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/conversion/TIFF?options=GRAPHICS_DITHER=On;TIFF_COMPRESSION=LZW;
Sample 2
Request URL
/v1/document/301YW1J_000782VD90000B8/conversion/PDF?options=PDFANNOTATIONS=Off;PDFBOOKMARKS=On;PDFDEFAULTDPI=96;&versionNumber=2
Sample 3
Request URL
/v1/document/301YW1J_000782VD90000B8/conversion/PDF?options=PDFANNOTATIONS=Off;PDFBOOKMARKS=On;PDFDEFAULTDPI=96;&queueId=301YW1J_000682VD90000AI

POST/v1/document/{id}/copy Copies a Document stored in the Server.

Expand Operation / Collapse Operation

Copies a Document stored in the Server.

Available from version: 1.0.0

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The action to preform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content document
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json
Additional Header
Location The URI location of the newly created document.

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
document type

Represents a document copy object.

Field Name Data Type Expected Description
info info Yes Metadata information about the document
pageRange List of Integer [pageNumber] Yes The list of page numbers to copy from this document.
properties List of propertyInstance [property] Yes Custom property information about the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
keys documentKeys Yes The document's set of keys
locationId String Yes The document's location
name String Yes The document name
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1 - Request to copy a document with a response indicating a naming conflict
Request URL
/v1/document/301YW1J_000782VD90000B8/copy
Request
{"info":{"name":"Document Name","locationId":"301YVCP_000294NLF000006","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}],"pageRange":[2,3,4,7]}
Response
{"instanceType":"DOCUMENT","id":"301YW1E_00077ZVD900003H"}
Sample 2 - Request to append the document you are copying to the existing document
Request URL
/v1/document/301YW1J_000782VD90000B8/copy?action=APPEND
Request
{"info":{"name":"Document Name","locationId":"301YVCP_000294NLF000006","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}],"pageRange":[2,3,4,7]}

XML Samples

Sample 1 - Request to copy a document with a response indicating a naming conflict
Request URL
/v1/document/301YW1J_000782VD90000B8/copy
Request
<document>
    <info>
        <name>Document Name</name>
        <locationId>301YVCP_000294NLF000006</locationId>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
    <pageRange>
        <pageNumber>2</pageNumber>
        <pageNumber>3</pageNumber>
        <pageNumber>4</pageNumber>
        <pageNumber>7</pageNumber>
    </pageRange>
</document>
Response
<conflictItem>
    <instanceType>DOCUMENT</instanceType>
    <id>301YW1E_00077ZVD900003H</id>
</conflictItem>
Sample 2 - Request to append the document you are copying to the existing document
Request URL
/v1/document/301YW1J_000782VD90000B8/copy?action=APPEND
Request
<document>
    <info>
        <name>Document Name</name>
        <locationId>301YVCP_000294NLF000006</locationId>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
    <pageRange>
        <pageNumber>2</pageNumber>
        <pageNumber>3</pageNumber>
        <pageNumber>4</pageNumber>
        <pageNumber>7</pageNumber>
    </pageRange>
</document>

GET/v1/document/{id}/digitalSignature Gets the digital signatures associated with a document version.

Expand Operation / Collapse Operation

Gets the digital signatures associated with a document version.

Available from version: 1.0.0

Call Properties

Query Parameter
version (optional) Has 3 possible values: ALL, LATEST, or a number which represents the version. Default is LATEST.
Response
Content
documentDigitalSignatures
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

creationInfo type

Contains information about the creation of a digital signature.

Field Name Data Type Expected Description
createTime Long Yes The time the instance was signed
userFirstName String Yes The first name of the digital signature owner
userId String Yes The id of the digital signature owner
userLastName String Yes The last name of the digital signature owner
userPrefix String Yes The prefix of the digital signature owner
userSuffix String Yes The suffix of the digital signature owner
username String Yes The username of the digital signature owner
digitalSignature type

Represents an ImageNow digital signature.

Field Name Data Type Expected Description
creationInfo creationInfo Yes The creation information about the digital signature
id String Yes The digital signature's id
reason String Yes The reason associated with the digital signature
status status Yes The current status of the digital signature
statusTime Long Yes The time the status was last changed
validSignature boolean Yes Is the digital signature valid
versionId String Yes The version id of the instance this signature is for
versionNumber Integer Yes The version number of the instance this signature is for
voidUserId String Yes The id of the user who voided the digital signature
documentDigitalSignatures type

Contains information about the digital signatures attached to a document.

Field Name Data Type Expected Description
otherVersionsSigned boolean Yes Are other versions of the document signed
signatures List of digitalSignature [signature] Yes The collection of signatures
status enumeration

The status of the digital signature

Constant Name Description
VALID Valid signature
EXPIRED Expired signature
INVALID Invalid signature
VOIDED Voided signatured
VOIDED_KEY_PAIR Voided username/password pair that signed the signature

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/digitalSignature?version=2
Response
{"otherVersionsSigned":false,"signatures":[{"id":"301YW1E_00077ZVD900003J","versionId":"301YW1E_00077ZVD900005L","versionNumber":2,"creationInfo":{"username":"test1","userId":"301YVD7_0002ZL50K000007","userPrefix":"Mr.","userFirstName":"John","userLastName":"Sample","userSuffix":"Esq.","createTime":318211200000},"voidUserId":"301YVD7_0002ZL50K000009","status":"VOIDED","statusTime":318215700000,"reason":"Reason for signature status.","validSignature":false}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/digitalSignature?version=2
Response
<documentDigitalSignatures>
    <signatures>
        <signature>
            <id>301YW1E_00077ZVD900003J</id>
            <versionId>301YW1E_00077ZVD900005L</versionId>
            <versionNumber>2</versionNumber>
            <creationInfo>
                <username>test1</username>
                <userId>301YVD7_0002ZL50K000007</userId>
                <userPrefix>Mr.</userPrefix>
                <userFirstName>John</userFirstName>
                <userLastName>Sample</userLastName>
                <userSuffix>Esq.</userSuffix>
                <createTime>318211200000</createTime>
            </creationInfo>
            <voidUserId>301YVD7_0002ZL50K000009</voidUserId>
            <status>VOIDED</status>
            <statusTime>318215700000</statusTime>
            <reason>Reason for signature status.</reason>
            <validSignature>false</validSignature>
        </signature>
    </signatures>
    <otherVersionsSigned>false</otherVersionsSigned>
</documentDigitalSignatures>

POST/v1/document/{id}/digitalSignature/sign Will sign a document on behalf of the current user.

Expand Operation / Collapse Operation

Will sign a document on behalf of the current user.

Available from version: 1.0.0

Call Properties

Request
Content documentSignatureInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

documentSignatureInfo type

Represents the request to sign a document.

Field Name Data Type Expected Description
password String Yes This is the password required for signing a document.
reasonId String Yes This is the ID for the reason assigned to document signature.
versionNumber Integer No This is the version number the user is signing

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/digitalSignature/sign
Request
{"password":"P4ssw0rd!","reasonId":"301YW1J_000782ZD900EDC0","versionNumber":5}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/digitalSignature/sign
Request
<documentSignatureInfo>
    <password>P4ssw0rd!</password>
    <reasonId>301YW1J_000782ZD900EDC0</reasonId>
    <versionNumber>5</versionNumber>
</documentSignatureInfo>

POST/v1/document/{id}/digitalSignature/verifyAll Verifies all signatures on a specific version of a document.

Expand Operation / Collapse Operation

Verifies all signatures on a specific version of a document.

Available from version: 1.0.0

Call Properties

Request
Content verifyAllDigitalSignaturesInfo
Content-Types
  • application/xml
  • application/json
Response
Content
signatureStatusList
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

signatureStatus type

The status of the signatures.

Field Name Data Type Expected Description
id String Yes The ID of the signature.
status signatureStatus Yes The status of the signature.
signatureStatus enumeration

The signature status

Constant Name Description
VERSION_SIGNATURE_VALID Indicates that a document signature is valid.
VERSION_SIGNATURE_EXPIRED Indicates that a document signature has expired.
VERSION_SIGNATURE_INVALID Indicates that a document signature is invalid.
VERSION_SIGNATURE_VOIDED Indicates that a document signature has been voided.
VERSION_SIGNATURE_VOIDED_KEY_PAIR Indicates that document signature has a voided key pair
signatureStatusList type

Represents a list of digital signature statuses.

Field Name Data Type Expected Description
signatureStatusList List of signatureStatus [signatureStatus] Yes A list of signatures and their status.
verifyAllDigitalSignaturesInfo type

Information required to verify signatures on a document version.

Field Name Data Type Expected Description
versionNumber Integer Yes The version number to verify signatures for.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782XC40000S8/digitalSignature/verifyAll
Request
{"versionNumber":2}
Response
{"signatureStatusList":[{"status":"VERSION_SIGNATURE_VOIDED","id":"301YW1J_00078ZZD40000X5"},{"status":"VERSION_SIGNATURE_VALID","id":"301YW1J_000DDZBD4000026"}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782XC40000S8/digitalSignature/verifyAll
Request
<verifyAllDigitalSignaturesInfo>
    <versionNumber>2</versionNumber>
</verifyAllDigitalSignaturesInfo>
Response
<signatureStatusList>
    <signatureStatusList>
        <signatureStatus>
            <status>VERSION_SIGNATURE_VOIDED</status>
            <id>301YW1J_00078ZZD40000X5</id>
        </signatureStatus>
        <signatureStatus>
            <status>VERSION_SIGNATURE_VALID</status>
            <id>301YW1J_000DDZBD4000026</id>
        </signatureStatus>
    </signatureStatusList>
</signatureStatusList>

GET/v1/document/{id}/hold Get retention holds for the document.

Expand Operation / Collapse Operation

Get retention holds for the document.

Available from version: 1.0.0

Call Properties

Response
Content
List of documentHold [documentHold]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

documentHold type

Represents the retention hold attached to a document.

Field Name Data Type Expected Description
assignmentId String Yes The ID of the hold assignment.
canRemove Boolean Yes A flag that represents the ability to remove the hold.
description String Yes The description of the hold.
expirationTime Long Yes The time the hold expires.
holdObjectId String Yes The ID of the object causing the hold.
holdObjectRelation holdAssignmentRelation Yes The relation of object causing the hold.
holdObjectType holdObjectType Yes The type of the hold assignment.
id String Yes The ID of the hold.
name String Yes The name of the hold.
holdAssignmentRelation enumeration

The type of retention hold relation.

Constant Name Description
DIRECT A direct hold.
INHERITANCE_TYPE An inherited hold by type.
INHERITANCE_ANCESTOR An inherited hold by ancestor.
holdObjectType enumeration

The object type represented by the retention hold assignment.

Constant Name Description
DOCUMENT_TYPE Document type assignment type.
DOCUMENT Document assignment type.
RECORD Record assignment type.
RECORD_FOLDER Record Folder assignment type.

JSON Samples

Sample 1 - Request to get all hold assignments for document.
Request URL
/v1/document/301YW1J_000782VD90000B8/hold
Response
{"documentHolds":[{"id":"301YW1J_000782VD90000B0","name":"hold 1 name","description":"hold 1 description","expirationTime":1468511919,"canRemove":true,"holdObjectId":"301YW1J_000782VD90000C0","assignmentId":"301YW1J_000782VD90000D0","holdObjectRelation":"DIRECT","holdObjectType":"DOCUMENT"},{"id":"301YW1J_000782VD90000B1","name":"hold 2 name","description":"hold 2 description","expirationTime":1468511919,"canRemove":false,"holdObjectId":"301YW1J_000782VD90000C1","assignmentId":"301YW1J_000782VD90000D1","holdObjectRelation":"DIRECT","holdObjectType":"DOCUMENT"}]}

XML Samples

Sample 1 - Request to get all hold assignments for document.
Request URL
/v1/document/301YW1J_000782VD90000B8/hold
Response
<documentHolds>
    <documentHold>
        <id>301YW1J_000782VD90000B0</id>
        <name>hold 1 name</name>
        <description>hold 1 description</description>
        <expirationTime>1468511919</expirationTime>
        <canRemove>true</canRemove>
        <holdObjectId>301YW1J_000782VD90000C0</holdObjectId>
        <assignmentId>301YW1J_000782VD90000D0</assignmentId>
        <holdObjectRelation>DIRECT</holdObjectRelation>
        <holdObjectType>DOCUMENT</holdObjectType>
    </documentHold>
    <documentHold>
        <id>301YW1J_000782VD90000B1</id>
        <name>hold 2 name</name>
        <description>hold 2 description</description>
        <expirationTime>1468511919</expirationTime>
        <canRemove>false</canRemove>
        <holdObjectId>301YW1J_000782VD90000C1</holdObjectId>
        <assignmentId>301YW1J_000782VD90000D1</assignmentId>
        <holdObjectRelation>DIRECT</holdObjectRelation>
        <holdObjectType>DOCUMENT</holdObjectType>
    </documentHold>
</documentHolds>

PUT/v1/document/{id}/name Update the name of a document stored in the Server.

Expand Operation / Collapse Operation

Update the name of a document stored in the Server.

Available from version: 1.0.0

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The action to preform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content itemName
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
itemName type

Represents the desired name of a item

Field Name Data Type Expected Description
name String Yes The desired name of the item.

JSON Samples

Sample 1 - Request to rename a document with a response indicating a naming conflict
Request URL
/v1/document/301YW1J_000782VD90000B8/name
Request
{"name":"JuneExpenseReport"}
Response
{"instanceType":"DOCUMENT","id":"301YW1E_00077ZVD900003H"}
Sample 2 - Request to append the document you are renaming to the existing document
Request URL
/v1/document/301YW1J_000782VD90000B8/name?action=APPEND
Request
{"name":"JuneExpenseReport"}

XML Samples

Sample 1 - Request to rename a document with a response indicating a naming conflict
Request URL
/v1/document/301YW1J_000782VD90000B8/name
Request
<itemName>
    <name>JuneExpenseReport</name>
</itemName>
Response
<conflictItem>
    <instanceType>DOCUMENT</instanceType>
    <id>301YW1E_00077ZVD900003H</id>
</conflictItem>
Sample 2 - Request to append the document you are renaming to the existing document
Request URL
/v1/document/301YW1J_000782VD90000B8/name?action=APPEND
Request
<itemName>
    <name>JuneExpenseReport</name>
</itemName>

GET/v1/document/{id}/page Gets all of the page information for the document stored in the Server that matches the ID.

Expand Operation / Collapse Operation

Gets all of the page information for the document stored in the Server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
List of page [page]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
name String Yes The page's name
pageNumber Integer Yes The page's sequence number

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page
Response
{"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}]}
Sample 2 - versionNumber parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page?versionNumber=1
Response
{"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}]}
Sample 3 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page?queueId=321YZ46_000QEJ5XJ000021
Response
{"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page
Response
<pages>
    <page>
        <id>301YVD7_0002ZL50K000005</id>
        <name>SampleFile.txt</name>
        <extension>txt</extension>
        <pageNumber>1</pageNumber>
    </page>
    <page>
        <id>301YVD9_000303045000001</id>
        <name>SampleDocument.doc</name>
        <extension>doc</extension>
        <pageNumber>1</pageNumber>
    </page>
</pages>
Sample 2 - versionNumber parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page?versionNumber=1
Response
<pages>
    <page>
        <id>301YVD7_0002ZL50K000005</id>
        <name>SampleFile.txt</name>
        <extension>txt</extension>
        <pageNumber>1</pageNumber>
    </page>
    <page>
        <id>301YVD9_000303045000001</id>
        <name>SampleDocument.doc</name>
        <extension>doc</extension>
        <pageNumber>1</pageNumber>
    </page>
</pages>
Sample 3 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page?queueId=321YZ46_000QEJ5XJ000021
Response
<pages>
    <page>
        <id>301YVD7_0002ZL50K000005</id>
        <name>SampleFile.txt</name>
        <extension>txt</extension>
        <pageNumber>1</pageNumber>
    </page>
    <page>
        <id>301YVD9_000303045000001</id>
        <name>SampleDocument.doc</name>
        <extension>doc</extension>
        <pageNumber>1</pageNumber>
    </page>
</pages>

POST/v1/document/{id}/page Adds a page to a document stored in the Server.

Expand Operation / Collapse Operation

Adds a page to a document stored in the Server.

Available from version: 1.0.0

Call Properties

Request
Content Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-Name The name to associate with the page.
X-IntegrationServer-File-Size The number of bytes in the file.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page

DELETE/v1/document/{id}/page/{pageId} Deletes a page from a document.

Expand Operation / Collapse Operation

Deletes a page from a document.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to delete.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005

PUT/v1/document/{id}/page/{pageId} Updates a page in a document.

Expand Operation / Collapse Operation

Updates a page in a document.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to update.
Request
Content page
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

amount enumeration

The amount to rotate the page

Constant Name Description
DEGREES_90 Rotate the page 90 degrees clockwise
DEGREES_180 Rotate the page 180 degrees clockwise
DEGREES_270 Rotate the page 270 degrees clockwise
mode enumeration

Where to place the page within the document with respect to the other pages in the document.

Constant Name Description
FIRST Make the page the first page in the document.
LAST Make the page the last page in the document.
BEFORE Place the page before the reference page.
AFTER Place the page after the reference page.
moveMode enumeration

Whether to copy or move the page.

Constant Name Description
MOVE Move the page.
COPY Copy the page.
page type

Represents information about a document page

Field Name Data Type Expected Description
location pageLocation No Update the page's location within a document or in another document. Optional, doesn't update location if not provided
rotation rotation No Rotate the page. Optional, doesn't rotate if not provided.
pageLocation type

Update the pages location within a document

Field Name Data Type Expected Description
documentId String No Document to put the page in. Optional, default is current document.
mode mode Yes How to place the page within the document with respect to other pages.
moveMode moveMode No Whether to copy or move the page. Optional, default is move.
referencePageId String No Reference page in document to determine where to place page. Required if mode is before/after.
rotation type

Rotate a page on a document a given amount

Field Name Data Type Expected Description
amount amount Yes The amount to rotate the page
subPage Integer No The sub-page to rotate if page is a mutlipage TIFF, 1 by default

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005
Request
{"rotation":{"amount":"DEGREES_90","subPage":3},"location":{"documentId":"301YW1E_00077ZVD900003H","mode":"BEFORE","referencePageId":"301YVD7_0002ZL50K000010","moveMode":"MOVE"}}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005
Request
<page>
    <rotation>
        <amount>DEGREES_90</amount>
        <subPage>3</subPage>
    </rotation>
    <location>
        <documentId>301YW1E_00077ZVD900003H</documentId>
        <mode>BEFORE</mode>
        <referencePageId>301YVD7_0002ZL50K000010</referencePageId>
        <moveMode>MOVE</moveMode>
    </location>
</page>

GET/v1/document/{id}/page/{pageId}/annotation Gets all of the annotations for the document page stored in the Server.

Expand Operation / Collapse Operation

Gets all of the annotations for the document page stored in the Server.

Available from version: 1.0.0

Call Properties

Query Parameters
type (optional) A collection of annotation types used in filtering.
filePageNumber (optional) The sub-page number used to filter annotations. Zero indicates all sub-pages
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
annotations
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

accessInfo type

Represents info about when the annotation was accessed

Field Name Data Type Expected Description
time Long Yes The time the annotation was accessed
userId String Yes The user ID
userName String Yes The user name
annotations type

Represents a collection of annotations

Field Name Data Type Expected Description
arrowAnnotations List of arrowAnnotation [arrowAnnotation] Yes The collection of arrows
checkAnnotations List of checkAnnotation [checkAnnotation] Yes The collection of checks
highlightAnnotations List of highlightAnnotation [highlightAnnotation] Yes The collection of highlight annotations
lineAnnotations List of lineAnnotation [lineAnnotation] Yes The collection of lines
ovalAnnotations List of ovalAnnotation [ovalAnnotation] Yes The collection of ovals
penAnnotations List of penAnnotation [penAnnotation] Yes The collection of pens
pictureStampAnnotations List of pictureStampAnnotation [pictureStampAnnotation] Yes The collection of picture stamps
rectangleAnnotations List of rectangleAnnotation [rectangleAnnotation] Yes The collection of rectangles
stickyNoteAnnotations List of stickyNoteAnnotation [stickyNoteAnnotation] Yes The collection of sticky notes
textAnnotations List of textAnnotation [textAnnotation] Yes The collection of texts
textStampAnnotations List of textStampAnnotation [textStampAnnotation] Yes The collection of text stamps
urlAnnotations List of urlAnnotation [urlAnnotation] Yes The collection of urls
annotationType enumeration

Represents an annotation type

Constant Name Description
ARROW An arrow annotation
CHECK A check annotation
HIGHLIGHT A highlight annotation
LINE A line annotation
RECTANGLE A rectangle annotation
OVAL An oval annotation
PEN A pen annotation
TEXT_STAMP A text stamp annotation
PICTURE_STAMP A picture stamp annotation
TEXT A text annotation
STICKY_NOTE A sticky note annotation
URL A URL annotation
arrowAnnotation type

Represents an arrow annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color for the annotation
penWidth Integer Yes The pen width for the annotation
privileges privileges Yes The privilege information for this annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
checkAnnotation type

Represents an check annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
privileges privileges Yes The privilege information for this annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
fileInformation type

Represents information about the file

Field Name Data Type Expected Description
fileExtension String Yes The extension of the file
workingName String Yes The name of the file
font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
frame type

Represents the frame of an annotation

Field Name Data Type Expected Description
frameColor String Yes The frame color for the annotation
frameCornerRadius Integer Yes The frame corner radius for the annotation
frameMarginBottom Integer Yes The frame bottom margin for the annotation
frameMarginLeft Integer Yes The frame left margin for the annotation
frameMarginRight Integer Yes The frame right margin for the annotation
frameMarginTop Integer Yes The frame top margin for the annotation
frameStyle frameStyle Yes The frame style for the annotation
frameThickness Integer Yes The frame thickness for the annotation
frameStyle enumeration

The frame style of an annotation

Constant Name Description
NONE No frame style
RECTANGLE Rectangle frame style
ROUNDED_RECTANGLE Rounded rectangle frame style
ELLIPSE Ellipse frame style
highlightAnnotation type

Represents a highlight annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
lineAnnotation type

Represents a line annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
privileges privileges Yes The privilege information for this annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
note type

Represents a note

Field Name Data Type Expected Description
content String Yes Content
date String Yes Date
userName String Yes User Name
ovalAnnotation type

Represents an oval annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
privileges privileges Yes The privilege information for this annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
penAnnotation type

Represents a pen annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
path List of point [point] Yes The path of the pen annotation from a ollection of points
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width for the annotation
privileges privileges Yes The privilege information for this annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
pictureStampAnnotation type

Represents a picture stamp annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
fileInformation fileInformation Yes Information about the physical file
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
privileges type

Represents privilege information about an annotation

Field Name Data Type Expected Description
canDelete boolean Yes Flag to determine if the annotation can be deleted
canHide boolean Yes Flag to determine if the annotation can be hidden
canModify boolean Yes Flag to determine if the annotation can be modified
rectangleAnnotation type

Represents a rectangle annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
privileges privileges Yes The privilege information for this annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
stickyNoteAnnotation type

Represents an sticky note annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
notes List of note [note] Yes The list of individual notes added to a sticky note
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
textAnnotation type

Represents an text annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
textInformation textInformation Yes The text content of the annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification
textStampAnnotation type

Represents an text stamp annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
dynamicVariables Boolean Yes The format specifiers in the text content are dynamic
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
frame frame Yes Information about the frame of the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
textInformation textInformation Yes The text content of the annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
urlAnnotation type

Represents a URL annotation

Field Name Data Type Expected Description
actionURL String Yes The action url of the annotation
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
textInformation textInformation Yes The text content of the annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation
Response
{"arrowAnnotations":[{"id":"321YY27_000DRV8ZE000001","filePageNumber":1,"templateId":"321YX18_000001Q8C000007","zOrder":2,"creationInfo":{"userId":"321YX18_0000C6VZL000001","userName":"msmith","time":1391793376460},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":false},"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotations":[{"id":"321YX3E_0002CLXPT000001","filePageNumber":2,"templateId":"321YX18_000001Q8C000008","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1363199866783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":true},"location":{"startPoint":{"x":722,"y":811},"endPoint":{"x":823,"y":912}},"penColor":"#FF008000"}],"lineAnnotations":[{"id":"321YY42_000F4RECK000005","filePageNumber":3,"templateId":"321YX18_000001Q8C00000F","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396474318370},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":208,"y":233},"endPoint":{"x":2019,"y":548}},"penColor":"#FF000000","penWidth":3}],"highlightAnnotations":[{"id":"321YY43_000F4BECJ000009","filePageNumber":1,"templateId":"321YX18_000001Q8C00000D","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396533368590},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":532,"y":897},"endPoint":{"x":458,"y":45}},"fillColor":"#FFCCFFFF"}],"ovalAnnotations":[{"id":"321YY43_000F4QECK000003","filePageNumber":1,"templateId":"321YX18_000001Q8C00000J","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396534818487},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":2217,"y":451},"endPoint":{"x":119,"y":680}},"penColor":"#FF0000FF","penWidth":2,"fillColor":"#00000000"}],"penAnnotations":[{"id":"321YY43_000F4BECJ00000G","filePageNumber":1,"templateId":"321YX18_000001Q8C00000M","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538112597},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"penColor":"#FFFF0000","penWidth":3,"path":[{"x":1849,"y":266},{"x":1852,"y":266},{"x":1855,"y":266}]}],"pictureStampAnnotations":[{"id":"321YY43_000F4TECK000005","filePageNumber":1,"templateId":"321YX3N_0002RXR9000000W","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538946523},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":249,"y":166}},"fileInformation":{"workingName":null,"fileExtension":"PNG"}}],"rectangleAnnotations":[{"id":"321YY43_000F4JECJ00000F","filePageNumber":1,"templateId":"321YX18_000001Q8C00000P","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396540036243},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":1515,"y":2531},"endPoint":{"x":309,"y":110}},"penColor":"#FFFF0000","penWidth":1,"fillColor":"#FFFF0000"}],"stickyNoteAnnotations":[{"id":"321YY43_000F51S4G000001","filePageNumber":1,"templateId":"321YX18_000001Q8C00000R","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547070910},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":true,"canDelete":false},"startLocation":{"startPoint":{"x":650,"y":1685}},"notes":[{"userName":"jdoe","date":"4/7/2014","content":"Hello World!"},{"userName":"jdoe","date":"4/8/2014","content":"This is some content.\r\nAnd another line of content"}]}],"textAnnotations":[{"id":"321YY43_000F5KS4G000002","filePageNumber":1,"templateId":"321YY1W_000DKBFM5000004","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547509580},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":201,"y":1743}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text <hour.24>:<minute>"}}],"textStampAnnotations":[{"id":"321YY43_000F5BS4G000002","filePageNumber":1,"templateId":"321YX18_000001Q8C00000V","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396549670177},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":1333,"y":66}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF008000","frameThickness":3,"frameCornerRadius":8,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF008000","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Viewed by <user.name> at <hour.24>:<minute>:<second>"},"dynamicVariables":false}],"urlAnnotations":[{"id":"321YY43_000F50S4G000006","filePageNumber":1,"templateId":"321YX7C_0006M43PS00001J","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396551595783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":935,"y":64}},"textInformation":{"font":{"face":"Arial","color":"#FF0000FF","height":12,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}]}
Sample 2
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?type=ARROW&type=CHECK&filePageNumber=2
Response
{"arrowAnnotations":[{"id":"321YY27_000DRV8ZE000001","filePageNumber":1,"templateId":"321YX18_000001Q8C000007","zOrder":2,"creationInfo":{"userId":"321YX18_0000C6VZL000001","userName":"msmith","time":1391793376460},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":false},"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotations":[{"id":"321YX3E_0002CLXPT000001","filePageNumber":2,"templateId":"321YX18_000001Q8C000008","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1363199866783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":true},"location":{"startPoint":{"x":722,"y":811},"endPoint":{"x":823,"y":912}},"penColor":"#FF008000"}],"lineAnnotations":[],"highlightAnnotations":[],"ovalAnnotations":[],"penAnnotations":[],"pictureStampAnnotations":[],"rectangleAnnotations":[],"stickyNoteAnnotations":[],"textAnnotations":[],"textStampAnnotations":[],"urlAnnotations":[]}
Sample 3 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?queueId=321YZ46_000QEJ5XJ000021
Response
{"arrowAnnotations":[{"id":"321YY27_000DRV8ZE000001","filePageNumber":1,"templateId":"321YX18_000001Q8C000007","zOrder":2,"creationInfo":{"userId":"321YX18_0000C6VZL000001","userName":"msmith","time":1391793376460},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":false},"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotations":[{"id":"321YX3E_0002CLXPT000001","filePageNumber":2,"templateId":"321YX18_000001Q8C000008","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1363199866783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":true},"location":{"startPoint":{"x":722,"y":811},"endPoint":{"x":823,"y":912}},"penColor":"#FF008000"}],"lineAnnotations":[{"id":"321YY42_000F4RECK000005","filePageNumber":3,"templateId":"321YX18_000001Q8C00000F","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396474318370},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":208,"y":233},"endPoint":{"x":2019,"y":548}},"penColor":"#FF000000","penWidth":3}],"highlightAnnotations":[{"id":"321YY43_000F4BECJ000009","filePageNumber":1,"templateId":"321YX18_000001Q8C00000D","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396533368590},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":532,"y":897},"endPoint":{"x":458,"y":45}},"fillColor":"#FFCCFFFF"}],"ovalAnnotations":[{"id":"321YY43_000F4QECK000003","filePageNumber":1,"templateId":"321YX18_000001Q8C00000J","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396534818487},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":2217,"y":451},"endPoint":{"x":119,"y":680}},"penColor":"#FF0000FF","penWidth":2,"fillColor":"#00000000"}],"penAnnotations":[{"id":"321YY43_000F4BECJ00000G","filePageNumber":1,"templateId":"321YX18_000001Q8C00000M","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538112597},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"penColor":"#FFFF0000","penWidth":3,"path":[{"x":1849,"y":266},{"x":1852,"y":266},{"x":1855,"y":266}]}],"pictureStampAnnotations":[{"id":"321YY43_000F4TECK000005","filePageNumber":1,"templateId":"321YX3N_0002RXR9000000W","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538946523},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":249,"y":166}},"fileInformation":{"workingName":null,"fileExtension":"PNG"}}],"rectangleAnnotations":[{"id":"321YY43_000F4JECJ00000F","filePageNumber":1,"templateId":"321YX18_000001Q8C00000P","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396540036243},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":1515,"y":2531},"endPoint":{"x":309,"y":110}},"penColor":"#FFFF0000","penWidth":1,"fillColor":"#FFFF0000"}],"stickyNoteAnnotations":[{"id":"321YY43_000F51S4G000001","filePageNumber":1,"templateId":"321YX18_000001Q8C00000R","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547070910},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":true,"canDelete":false},"startLocation":{"startPoint":{"x":650,"y":1685}},"notes":[{"userName":"jdoe","date":"4/7/2014","content":"Hello World!"},{"userName":"jdoe","date":"4/8/2014","content":"This is some content.\r\nAnd another line of content"}]}],"textAnnotations":[{"id":"321YY43_000F5KS4G000002","filePageNumber":1,"templateId":"321YY1W_000DKBFM5000004","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547509580},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":201,"y":1743}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text <hour.24>:<minute>"}}],"textStampAnnotations":[{"id":"321YY43_000F5BS4G000002","filePageNumber":1,"templateId":"321YX18_000001Q8C00000V","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396549670177},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":1333,"y":66}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF008000","frameThickness":3,"frameCornerRadius":8,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF008000","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Viewed by <user.name> at <hour.24>:<minute>:<second>"},"dynamicVariables":false}],"urlAnnotations":[{"id":"321YY43_000F50S4G000006","filePageNumber":1,"templateId":"321YX7C_0006M43PS00001J","zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396551595783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":935,"y":64}},"textInformation":{"font":{"face":"Arial","color":"#FF0000FF","height":12,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation
Response
<annotations>
    <arrowAnnotations>
        <arrowAnnotation>
            <id>321YY27_000DRV8ZE000001</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C000007</templateId>
            <zOrder>2</zOrder>
            <creationInfo>
                <userId>321YX18_0000C6VZL000001</userId>
                <userName>msmith</userName>
                <time>1391793376460</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>836</x>
                    <y>1387</y>
                </startPoint>
                <endPoint>
                    <x>941</x>
                    <y>1890</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotation>
    </arrowAnnotations>
    <checkAnnotations>
        <checkAnnotation>
            <id>321YX3E_0002CLXPT000001</id>
            <filePageNumber>2</filePageNumber>
            <templateId>321YX18_000001Q8C000008</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1363199866783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>true</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>722</x>
                    <y>811</y>
                </startPoint>
                <endPoint>
                    <x>823</x>
                    <y>912</y>
                </endPoint>
            </location>
            <penColor>#FF008000</penColor>
        </checkAnnotation>
    </checkAnnotations>
    <lineAnnotations>
        <lineAnnotation>
            <id>321YY42_000F4RECK000005</id>
            <filePageNumber>3</filePageNumber>
            <templateId>321YX18_000001Q8C00000F</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396474318370</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>208</x>
                    <y>233</y>
                </startPoint>
                <endPoint>
                    <x>2019</x>
                    <y>548</y>
                </endPoint>
            </location>
            <penColor>#FF000000</penColor>
            <penWidth>3</penWidth>
        </lineAnnotation>
    </lineAnnotations>
    <highlightAnnotations>
        <highlightAnnotation>
            <id>321YY43_000F4BECJ000009</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000D</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396533368590</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>532</x>
                    <y>897</y>
                </startPoint>
                <endPoint>
                    <x>458</x>
                    <y>45</y>
                </endPoint>
            </location>
            <fillColor>#FFCCFFFF</fillColor>
        </highlightAnnotation>
    </highlightAnnotations>
    <ovalAnnotations>
        <ovalAnnotation>
            <id>321YY43_000F4QECK000003</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000J</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396534818487</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>2217</x>
                    <y>451</y>
                </startPoint>
                <endPoint>
                    <x>119</x>
                    <y>680</y>
                </endPoint>
            </location>
            <penColor>#FF0000FF</penColor>
            <penWidth>2</penWidth>
            <fillColor>#00000000</fillColor>
        </ovalAnnotation>
    </ovalAnnotations>
    <penAnnotations>
        <penAnnotation>
            <id>321YY43_000F4BECJ00000G</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000M</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538112597</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <path>
                <point>
                    <x>1849</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1852</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1855</x>
                    <y>266</y>
                </point>
            </path>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </penAnnotation>
    </penAnnotations>
    <pictureStampAnnotations>
        <pictureStampAnnotation>
            <id>321YY43_000F4TECK000005</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX3N_0002RXR9000000W</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538946523</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>249</x>
                    <y>166</y>
                </startPoint>
            </startLocation>
            <fileInformation>
                <fileExtension>PNG</fileExtension>
            </fileInformation>
        </pictureStampAnnotation>
    </pictureStampAnnotations>
    <rectangleAnnotations>
        <rectangleAnnotation>
            <id>321YY43_000F4JECJ00000F</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000P</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396540036243</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>1515</x>
                    <y>2531</y>
                </startPoint>
                <endPoint>
                    <x>309</x>
                    <y>110</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>1</penWidth>
            <fillColor>#FFFF0000</fillColor>
        </rectangleAnnotation>
    </rectangleAnnotations>
    <stickyNoteAnnotations>
        <stickyNoteAnnotation>
            <id>321YY43_000F51S4G000001</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000R</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547070910</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>650</x>
                    <y>1685</y>
                </startPoint>
            </startLocation>
            <notes>
                <note>
                    <userName>jdoe</userName>
                    <date>4/7/2014</date>
                    <content>Hello World!</content>
                </note>
                <note>
                    <userName>jdoe</userName>
                    <date>4/8/2014</date>
                    <content>This is some content.&#13;
And another line of content</content>
                </note>
            </notes>
        </stickyNoteAnnotation>
    </stickyNoteAnnotations>
    <textAnnotations>
        <textAnnotation>
            <id>321YY43_000F5KS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YY1W_000DKBFM5000004</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547509580</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>201</x>
                    <y>1743</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Times New Roman</face>
                    <color>#FF0000FF</color>
                    <height>14</height>
                    <bold>true</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>My Text &lt;hour.24&gt;:&lt;minute&gt;</text>
            </textInformation>
        </textAnnotation>
    </textAnnotations>
    <textStampAnnotations>
        <textStampAnnotation>
            <id>321YY43_000F5BS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000V</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396549670177</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>1333</x>
                    <y>66</y>
                </startPoint>
            </startLocation>
            <fillColor>#00000000</fillColor>
            <frame>
                <frameStyle>ROUNDED_RECTANGLE</frameStyle>
                <frameColor>#FF008000</frameColor>
                <frameThickness>3</frameThickness>
                <frameCornerRadius>8</frameCornerRadius>
                <frameMarginLeft>5</frameMarginLeft>
                <frameMarginRight>5</frameMarginRight>
                <frameMarginTop>0</frameMarginTop>
                <frameMarginBottom>0</frameMarginBottom>
            </frame>
            <textInformation>
                <font>
                    <face>Stencil</face>
                    <color>#FF008000</color>
                    <height>20</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>Viewed by &lt;user.name&gt; at &lt;hour.24&gt;:&lt;minute&gt;:&lt;second&gt;</text>
            </textInformation>
            <dynamicVariables>false</dynamicVariables>
        </textStampAnnotation>
    </textStampAnnotations>
    <urlAnnotations>
        <urlAnnotation>
            <id>321YY43_000F50S4G000006</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX7C_0006M43PS00001J</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396551595783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>935</x>
                    <y>64</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Arial</face>
                    <color>#FF0000FF</color>
                    <height>12</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>true</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_LEFT</justify>
                <text>Perceptive Software</text>
            </textInformation>
            <actionURL>http://www.perceptivesoftware.com</actionURL>
        </urlAnnotation>
    </urlAnnotations>
</annotations>
Sample 2
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?type=ARROW&type=CHECK&filePageNumber=2
Response
<annotations>
    <arrowAnnotations>
        <arrowAnnotation>
            <id>321YY27_000DRV8ZE000001</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C000007</templateId>
            <zOrder>2</zOrder>
            <creationInfo>
                <userId>321YX18_0000C6VZL000001</userId>
                <userName>msmith</userName>
                <time>1391793376460</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>836</x>
                    <y>1387</y>
                </startPoint>
                <endPoint>
                    <x>941</x>
                    <y>1890</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotation>
    </arrowAnnotations>
    <checkAnnotations>
        <checkAnnotation>
            <id>321YX3E_0002CLXPT000001</id>
            <filePageNumber>2</filePageNumber>
            <templateId>321YX18_000001Q8C000008</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1363199866783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>true</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>722</x>
                    <y>811</y>
                </startPoint>
                <endPoint>
                    <x>823</x>
                    <y>912</y>
                </endPoint>
            </location>
            <penColor>#FF008000</penColor>
        </checkAnnotation>
    </checkAnnotations>
    <lineAnnotations/>
    <highlightAnnotations/>
    <ovalAnnotations/>
    <penAnnotations/>
    <pictureStampAnnotations/>
    <rectangleAnnotations/>
    <stickyNoteAnnotations/>
    <textAnnotations/>
    <textStampAnnotations/>
    <urlAnnotations/>
</annotations>
Sample 3 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?queueId=321YZ46_000QEJ5XJ000021
Response
<annotations>
    <arrowAnnotations>
        <arrowAnnotation>
            <id>321YY27_000DRV8ZE000001</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C000007</templateId>
            <zOrder>2</zOrder>
            <creationInfo>
                <userId>321YX18_0000C6VZL000001</userId>
                <userName>msmith</userName>
                <time>1391793376460</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>836</x>
                    <y>1387</y>
                </startPoint>
                <endPoint>
                    <x>941</x>
                    <y>1890</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotation>
    </arrowAnnotations>
    <checkAnnotations>
        <checkAnnotation>
            <id>321YX3E_0002CLXPT000001</id>
            <filePageNumber>2</filePageNumber>
            <templateId>321YX18_000001Q8C000008</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1363199866783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>true</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>722</x>
                    <y>811</y>
                </startPoint>
                <endPoint>
                    <x>823</x>
                    <y>912</y>
                </endPoint>
            </location>
            <penColor>#FF008000</penColor>
        </checkAnnotation>
    </checkAnnotations>
    <lineAnnotations>
        <lineAnnotation>
            <id>321YY42_000F4RECK000005</id>
            <filePageNumber>3</filePageNumber>
            <templateId>321YX18_000001Q8C00000F</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396474318370</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>208</x>
                    <y>233</y>
                </startPoint>
                <endPoint>
                    <x>2019</x>
                    <y>548</y>
                </endPoint>
            </location>
            <penColor>#FF000000</penColor>
            <penWidth>3</penWidth>
        </lineAnnotation>
    </lineAnnotations>
    <highlightAnnotations>
        <highlightAnnotation>
            <id>321YY43_000F4BECJ000009</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000D</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396533368590</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>532</x>
                    <y>897</y>
                </startPoint>
                <endPoint>
                    <x>458</x>
                    <y>45</y>
                </endPoint>
            </location>
            <fillColor>#FFCCFFFF</fillColor>
        </highlightAnnotation>
    </highlightAnnotations>
    <ovalAnnotations>
        <ovalAnnotation>
            <id>321YY43_000F4QECK000003</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000J</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396534818487</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>2217</x>
                    <y>451</y>
                </startPoint>
                <endPoint>
                    <x>119</x>
                    <y>680</y>
                </endPoint>
            </location>
            <penColor>#FF0000FF</penColor>
            <penWidth>2</penWidth>
            <fillColor>#00000000</fillColor>
        </ovalAnnotation>
    </ovalAnnotations>
    <penAnnotations>
        <penAnnotation>
            <id>321YY43_000F4BECJ00000G</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000M</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538112597</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <path>
                <point>
                    <x>1849</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1852</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1855</x>
                    <y>266</y>
                </point>
            </path>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </penAnnotation>
    </penAnnotations>
    <pictureStampAnnotations>
        <pictureStampAnnotation>
            <id>321YY43_000F4TECK000005</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX3N_0002RXR9000000W</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538946523</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>249</x>
                    <y>166</y>
                </startPoint>
            </startLocation>
            <fileInformation>
                <fileExtension>PNG</fileExtension>
            </fileInformation>
        </pictureStampAnnotation>
    </pictureStampAnnotations>
    <rectangleAnnotations>
        <rectangleAnnotation>
            <id>321YY43_000F4JECJ00000F</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000P</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396540036243</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>1515</x>
                    <y>2531</y>
                </startPoint>
                <endPoint>
                    <x>309</x>
                    <y>110</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>1</penWidth>
            <fillColor>#FFFF0000</fillColor>
        </rectangleAnnotation>
    </rectangleAnnotations>
    <stickyNoteAnnotations>
        <stickyNoteAnnotation>
            <id>321YY43_000F51S4G000001</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000R</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547070910</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>650</x>
                    <y>1685</y>
                </startPoint>
            </startLocation>
            <notes>
                <note>
                    <userName>jdoe</userName>
                    <date>4/7/2014</date>
                    <content>Hello World!</content>
                </note>
                <note>
                    <userName>jdoe</userName>
                    <date>4/8/2014</date>
                    <content>This is some content.&#13;
And another line of content</content>
                </note>
            </notes>
        </stickyNoteAnnotation>
    </stickyNoteAnnotations>
    <textAnnotations>
        <textAnnotation>
            <id>321YY43_000F5KS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YY1W_000DKBFM5000004</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547509580</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>201</x>
                    <y>1743</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Times New Roman</face>
                    <color>#FF0000FF</color>
                    <height>14</height>
                    <bold>true</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>My Text &lt;hour.24&gt;:&lt;minute&gt;</text>
            </textInformation>
        </textAnnotation>
    </textAnnotations>
    <textStampAnnotations>
        <textStampAnnotation>
            <id>321YY43_000F5BS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX18_000001Q8C00000V</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396549670177</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>1333</x>
                    <y>66</y>
                </startPoint>
            </startLocation>
            <fillColor>#00000000</fillColor>
            <frame>
                <frameStyle>ROUNDED_RECTANGLE</frameStyle>
                <frameColor>#FF008000</frameColor>
                <frameThickness>3</frameThickness>
                <frameCornerRadius>8</frameCornerRadius>
                <frameMarginLeft>5</frameMarginLeft>
                <frameMarginRight>5</frameMarginRight>
                <frameMarginTop>0</frameMarginTop>
                <frameMarginBottom>0</frameMarginBottom>
            </frame>
            <textInformation>
                <font>
                    <face>Stencil</face>
                    <color>#FF008000</color>
                    <height>20</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>Viewed by &lt;user.name&gt; at &lt;hour.24&gt;:&lt;minute&gt;:&lt;second&gt;</text>
            </textInformation>
            <dynamicVariables>false</dynamicVariables>
        </textStampAnnotation>
    </textStampAnnotations>
    <urlAnnotations>
        <urlAnnotation>
            <id>321YY43_000F50S4G000006</id>
            <filePageNumber>1</filePageNumber>
            <templateId>321YX7C_0006M43PS00001J</templateId>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396551595783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>935</x>
                    <y>64</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Arial</face>
                    <color>#FF0000FF</color>
                    <height>12</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>true</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_LEFT</justify>
                <text>Perceptive Software</text>
            </textInformation>
            <actionURL>http://www.perceptivesoftware.com</actionURL>
        </urlAnnotation>
    </urlAnnotations>
</annotations>

POST/v1/document/{id}/page/{pageId}/annotation/ARROW Creates an arrow annotation on a page

Expand Operation / Collapse Operation

Creates an arrow annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content arrowAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

arrowAnnotation type

Represents an arrow annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
location location Yes The location of the annotation
penColor String Yes The pen color for the annotation
penWidth Integer Yes The pen width for the annotation
templateId String Yes The ID of the annotation template used to create this annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW
Request
{"filePageNumber":1,"templateId":"321YX7G_000989TYC100058","location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FF800080","penWidth":5}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX7G_000989TYC100058","location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FF800080","penWidth":5}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW
Request
<arrowAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX7G_000989TYC100058</templateId>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>941</x>
            <y>1890</y>
        </endPoint>
    </location>
    <penColor>#FF800080</penColor>
    <penWidth>5</penWidth>
</arrowAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW?queueId=321YZ46_000QEJ5XJ000021
Request
<arrowAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX7G_000989TYC100058</templateId>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>941</x>
            <y>1890</y>
        </endPoint>
    </location>
    <penColor>#FF800080</penColor>
    <penWidth>5</penWidth>
</arrowAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/ARROW/{annotationId} Updates an arrow annotation on a page

Expand Operation / Collapse Operation

Updates an arrow annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content arrowAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated arrow annotation.

Call Types and Enumerations

arrowAnnotation type

Represents an arrow annotation

Field Name Data Type Expected Description
location location Yes The location of the annotation
penColor String Yes The pen color for the annotation
penWidth Integer Yes The pen width for the annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/321YY27_000DRV8ZE000001
Request
{"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FF800080","penWidth":5}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/321YY27_000DRV8ZE000001?queueId=321YZ46_000QEJ5XJ000021
Request
{"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FF800080","penWidth":5}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/321YY27_000DRV8ZE000001
Request
<arrowAnnotation>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>941</x>
            <y>1890</y>
        </endPoint>
    </location>
    <penColor>#FF800080</penColor>
    <penWidth>5</penWidth>
</arrowAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/321YY27_000DRV8ZE000001?queueId=321YZ46_000QEJ5XJ000021
Request
<arrowAnnotation>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>941</x>
            <y>1890</y>
        </endPoint>
    </location>
    <penColor>#FF800080</penColor>
    <penWidth>5</penWidth>
</arrowAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/CHECK Creates a check annotation on a page

Expand Operation / Collapse Operation

Creates a check annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content checkAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

checkAnnotation type

Represents an check annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK
Request
{"filePageNumber":1,"templateId":"321YX7G_001989TYC100043","location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":936,"y":1487}},"penColor":"#FF008000"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX7G_001989TYC100043","location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":936,"y":1487}},"penColor":"#FF008000"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK
Request
<checkAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX7G_001989TYC100043</templateId>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>936</x>
            <y>1487</y>
        </endPoint>
    </location>
    <penColor>#FF008000</penColor>
</checkAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK?queueId=321YZ46_000QEJ5XJ000021
Request
<checkAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX7G_001989TYC100043</templateId>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>936</x>
            <y>1487</y>
        </endPoint>
    </location>
    <penColor>#FF008000</penColor>
</checkAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/CHECK/{annotationId} Updates a check annotation on a page

Expand Operation / Collapse Operation

Updates a check annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content checkAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

checkAnnotation type

Represents an check annotation

Field Name Data Type Expected Description
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK/321YX3E_0002CLXPT000001
Request
{"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":936,"y":1487}},"penColor":"#FF008000"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK/321YX3E_0002CLXPT000001?queueId=321YZ46_000QEJ5XJ000021
Request
{"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":936,"y":1487}},"penColor":"#FF008000"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK/321YX3E_0002CLXPT000001
Request
<checkAnnotation>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>936</x>
            <y>1487</y>
        </endPoint>
    </location>
    <penColor>#FF008000</penColor>
</checkAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/CHECK/321YX3E_0002CLXPT000001?queueId=321YZ46_000QEJ5XJ000021
Request
<checkAnnotation>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>936</x>
            <y>1487</y>
        </endPoint>
    </location>
    <penColor>#FF008000</penColor>
</checkAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/HIGHLIGHT Creates a highlight annotation on a page

Expand Operation / Collapse Operation

Creates a highlight annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content highlightAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

highlightAnnotation type

Represents a highlight annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
location location Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT
Request
{"filePageNumber":1,"templateId":"321YX5G_004209TYC000038","location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":954,"y":1402}},"fillColor":"#FFCCFFFF"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX5G_004209TYC000038","location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":954,"y":1402}},"fillColor":"#FFCCFFFF"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT
Request
<highlightAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX5G_004209TYC000038</templateId>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>954</x>
            <y>1402</y>
        </endPoint>
    </location>
    <fillColor>#FFCCFFFF</fillColor>
</highlightAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT?queueId=321YZ46_000QEJ5XJ000021
Request
<highlightAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX5G_004209TYC000038</templateId>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>954</x>
            <y>1402</y>
        </endPoint>
    </location>
    <fillColor>#FFCCFFFF</fillColor>
</highlightAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/HIGHLIGHT/{annotationId} Updates a highlight annotation on a page

Expand Operation / Collapse Operation

Updates a highlight annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content highlightAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated highlight annotation.

Call Types and Enumerations

highlightAnnotation type

Represents a highlight annotation

Field Name Data Type Expected Description
fillColor String Yes The fill color of the annotation
location location Yes The location of the annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT/321YY43_000F4BECJ000009
Request
{"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":954,"y":1402}},"fillColor":"#FFCCFFFF"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT/321YY43_000F4BECJ000009?queueId=321YZ46_000QEJ5XJ000021
Request
{"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":954,"y":1402}},"fillColor":"#FFCCFFFF"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT/321YY43_000F4BECJ000009
Request
<highlightAnnotation>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>954</x>
            <y>1402</y>
        </endPoint>
    </location>
    <fillColor>#FFCCFFFF</fillColor>
</highlightAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/HIGHLIGHT/321YY43_000F4BECJ000009?queueId=321YZ46_000QEJ5XJ000021
Request
<highlightAnnotation>
    <location>
        <startPoint>
            <x>836</x>
            <y>1387</y>
        </startPoint>
        <endPoint>
            <x>954</x>
            <y>1402</y>
        </endPoint>
    </location>
    <fillColor>#FFCCFFFF</fillColor>
</highlightAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/LINE Creates a line annotation on a page

Expand Operation / Collapse Operation

Creates a line annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content lineAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

lineAnnotation type

Represents a line annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE
Request
{"filePageNumber":2,"templateId":"321YX5G_008219TZC020042","location":{"startPoint":{"x":586,"y":932},"endPoint":{"x":844,"y":1021}},"penColor":"#FF008080","penWidth":3}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":2,"templateId":"321YX5G_008219TZC020042","location":{"startPoint":{"x":586,"y":932},"endPoint":{"x":844,"y":1021}},"penColor":"#FF008080","penWidth":3}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE
Request
<lineAnnotation>
    <filePageNumber>2</filePageNumber>
    <templateId>321YX5G_008219TZC020042</templateId>
    <location>
        <startPoint>
            <x>586</x>
            <y>932</y>
        </startPoint>
        <endPoint>
            <x>844</x>
            <y>1021</y>
        </endPoint>
    </location>
    <penColor>#FF008080</penColor>
    <penWidth>3</penWidth>
</lineAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE?queueId=321YZ46_000QEJ5XJ000021
Request
<lineAnnotation>
    <filePageNumber>2</filePageNumber>
    <templateId>321YX5G_008219TZC020042</templateId>
    <location>
        <startPoint>
            <x>586</x>
            <y>932</y>
        </startPoint>
        <endPoint>
            <x>844</x>
            <y>1021</y>
        </endPoint>
    </location>
    <penColor>#FF008080</penColor>
    <penWidth>3</penWidth>
</lineAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/LINE/{annotationId} Updates a line annotation on a page

Expand Operation / Collapse Operation

Updates a line annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content lineAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated line annotation.

Call Types and Enumerations

lineAnnotation type

Represents a line annotation

Field Name Data Type Expected Description
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE/321YY42_000F4RECK000005
Request
{"location":{"startPoint":{"x":586,"y":932},"endPoint":{"x":844,"y":1021}},"penColor":"#FF008080","penWidth":3}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE/321YY42_000F4RECK000005?queueId=321YZ46_000QEJ5XJ000021
Request
{"location":{"startPoint":{"x":586,"y":932},"endPoint":{"x":844,"y":1021}},"penColor":"#FF008080","penWidth":3}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE/321YY42_000F4RECK000005
Request
<lineAnnotation>
    <location>
        <startPoint>
            <x>586</x>
            <y>932</y>
        </startPoint>
        <endPoint>
            <x>844</x>
            <y>1021</y>
        </endPoint>
    </location>
    <penColor>#FF008080</penColor>
    <penWidth>3</penWidth>
</lineAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/LINE/321YY42_000F4RECK000005?queueId=321YZ46_000QEJ5XJ000021
Request
<lineAnnotation>
    <location>
        <startPoint>
            <x>586</x>
            <y>932</y>
        </startPoint>
        <endPoint>
            <x>844</x>
            <y>1021</y>
        </endPoint>
    </location>
    <penColor>#FF008080</penColor>
    <penWidth>3</penWidth>
</lineAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/OVAL Creates an oval annotation on a page

Expand Operation / Collapse Operation

Creates an oval annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content ovalAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
ovalAnnotation type

Represents an oval annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL
Request
{"filePageNumber":2,"templateId":"321YX5G_008809RDF050098","penColor":"#FF0000FF","penWidth":3,"location":{"startPoint":{"x":476,"y":691},"endPoint":{"x":794,"y":803}},"fillColor":"#FFCCCCFF"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":2,"templateId":"321YX5G_008809RDF050098","penColor":"#FF0000FF","penWidth":3,"location":{"startPoint":{"x":476,"y":691},"endPoint":{"x":794,"y":803}},"fillColor":"#FFCCCCFF"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL
Request
<ovalAnnotation>
    <filePageNumber>2</filePageNumber>
    <templateId>321YX5G_008809RDF050098</templateId>
    <penColor>#FF0000FF</penColor>
    <penWidth>3</penWidth>
    <location>
        <startPoint>
            <x>476</x>
            <y>691</y>
        </startPoint>
        <endPoint>
            <x>794</x>
            <y>803</y>
        </endPoint>
    </location>
    <fillColor>#FFCCCCFF</fillColor>
</ovalAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL?queueId=321YZ46_000QEJ5XJ000021
Request
<ovalAnnotation>
    <filePageNumber>2</filePageNumber>
    <templateId>321YX5G_008809RDF050098</templateId>
    <penColor>#FF0000FF</penColor>
    <penWidth>3</penWidth>
    <location>
        <startPoint>
            <x>476</x>
            <y>691</y>
        </startPoint>
        <endPoint>
            <x>794</x>
            <y>803</y>
        </endPoint>
    </location>
    <fillColor>#FFCCCCFF</fillColor>
</ovalAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/OVAL/{annotationId} Updates a oval annotation on a page

Expand Operation / Collapse Operation

Updates a oval annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content ovalAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated oval annotation.

Call Types and Enumerations

location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
ovalAnnotation type

Represents an oval annotation

Field Name Data Type Expected Description
fillColor String Yes The fill color of the annotation
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL/321YY43_000F4QECK000003
Request
{"location":{"startPoint":{"x":476,"y":691},"endPoint":{"x":794,"y":803}},"penColor":"#FF0000FF","penWidth":3,"fillColor":"#FFCCCCFF"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL/321YY43_000F4QECK000003?queueId=321YZ46_000QEJ5XJ000021
Request
{"location":{"startPoint":{"x":476,"y":691},"endPoint":{"x":794,"y":803}},"penColor":"#FF0000FF","penWidth":3,"fillColor":"#FFCCCCFF"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL/321YY43_000F4QECK000003
Request
<ovalAnnotation>
    <location>
        <startPoint>
            <x>476</x>
            <y>691</y>
        </startPoint>
        <endPoint>
            <x>794</x>
            <y>803</y>
        </endPoint>
    </location>
    <penColor>#FF0000FF</penColor>
    <penWidth>3</penWidth>
    <fillColor>#FFCCCCFF</fillColor>
</ovalAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/OVAL/321YY43_000F4QECK000003?queueId=321YZ46_000QEJ5XJ000021
Request
<ovalAnnotation>
    <location>
        <startPoint>
            <x>476</x>
            <y>691</y>
        </startPoint>
        <endPoint>
            <x>794</x>
            <y>803</y>
        </endPoint>
    </location>
    <penColor>#FF0000FF</penColor>
    <penWidth>3</penWidth>
    <fillColor>#FFCCCCFF</fillColor>
</ovalAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/PEN Creates a pen annotation on a page

Expand Operation / Collapse Operation

Creates a pen annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content penAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

penAnnotation type

Represents a pen annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
path List of point [point] Yes The path of the pen annotation from a ollection of points
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width for the annotation
templateId String Yes The ID of the annotation template used to create this annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN
Request
{"filePageNumber":2,"templateId":"321YX5G_009819MAG050131","penColor":"#FF99CC00","penWidth":5,"path":[{"x":303,"y":740},{"x":312,"y":754},{"x":322,"y":763}]}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":2,"templateId":"321YX5G_009819MAG050131","penColor":"#FF99CC00","penWidth":5,"path":[{"x":303,"y":740},{"x":312,"y":754},{"x":322,"y":763}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN
Request
<penAnnotation>
    <filePageNumber>2</filePageNumber>
    <templateId>321YX5G_009819MAG050131</templateId>
    <path>
        <point>
            <x>303</x>
            <y>740</y>
        </point>
        <point>
            <x>312</x>
            <y>754</y>
        </point>
        <point>
            <x>322</x>
            <y>763</y>
        </point>
    </path>
    <penColor>#FF99CC00</penColor>
    <penWidth>5</penWidth>
</penAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN?queueId=321YZ46_000QEJ5XJ000021
Request
<penAnnotation>
    <filePageNumber>2</filePageNumber>
    <templateId>321YX5G_009819MAG050131</templateId>
    <path>
        <point>
            <x>303</x>
            <y>740</y>
        </point>
        <point>
            <x>312</x>
            <y>754</y>
        </point>
        <point>
            <x>322</x>
            <y>763</y>
        </point>
    </path>
    <penColor>#FF99CC00</penColor>
    <penWidth>5</penWidth>
</penAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/PEN/{annotationId} Updates a pen annotation on a page

Expand Operation / Collapse Operation

Updates a pen annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content penAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated pen annotation.

Call Types and Enumerations

penAnnotation type

Represents a pen annotation

Field Name Data Type Expected Description
path List of point [point] Yes The path of the pen annotation from a ollection of points
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN/321YY43_000F4BECJ00000G
Request
{"penColor":"#FF99CC00","penWidth":5,"path":[{"x":303,"y":740},{"x":312,"y":754},{"x":322,"y":763}]}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN/321YY43_000F4BECJ00000G?queueId=321YZ46_000QEJ5XJ000021
Request
{"penColor":"#FF99CC00","penWidth":5,"path":[{"x":303,"y":740},{"x":312,"y":754},{"x":322,"y":763}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN/321YY43_000F4BECJ00000G
Request
<penAnnotation>
    <path>
        <point>
            <x>303</x>
            <y>740</y>
        </point>
        <point>
            <x>312</x>
            <y>754</y>
        </point>
        <point>
            <x>322</x>
            <y>763</y>
        </point>
    </path>
    <penColor>#FF99CC00</penColor>
    <penWidth>5</penWidth>
</penAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PEN/321YY43_000F4BECJ00000G?queueId=321YZ46_000QEJ5XJ000021
Request
<penAnnotation>
    <path>
        <point>
            <x>303</x>
            <y>740</y>
        </point>
        <point>
            <x>312</x>
            <y>754</y>
        </point>
        <point>
            <x>322</x>
            <y>763</y>
        </point>
    </path>
    <penColor>#FF99CC00</penColor>
    <penWidth>5</penWidth>
</penAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP Creates a picture stamp annotation on a page

Expand Operation / Collapse Operation

Creates a picture stamp annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content pictureStampAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

pictureStampAnnotation type

Represents a picture stamp annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP
Request
{"filePageNumber":1,"templateId":"321YX3N_0002RXR9000000W","startLocation":{"startPoint":{"x":2122,"y":1086}}}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX3N_0002RXR9000000W","startLocation":{"startPoint":{"x":2122,"y":1086}}}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP
Request
<pictureStampAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX3N_0002RXR9000000W</templateId>
    <startLocation>
        <startPoint>
            <x>2122</x>
            <y>1086</y>
        </startPoint>
    </startLocation>
</pictureStampAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP?queueId=321YZ46_000QEJ5XJ000021
Request
<pictureStampAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX3N_0002RXR9000000W</templateId>
    <startLocation>
        <startPoint>
            <x>2122</x>
            <y>1086</y>
        </startPoint>
    </startLocation>
</pictureStampAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP/{annotationId} Updates a picture stamp annotation on a page

Expand Operation / Collapse Operation

Updates a picture stamp annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content pictureStampAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated picture stamp annotation.

Call Types and Enumerations

pictureStampAnnotation type

Represents a picture stamp annotation

Field Name Data Type Expected Description
startLocation startLocation Yes The location of the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/321YY43_000F4TECK000005
Request
{"startLocation":{"startPoint":{"x":2122,"y":1086}}}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/321YY43_000F4TECK000005?queueId=321YZ46_000QEJ5XJ000021
Request
{"startLocation":{"startPoint":{"x":2122,"y":1086}}}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/321YY43_000F4TECK000005
Request
<pictureStampAnnotation>
    <startLocation>
        <startPoint>
            <x>2122</x>
            <y>1086</y>
        </startPoint>
    </startLocation>
</pictureStampAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/321YY43_000F4TECK000005?queueId=321YZ46_000QEJ5XJ000021
Request
<pictureStampAnnotation>
    <startLocation>
        <startPoint>
            <x>2122</x>
            <y>1086</y>
        </startPoint>
    </startLocation>
</pictureStampAnnotation>

GET/v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP/{annotationId}/file Gets the file associated with an annotation stored in the Server.

Expand Operation / Collapse Operation

Gets the file associated with an annotation stored in the Server.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-Name The working name for the file of the document annotation.
X-IntegrationServer-Resource-Extension The extension type for the file of the document annotation.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file?queueId=321YZ46_000QEJ5XJ000021

HEAD/v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP/{annotationId}/file Gets the file info associated with an annotation stored in the Server.

Expand Operation / Collapse Operation

Gets the file info associated with an annotation stored in the Server.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Types
  • application/octet-stream
  • application/xml
  • application/json
Additional Headers
X-IntegrationServer-Resource-Name The working name for the file of the document annotation.
X-IntegrationServer-Resource-Extension The extension type for the file of the document annotation.
Content-Type Note: "application/xml" and "application/json" are deprecated and should no longer be specified as valid Accept types in the request.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/PICTURE_STAMP/301YVD7_0002ZL50K000023/file?queueId=321YZ46_000QEJ5XJ000021

POST/v1/document/{id}/page/{pageId}/annotation/RECTANGLE Creates a rectangle annotation on a page

Expand Operation / Collapse Operation

Creates a rectangle annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content rectangleAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
rectangleAnnotation type

Represents a rectangle annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
templateId String Yes The ID of the annotation template used to create this annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE
Request
{"filePageNumber":1,"templateId":"321YX18_000001Q8C00000N","location":{"startPoint":{"x":1256,"y":616},"endPoint":{"x":653,"y":456}},"penColor":"#FFFF0000","penWidth":2,"fillColor":"#FFFFFF00"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX18_000001Q8C00000N","location":{"startPoint":{"x":1256,"y":616},"endPoint":{"x":653,"y":456}},"penColor":"#FFFF0000","penWidth":2,"fillColor":"#FFFFFF00"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE
Request
<rectangleAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX18_000001Q8C00000N</templateId>
    <location>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
        <endPoint>
            <x>653</x>
            <y>456</y>
        </endPoint>
    </location>
    <penColor>#FFFF0000</penColor>
    <penWidth>2</penWidth>
    <fillColor>#FFFFFF00</fillColor>
</rectangleAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE?queueId=321YZ46_000QEJ5XJ000021
Request
<rectangleAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX18_000001Q8C00000N</templateId>
    <location>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
        <endPoint>
            <x>653</x>
            <y>456</y>
        </endPoint>
    </location>
    <penColor>#FFFF0000</penColor>
    <penWidth>2</penWidth>
    <fillColor>#FFFFFF00</fillColor>
</rectangleAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/RECTANGLE/{annotationId} Updates a rectangle annotation on a page

Expand Operation / Collapse Operation

Updates a rectangle annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content rectangleAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated rectangle annotation.

Call Types and Enumerations

location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
rectangleAnnotation type

Represents a rectangle annotation

Field Name Data Type Expected Description
fillColor String Yes The fill color of the annotation
location location Yes The location of the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE/321YY43_000F4JECJ00000F
Request
{"location":{"startPoint":{"x":1256,"y":616},"endPoint":{"x":653,"y":456}},"penColor":"#FFFF0000","penWidth":2,"fillColor":"#FFFFFF00"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE/321YY43_000F4JECJ00000F?queueId=321YZ46_000QEJ5XJ000021
Request
{"location":{"startPoint":{"x":1256,"y":616},"endPoint":{"x":653,"y":456}},"penColor":"#FFFF0000","penWidth":2,"fillColor":"#FFFFFF00"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE/321YY43_000F4JECJ00000F
Request
<rectangleAnnotation>
    <location>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
        <endPoint>
            <x>653</x>
            <y>456</y>
        </endPoint>
    </location>
    <penColor>#FFFF0000</penColor>
    <penWidth>2</penWidth>
    <fillColor>#FFFFFF00</fillColor>
</rectangleAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/RECTANGLE/321YY43_000F4JECJ00000F?queueId=321YZ46_000QEJ5XJ000021
Request
<rectangleAnnotation>
    <location>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
        <endPoint>
            <x>653</x>
            <y>456</y>
        </endPoint>
    </location>
    <penColor>#FFFF0000</penColor>
    <penWidth>2</penWidth>
    <fillColor>#FFFFFF00</fillColor>
</rectangleAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/STICKY_NOTE Creates a sticky note annotation on a page

Expand Operation / Collapse Operation

Creates a sticky note annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content stickyNoteAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

note type

Represents a note

Field Name Data Type Expected Description
content String Yes Content
date String Yes Date
userName String Yes User Name
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
stickyNoteAnnotation type

Represents an sticky note annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
notes List of note [note] Yes The list of individual notes added to a sticky note
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE
Request
{"filePageNumber":1,"templateId":"321YX18_000001Q8C00000R","startLocation":{"startPoint":{"x":78,"y":1108}},"notes":[{"userName":"jdoe","date":"4/3/2014","content":"Hello World!"}]}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX18_000001Q8C00000R","startLocation":{"startPoint":{"x":78,"y":1108}},"notes":[{"userName":"jdoe","date":"4/3/2014","content":"Hello World!"}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE
Request
<stickyNoteAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX18_000001Q8C00000R</templateId>
    <startLocation>
        <startPoint>
            <x>78</x>
            <y>1108</y>
        </startPoint>
    </startLocation>
    <notes>
        <note>
            <userName>jdoe</userName>
            <date>4/3/2014</date>
            <content>Hello World!</content>
        </note>
    </notes>
</stickyNoteAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE?queueId=321YZ46_000QEJ5XJ000021
Request
<stickyNoteAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX18_000001Q8C00000R</templateId>
    <startLocation>
        <startPoint>
            <x>78</x>
            <y>1108</y>
        </startPoint>
    </startLocation>
    <notes>
        <note>
            <userName>jdoe</userName>
            <date>4/3/2014</date>
            <content>Hello World!</content>
        </note>
    </notes>
</stickyNoteAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/STICKY_NOTE/{annotationId} Updates a sticky note annotation on a page

Expand Operation / Collapse Operation

Updates a sticky note annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content stickyNoteAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated sticky note annotation.

Call Types and Enumerations

note type

Represents a note

Field Name Data Type Expected Description
content String Yes Content
date String Yes Date
userName String Yes User Name
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
stickyNoteAnnotation type

Represents an sticky note annotation

Field Name Data Type Expected Description
notes List of note [note] Yes The list of individual notes added to a sticky note
startLocation startLocation Yes The location of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE/321YY43_000F51S4G000001
Request
{"startLocation":{"startPoint":{"x":78,"y":1108}},"notes":[{"userName":"jdoe","date":"4/3/2014","content":"Hello World!"}]}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE/321YY43_000F51S4G000001?queueId=321YZ46_000QEJ5XJ000021
Request
{"startLocation":{"startPoint":{"x":78,"y":1108}},"notes":[{"userName":"jdoe","date":"4/3/2014","content":"Hello World!"}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE/321YY43_000F51S4G000001
Request
<stickyNoteAnnotation>
    <startLocation>
        <startPoint>
            <x>78</x>
            <y>1108</y>
        </startPoint>
    </startLocation>
    <notes>
        <note>
            <userName>jdoe</userName>
            <date>4/3/2014</date>
            <content>Hello World!</content>
        </note>
    </notes>
</stickyNoteAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/STICKY_NOTE/321YY43_000F51S4G000001?queueId=321YZ46_000QEJ5XJ000021
Request
<stickyNoteAnnotation>
    <startLocation>
        <startPoint>
            <x>78</x>
            <y>1108</y>
        </startPoint>
    </startLocation>
    <notes>
        <note>
            <userName>jdoe</userName>
            <date>4/3/2014</date>
            <content>Hello World!</content>
        </note>
    </notes>
</stickyNoteAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/TEXT Creates a text annotation on a page

Expand Operation / Collapse Operation

Creates a text annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content textAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
textAnnotation type

Represents an text annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
textInformation textInformation Yes The text content of the annotation
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT
Request
{"filePageNumber":1,"templateId":"321YY1W_000DKBFM5000004","startLocation":{"startPoint":{"x":1256,"y":616}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text"}}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YY1W_000DKBFM5000004","startLocation":{"startPoint":{"x":1256,"y":616}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text"}}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT
Request
<textAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YY1W_000DKBFM5000004</templateId>
    <startLocation>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Times New Roman</face>
            <color>#FF0000FF</color>
            <height>14</height>
            <bold>true</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>My Text</text>
    </textInformation>
</textAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT?queueId=321YZ46_000QEJ5XJ000021
Request
<textAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YY1W_000DKBFM5000004</templateId>
    <startLocation>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Times New Roman</face>
            <color>#FF0000FF</color>
            <height>14</height>
            <bold>true</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>My Text</text>
    </textInformation>
</textAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/TEXT/{annotationId} Updates a text annotation on a page

Expand Operation / Collapse Operation

Updates a text annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content textAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated text annotation.

Call Types and Enumerations

font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
textAnnotation type

Represents an text annotation

Field Name Data Type Expected Description
startLocation startLocation Yes The location of the annotation
textInformation textInformation Yes The text content of the annotation
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT/321YY43_000F5KS4G000002
Request
{"startLocation":{"startPoint":{"x":1256,"y":616}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text"}}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT/321YY43_000F5KS4G000002?queueId=321YZ46_000QEJ5XJ000021
Request
{"startLocation":{"startPoint":{"x":1256,"y":616}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text"}}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT/321YY43_000F5KS4G000002
Request
<textAnnotation>
    <startLocation>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Times New Roman</face>
            <color>#FF0000FF</color>
            <height>14</height>
            <bold>true</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>My Text</text>
    </textInformation>
</textAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT/321YY43_000F5KS4G000002?queueId=321YZ46_000QEJ5XJ000021
Request
<textAnnotation>
    <startLocation>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Times New Roman</face>
            <color>#FF0000FF</color>
            <height>14</height>
            <bold>true</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>My Text</text>
    </textInformation>
</textAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/TEXT_STAMP Creates a text stamp annotation on a page

Expand Operation / Collapse Operation

Creates a text stamp annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content textStampAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
frame type

Represents the frame of an annotation

Field Name Data Type Expected Description
frameColor String Yes The frame color for the annotation
frameCornerRadius Integer Yes The frame corner radius for the annotation
frameMarginBottom Integer Yes The frame bottom margin for the annotation
frameMarginLeft Integer Yes The frame left margin for the annotation
frameMarginRight Integer Yes The frame right margin for the annotation
frameMarginTop Integer Yes The frame top margin for the annotation
frameStyle frameStyle Yes The frame style for the annotation
frameThickness Integer Yes The frame thickness for the annotation
frameStyle enumeration

The frame style of an annotation

Constant Name Description
NONE No frame style
RECTANGLE Rectangle frame style
ROUNDED_RECTANGLE Rounded rectangle frame style
ELLIPSE Ellipse frame style
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification
textStampAnnotation type

Represents an text stamp annotation

Field Name Data Type Expected Description
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
frame frame Yes Information about the frame of the annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
textInformation textInformation Yes The text content of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP
Request
{"filePageNumber":1,"templateId":"321YX18_000001Q8C00000Z","startLocation":{"startPoint":{"x":261,"y":91}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF0000FF","frameThickness":3,"frameCornerRadius":6,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF0000FF","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Approved"}}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX18_000001Q8C00000Z","startLocation":{"startPoint":{"x":261,"y":91}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF0000FF","frameThickness":3,"frameCornerRadius":6,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF0000FF","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Approved"}}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP
Request
<textStampAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX18_000001Q8C00000Z</templateId>
    <startLocation>
        <startPoint>
            <x>261</x>
            <y>91</y>
        </startPoint>
    </startLocation>
    <fillColor>#00000000</fillColor>
    <frame>
        <frameStyle>ROUNDED_RECTANGLE</frameStyle>
        <frameColor>#FF0000FF</frameColor>
        <frameThickness>3</frameThickness>
        <frameCornerRadius>6</frameCornerRadius>
        <frameMarginLeft>5</frameMarginLeft>
        <frameMarginRight>5</frameMarginRight>
        <frameMarginTop>0</frameMarginTop>
        <frameMarginBottom>0</frameMarginBottom>
    </frame>
    <textInformation>
        <font>
            <face>Stencil</face>
            <color>#FF0000FF</color>
            <height>20</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>Approved</text>
    </textInformation>
</textStampAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP?queueId=321YZ46_000QEJ5XJ000021
Request
<textStampAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX18_000001Q8C00000Z</templateId>
    <startLocation>
        <startPoint>
            <x>261</x>
            <y>91</y>
        </startPoint>
    </startLocation>
    <fillColor>#00000000</fillColor>
    <frame>
        <frameStyle>ROUNDED_RECTANGLE</frameStyle>
        <frameColor>#FF0000FF</frameColor>
        <frameThickness>3</frameThickness>
        <frameCornerRadius>6</frameCornerRadius>
        <frameMarginLeft>5</frameMarginLeft>
        <frameMarginRight>5</frameMarginRight>
        <frameMarginTop>0</frameMarginTop>
        <frameMarginBottom>0</frameMarginBottom>
    </frame>
    <textInformation>
        <font>
            <face>Stencil</face>
            <color>#FF0000FF</color>
            <height>20</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>Approved</text>
    </textInformation>
</textStampAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/TEXT_STAMP/{annotationId} Updates a text annotation on a page

Expand Operation / Collapse Operation

Updates a text annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content textStampAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated text annotation.

Call Types and Enumerations

font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
frame type

Represents the frame of an annotation

Field Name Data Type Expected Description
frameColor String Yes The frame color for the annotation
frameCornerRadius Integer Yes The frame corner radius for the annotation
frameMarginBottom Integer Yes The frame bottom margin for the annotation
frameMarginLeft Integer Yes The frame left margin for the annotation
frameMarginRight Integer Yes The frame right margin for the annotation
frameMarginTop Integer Yes The frame top margin for the annotation
frameStyle frameStyle Yes The frame style for the annotation
frameThickness Integer Yes The frame thickness for the annotation
frameStyle enumeration

The frame style of an annotation

Constant Name Description
NONE No frame style
RECTANGLE Rectangle frame style
ROUNDED_RECTANGLE Rounded rectangle frame style
ELLIPSE Ellipse frame style
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification
textStampAnnotation type

Represents an text stamp annotation

Field Name Data Type Expected Description
fillColor String Yes The fill color of the annotation
frame frame Yes Information about the frame of the annotation
startLocation startLocation Yes The location of the annotation
textInformation textInformation Yes The text content of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP/321YY43_000F5BS4G000002
Request
{"startLocation":{"startPoint":{"x":261,"y":91}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF0000FF","frameThickness":3,"frameCornerRadius":6,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF0000FF","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Approved"}}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP/321YY43_000F5BS4G000002?queueId=321YZ46_000QEJ5XJ000021
Request
{"startLocation":{"startPoint":{"x":261,"y":91}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF0000FF","frameThickness":3,"frameCornerRadius":6,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF0000FF","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Approved"}}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP/321YY43_000F5BS4G000002
Request
<textStampAnnotation>
    <startLocation>
        <startPoint>
            <x>261</x>
            <y>91</y>
        </startPoint>
    </startLocation>
    <fillColor>#00000000</fillColor>
    <frame>
        <frameStyle>ROUNDED_RECTANGLE</frameStyle>
        <frameColor>#FF0000FF</frameColor>
        <frameThickness>3</frameThickness>
        <frameCornerRadius>6</frameCornerRadius>
        <frameMarginLeft>5</frameMarginLeft>
        <frameMarginRight>5</frameMarginRight>
        <frameMarginTop>0</frameMarginTop>
        <frameMarginBottom>0</frameMarginBottom>
    </frame>
    <textInformation>
        <font>
            <face>Stencil</face>
            <color>#FF0000FF</color>
            <height>20</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>Approved</text>
    </textInformation>
</textStampAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/TEXT_STAMP/321YY43_000F5BS4G000002?queueId=321YZ46_000QEJ5XJ000021
Request
<textStampAnnotation>
    <startLocation>
        <startPoint>
            <x>261</x>
            <y>91</y>
        </startPoint>
    </startLocation>
    <fillColor>#00000000</fillColor>
    <frame>
        <frameStyle>ROUNDED_RECTANGLE</frameStyle>
        <frameColor>#FF0000FF</frameColor>
        <frameThickness>3</frameThickness>
        <frameCornerRadius>6</frameCornerRadius>
        <frameMarginLeft>5</frameMarginLeft>
        <frameMarginRight>5</frameMarginRight>
        <frameMarginTop>0</frameMarginTop>
        <frameMarginBottom>0</frameMarginBottom>
    </frame>
    <textInformation>
        <font>
            <face>Stencil</face>
            <color>#FF0000FF</color>
            <height>20</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_CENTER</justify>
        <text>Approved</text>
    </textInformation>
</textStampAnnotation>

POST/v1/document/{id}/page/{pageId}/annotation/URL Creates a URL annotation on a page

Expand Operation / Collapse Operation

Creates a URL annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content urlAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated check annotation.

Call Types and Enumerations

font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
privileges type

Represents privilege information about an annotation

Field Name Data Type Expected Description
canDelete boolean Yes Flag to determine if the annotation can be deleted
canHide boolean Yes Flag to determine if the annotation can be hidden
canModify boolean Yes Flag to determine if the annotation can be modified
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification
urlAnnotation type

Represents a URL annotation

Field Name Data Type Expected Description
actionURL String Yes The action url of the annotation
filePageNumber Integer Yes The file page number for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateId String Yes The ID of the annotation template used to create this annotation
textInformation textInformation Yes The text content of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL
Request
{"filePageNumber":1,"templateId":"321YX7C_0006M43PS00001J","privileges":null,"startLocation":{"startPoint":{"x":1634,"y":1633}},"textInformation":{"font":{"face":"Arial","color":"#FFFF6600","height":16,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL?queueId=321YZ46_000QEJ5XJ000021
Request
{"filePageNumber":1,"templateId":"321YX7C_0006M43PS00001J","privileges":null,"startLocation":{"startPoint":{"x":1634,"y":1633}},"textInformation":{"font":{"face":"Arial","color":"#FFFF6600","height":16,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL
Request
<urlAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX7C_0006M43PS00001J</templateId>
    <startLocation>
        <startPoint>
            <x>1634</x>
            <y>1633</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Arial</face>
            <color>#FFFF6600</color>
            <height>16</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>true</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_LEFT</justify>
        <text>Perceptive Software</text>
    </textInformation>
    <actionURL>http://www.perceptivesoftware.com</actionURL>
</urlAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL?queueId=321YZ46_000QEJ5XJ000021
Request
<urlAnnotation>
    <filePageNumber>1</filePageNumber>
    <templateId>321YX7C_0006M43PS00001J</templateId>
    <startLocation>
        <startPoint>
            <x>1634</x>
            <y>1633</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Arial</face>
            <color>#FFFF6600</color>
            <height>16</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>true</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_LEFT</justify>
        <text>Perceptive Software</text>
    </textInformation>
    <actionURL>http://www.perceptivesoftware.com</actionURL>
</urlAnnotation>

PUT/v1/document/{id}/page/{pageId}/annotation/URL/{annotationId} Updates a URL annotation on a page

Expand Operation / Collapse Operation

Updates a URL annotation on a page

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content urlAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated url annotation.

Call Types and Enumerations

font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification
urlAnnotation type

Represents a URL annotation

Field Name Data Type Expected Description
actionURL String Yes The action url of the annotation
startLocation startLocation Yes The location of the annotation
textInformation textInformation Yes The text content of the annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL/321YY43_000F50S4G000006
Request
{"startLocation":{"startPoint":{"x":1634,"y":1633}},"textInformation":{"font":{"face":"Arial","color":"#FFFF6600","height":16,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL/321YY43_000F50S4G000006?queueId=321YZ46_000QEJ5XJ000021
Request
{"startLocation":{"startPoint":{"x":1634,"y":1633}},"textInformation":{"font":{"face":"Arial","color":"#FFFF6600","height":16,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL/321YY43_000F50S4G000006
Request
<urlAnnotation>
    <startLocation>
        <startPoint>
            <x>1634</x>
            <y>1633</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Arial</face>
            <color>#FFFF6600</color>
            <height>16</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>true</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_LEFT</justify>
        <text>Perceptive Software</text>
    </textInformation>
    <actionURL>http://www.perceptivesoftware.com</actionURL>
</urlAnnotation>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/URL/321YY43_000F50S4G000006?queueId=321YZ46_000QEJ5XJ000021
Request
<urlAnnotation>
    <startLocation>
        <startPoint>
            <x>1634</x>
            <y>1633</y>
        </startPoint>
    </startLocation>
    <textInformation>
        <font>
            <face>Arial</face>
            <color>#FFFF6600</color>
            <height>16</height>
            <bold>false</bold>
            <italic>false</italic>
            <underline>true</underline>
            <strikeout>false</strikeout>
        </font>
        <justify>JUSTIFY_LEFT</justify>
        <text>Perceptive Software</text>
    </textInformation>
    <actionURL>http://www.perceptivesoftware.com</actionURL>
</urlAnnotation>

DELETE/v1/document/{id}/page/{pageId}/annotation/{type}/{annotationId} Deletes an annotation from a page

Expand Operation / Collapse Operation

Deletes an annotation from a page

Available from version: 1.0.0

Call Properties

Path Parameters
type annotationType The annotation type to delete
annotationId The annotation on the document page to delete.
Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

annotationType enumeration

Represents an annotation type

Constant Name Description
ARROW An arrow annotation
CHECK A check annotation
HIGHLIGHT A highlight annotation
LINE A line annotation
RECTANGLE A rectangle annotation
OVAL An oval annotation
PEN A pen annotation
TEXT_STAMP A text stamp annotation
PICTURE_STAMP A picture stamp annotation
TEXT A text annotation
STICKY_NOTE A sticky note annotation
URL A URL annotation

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051?queueId=321YZ46_000QEJ5XJ000021

GET/v1/document/{id}/page/{pageId}/conversion/{outputType} Converts a page to a PDF, TIFF, or PNG format. To use this call, File Conversion Service is requi...

Expand Operation / Collapse Operation

Converts a page to a PDF, TIFF, or PNG format. To use this call, File Conversion Service is required.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document you want to render
outputType outputType The file type to be converted to
Query Parameters
pageNumber (optional) The page within the file you want to render. To convert all of the pages of the file, insert 0.
height (optional) The height of PNG or TIFF
width (optional) The width of PNG or TIFF
dither (optional) Flag for dithering when converting to TIFF
compression compression (optional) The type of TIFF compression
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Available-Pages Number of available pages for a mulitple page conversion
X-IntegrationServer-Original-Orientation Orientation of the page source
X-IntegrationServer-Original-Height Height of the page source
X-IntegrationServer-Original-Width Width of the page source
X-IntegrationServer-Original-X-DPI X DPI of the page source
X-IntegrationServer-Original-Y-DPI Y DPI of the page source
X-IntegrationServer-Content-Is-Conversion Page was successfully rendered
X-IntegrationServer-Original-File-Type File type of the page source
X-IntegrationServer-Original-File-Size File size of the page source

Call Types and Enumerations

compression enumeration

The type of TIFF compression.

Constant Name Description
PACKED Use PACKED compression.
JPEG Use JPEG compression.
LZW Use LZW compression.
GROUP3 Use GROUP3 compression.
GROUP4 Use GROUP4 compression.
GROUP5 Use GROUP5 compression.
GROUP6 Use GROUP6 compression.
NONE Don't use compression.
outputType enumeration

The file type that the page will be converted to.

Constant Name Description
PDF Use PDF output type.
PNG Use PNG output type.
TIFF Use TIFF output type.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/conversion/TIFF?width=600&height=600&pageNumber=1&dither=true&compression=LZW
Sample 2
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/conversion/PDF?pageNumber=0

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/conversion/TIFF?width=600&height=600&pageNumber=1&dither=true&compression=LZW
Sample 2
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/conversion/PDF?pageNumber=0

GET/v1/document/{id}/page/{pageId}/file Gets the file associated with a page stored in the Server.

Expand Operation / Collapse Operation

Gets the file associated with a page stored in the Server.

Available from version: 1.0.0

Call Properties

Query Parameters
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
contentDisposition outputType (optional) Allows requestor to specify the Content-Disposition returned by the server.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
Content-Disposition Standard Content-Disposition header, returned when including the contentDisposition query parameter.

Call Types and Enumerations

outputType enumeration

The Content-Disposition returned from the server.

Constant Name Description
INLINE Use inline Content-Disposition.
ATTACHMENT Use attachment Content-Disposition.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

HEAD/v1/document/{id}/page/{pageId}/file Gets the file info associated with a page stored in the Server, including the ID and content-length.

Expand Operation / Collapse Operation

Gets the file info associated with a page stored in the Server, including the ID and content-length.

Available from version: 1.0.0

Call Properties

Query Parameters
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
contentDisposition outputType (optional) Allows requestor to specify the Content-Disposition returned by the server.
Response
Content
Binary
Content-Types
  • application/octet-stream
  • application/xml
  • application/json
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
Content-Type Note: "application/xml" and "application/json" are deprecated and should no longer be specified as valid Accept types in the request.
Content-Disposition Standard Content-Disposition header, returned when including the contentDisposition query parameter.

Call Types and Enumerations

outputType enumeration

The Content-Disposition returned from the server.

Constant Name Description
INLINE Use inline Content-Disposition.
ATTACHMENT Use attachment Content-Disposition.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

PUT/v1/document/{id}/page/{pageId}/file Replaces a page in a document stored in the Server.

Expand Operation / Collapse Operation

Replaces a page in a document stored in the Server.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page to replace.
Request
Content Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-Name The name to associate with the page.
X-IntegrationServer-File-Size The number of bytes in the file.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file

XML Samples

Sample 1
Request URL
/v1/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file

GET/v1/document/{id}/page/{pageId}/preview Gets the preview file associated with a page stored in the Server.

Expand Operation / Collapse Operation

Gets the preview file associated with a page stored in the Server.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to preview.
Query Parameters
maxHeight (optional) The maximum height for the preview image.
maxWidth (optional) The maximum width for the preview image.
pageNumber (optional) The sub-page number to preview.
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
X-IntegrationServer-Available-Pages The total number of sub-pages that exist for the given page.
X-IntegrationServer-Content-Is-Preview True if the response body contains a preview, false if the body contains the original image.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

HEAD/v1/document/{id}/page/{pageId}/preview Gets the preview file info associated with a page stored in the Server.

Expand Operation / Collapse Operation

Gets the preview file info associated with a page stored in the Server.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to preview.
Query Parameters
maxHeight (optional) The maximum height for the preview image.
maxWidth (optional) The maximum width for the preview image.
pageNumber (optional) The sub-page number to preview.
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Types
  • application/octet-stream
  • application/xml
  • application/json
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
X-IntegrationServer-Available-Pages The total number of sub-pages that exist for the given page.
X-IntegrationServer-Content-Is-Preview True if the response body contains a preview, false if the body contains the original image.
Content-Type Note: "application/xml" and "application/json" are deprecated and should no longer be specified as valid Accept types in the request.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

GET/v1/document/{id}/page/{pageId}/rendition Retrieves a .png rendition of the page specified by pageId from the document specified by id. To ...

Expand Operation / Collapse Operation

Retrieves a .png rendition of the page specified by pageId from the document specified by id. To use this call, File Conversion Service is required.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document you want to render
Query Parameters
maxWidth (optional) The maximum width (in pixels) of the rendered page
maxHeight (optional) The maximum height (in pixels) of the rendered page
pageNumber (optional) Page number to retrieve from within a multi-page TIFF
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Available-Pages Number of available pages for a mulitple page rendition
X-IntegrationServer-Original-Orientation Orientation of the page source
X-IntegrationServer-Original-Height Height of the page source
X-IntegrationServer-Original-Width Width of the page source
X-IntegrationServer-Original-X-DPI X DPI of the page source
X-IntegrationServer-Original-Y-DPI Y DPI of the page source
X-IntegrationServer-Rendition-Height Height of the page rendition
X-IntegrationServer-Rendition-Width Width of the page rendition
X-IntegrationServer-Content-Is-Rendition Page was successfully rendered
X-IntegrationServer-Original-File-Type File type of the page source
X-IntegrationServer-Original-File-Size File size of the page source

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?maxWidth=600&maxHeight=600&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?maxWidth=600&maxHeight=600&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?maxWidth=600&maxHeight=600&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?maxWidth=600&maxHeight=600&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

GET/v1/document/{id}/page/{pageId}/retrievalProperties Retrieves the properties necessary to access an object directly from the storage solution.

Expand Operation / Collapse Operation

Retrieves the properties necessary to access an object directly from the storage solution.

Available from version: 1.0.0

Call Properties

Path Parameters
id The ID of the document to which the page belongs.
pageId The ID of the page to retrieve the properties for.
Query Parameter
workflowQueueId (optional) Required when called from a workflow context. The ID of the workflow queue to which the document belongs.
Response
Content
objectRetrievalProperties
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
objectRetrievalProperties type

Access properties to directly retrieve an object.

Field Name Data Type Expected Description
lstRetrievalProperties List of keyValuePair [retrievalProperty] Yes A list of object retrieval properties. These can be used to directly access the object.
providerId String Yes The ID of the property provider that is uniquely mapped to a plugin implementation.
schemaVersion String Yes The provider's implementation of the properties provided. Semantic version (ex. 2.1.0).

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_00078ZZD41200D3/page/301YW1J_000782VD90000BC/retrievalProperties
Response
{"providerId":"d4791893-993b-4cff-94fc-437c14fa1672","schemaVersion":"1.2.0","lstRetrievalProperties":[{"key":"ObjectEndpoint","value":"http://srv.example.net/accuo/301TYKJ3XIOOE"},{"key":"SessionEndpoint","value":"http://srv.example.net/session"}]}
Sample 2
Request URL
/v1/document/301YW1J_00078ZZD41200D3/page/301YW1J_000782VD90000BC/retrievalProperties?workflowQueueId=301YW1J_000682VD90000AI
Response
{"providerId":"d4791893-993b-4cff-94fc-437c14fa1672","schemaVersion":"1.2.0","lstRetrievalProperties":[{"key":"ObjectEndpoint","value":"http://srv.example.net/accuo/201TYYL3QIOOA"},{"key":"SessionEndpoint","value":"http://srv.example.net/session"}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_00078ZZD41200D3/page/301YW1J_000782VD90000BC/retrievalProperties
Response
<objectRetrievalProperties>
    <providerId>d4791893-993b-4cff-94fc-437c14fa1672</providerId>
    <schemaVersion>1.2.0</schemaVersion>
    <lstRetrievalProperties>
        <retrievalProperty>
            <key>ObjectEndpoint</key>
            <value>http://srv.example.net/accuo/301TYKJ3XIOOE</value>
        </retrievalProperty>
        <retrievalProperty>
            <key>SessionEndpoint</key>
            <value>http://srv.example.net/session</value>
        </retrievalProperty>
    </lstRetrievalProperties>
</objectRetrievalProperties>
Sample 2
Request URL
/v1/document/301YW1J_00078ZZD41200D3/page/301YW1J_000782VD90000BC/retrievalProperties?workflowQueueId=301YW1J_000682VD90000AI
Response
<objectRetrievalProperties>
    <providerId>d4791893-993b-4cff-94fc-437c14fa1672</providerId>
    <schemaVersion>1.2.0</schemaVersion>
    <lstRetrievalProperties>
        <retrievalProperty>
            <key>ObjectEndpoint</key>
            <value>http://srv.example.net/accuo/201TYYL3QIOOA</value>
        </retrievalProperty>
        <retrievalProperty>
            <key>SessionEndpoint</key>
            <value>http://srv.example.net/session</value>
        </retrievalProperty>
    </lstRetrievalProperties>
</objectRetrievalProperties>

GET/v1/document/{id}/page/{pageId}/thumbnail Gets the thumbnail file associated with a page stored in the Server.

Expand Operation / Collapse Operation

Gets the thumbnail file associated with a page stored in the Server.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to preview.
Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail?queueId=321YZ46_000QEJ5XJ000021

HEAD/v1/document/{id}/page/{pageId}/thumbnail Gets the thumbnail info associated with a page stored in the Server.

Expand Operation / Collapse Operation

Gets the thumbnail info associated with a page stored in the Server.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to preview.
Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Types
  • application/octet-stream
  • application/xml
  • application/json
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
Content-Type Note: "application/xml" and "application/json" are deprecated and should no longer be specified as valid Accept types in the request.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail?queueId=321YZ46_000QEJ5XJ000021

GET/v1/document/{id}/path Gets the document path stored in the Server that matches the ID.

Expand Operation / Collapse Operation

Gets the document path stored in the Server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
path
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.

JSON Samples

Sample 1 - A document named 'FY2017' in nested folders
Request URL
/v1/document/301YVDD_00005MTV200000H/path
Response
{"pathSegments":["Budgets","Human Resources","FY2017"]}
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/path?queueId=321YZ46_000QEJ5XJ000021
Response
{"pathSegments":["Budgets","Human Resources","FY2017"]}
Sample 3 - When a document is in a drawer
Request URL
/v1/document/301YVDD_00005MTV200000H/path
Response
{"pathSegments":["Default","301YVDD_00005MTV200000H"]}

XML Samples

Sample 1 - A document named 'FY2017' in nested folders
Request URL
/v1/document/301YVDD_00005MTV200000H/path
Response
<path>
    <pathSegments>
        <pathSegment>Budgets</pathSegment>
        <pathSegment>Human Resources</pathSegment>
        <pathSegment>FY2017</pathSegment>
    </pathSegments>
</path>
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1E_00077ZVD900003H/path?queueId=321YZ46_000QEJ5XJ000021
Response
<path>
    <pathSegments>
        <pathSegment>Budgets</pathSegment>
        <pathSegment>Human Resources</pathSegment>
        <pathSegment>FY2017</pathSegment>
    </pathSegments>
</path>
Sample 3 - When a document is in a drawer
Request URL
/v1/document/301YVDD_00005MTV200000H/path
Response
<path>
    <pathSegments>
        <pathSegment>Default</pathSegment>
        <pathSegment>301YVDD_00005MTV200000H</pathSegment>
    </pathSegments>
</path>

POST/v1/document/{id}/referenceObject Attaches an external reference object as a page to a document.

Expand Operation / Collapse Operation

Attaches an external reference object as a page to a document.

Available from version: 1.0.0

Call Properties

Request
Content attachReferenceObject
Content-Types
  • application/xml
  • application/json
Response
Content
attachedReferenceObject
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

attachedReferenceObject type

Represents a successfully attached content reference object.

Field Name Data Type Expected Description
logobId String Yes The logical object id of the attached object.
attachReferenceObject type

Attaches an external reference object as a page to a document.

Field Name Data Type Expected Description
externalObjectUid String Yes The uid of the attached object. Can be used for object retrieval from a reference set.
performValidation Boolean No Perform validation when attaching the object. Defaults to false if not provided.
referenceObjectProperties referenceObjectProperties Yes Additional information about the reference object being attached.
targetSetId String Yes The id of the reference set that can be used to retrieve the attached object.
referenceObjectProperties type

Additional information about the reference object being attached.

Field Name Data Type Expected Description
fileType String Yes The file type of the object.
workingName String Yes The filename of the object.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_00078ZZD41200D3/referenceObject
Request
{"targetSetId":"321YZ4F_00000VK49000004","externalObjectUid":"7bcf621c-6cbd-4da1-a5fb-7b1007037876","performValidation":true,"referenceObjectProperties":{"fileType":"tif","workingName":"Demo 01.tif"}}
Response
{"logobId":"401YW1J_000DDZAD4000083"}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_00078ZZD41200D3/referenceObject
Request
<attachReferenceObject>
    <targetSetId>321YZ4F_00000VK49000004</targetSetId>
    <externalObjectUid>7bcf621c-6cbd-4da1-a5fb-7b1007037876</externalObjectUid>
    <performValidation>true</performValidation>
    <referenceObjectProperties>
        <fileType>tif</fileType>
        <workingName>Demo 01.tif</workingName>
    </referenceObjectProperties>
</attachReferenceObject>
Response
<attachedReferenceObject>
    <logobId>401YW1J_000DDZAD4000083</logobId>
</attachedReferenceObject>

GET/v1/document/{id}/sendToShareBase Uploads the document specified by the ID to ShareBase and returns a URL for sharing a link to the...

Expand Operation / Collapse Operation

Uploads the document specified by the ID to ShareBase and returns a URL for sharing a link to the document.

Available from version: 6.3.0

Call Properties

Query Parameters
versionNumber (optional) Version of the document.
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in.
Response
Content
sendToShareBaseResponse
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

sendToShareBaseResponse type

Response from sendToShareBase request.

Field Name Data Type Expected Description
shareWebUri String Yes The URI necessary to access a ShareBase web view.

JSON Samples

Sample 1 - Send a document to ShareBase.
Request URL
/v1/document/301YVD9_000303045000002/sendToShareBase
Response
{"shareWebUri":"https://app.sharebase.com/#/shaas/shares/42/configure?access=3947961e0aadb4201cdb86b3e1abe729"}

XML Samples

Sample 1 - Send a document to ShareBase.
Request URL
/v1/document/301YVD9_000303045000002/sendToShareBase
Response
<sendToShareBaseResponse>
    <shareWebUri>https://app.sharebase.com/#/shaas/shares/42/configure?access=3947961e0aadb4201cdb86b3e1abe729</shareWebUri>
</sendToShareBaseResponse>

GET/v1/document/{id}/thumbnail Gets the thumbnail file associated with a document stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets the thumbnail file associated with a document stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the document thumbnail.
X-IntegrationServer-Resource-Name The name of the document thumbnail.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail?queueId=321YZ46_000QEJ5XJ000021

HEAD/v1/document/{id}/thumbnail Gets the thumbnail info associated with a document stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets the thumbnail info associated with a document stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Types
  • application/octet-stream
  • application/xml
  • application/json
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the document thumbnail.
X-IntegrationServer-Resource-Name The name of the document thumbnail.
Content-Type Note: "application/xml" and "application/json" are deprecated and should no longer be specified as valid Accept types in the request.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail
Sample 2 - queueId parameter included
Request URL
/v1/document/301YW1J_000782VD90000B8/thumbnail?queueId=321YZ46_000QEJ5XJ000021

POST/v1/document/{id}/usernotification Creates a notification that sends a document to a user.

Expand Operation / Collapse Operation

Creates a notification that sends a document to a user.

Available from version: 1.0.0

Call Properties

Request
Content userNotification
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

userNotification type

This object represents a notification for sending a document to a user.

Field Name Data Type Expected Description
notes String No Optional notes displayed to the user when the message is received.
usernames List of String [username] Yes The list of usernames that should be notified.
version Integer Yes The version number of the document to send.
viewer viewer No The viewer used to display the document. The default is DOCUMENT. See the viewer enumeration for other options.
viewer enumeration

The viewer that will be used to open the document.

Constant Name Description
DOCUMENT The document viewer.
WORKFLOW The workflow viewer.

JSON Samples

Sample 1 - Send a document to a user that will open with the document viewer.
Request URL
/v1/document/301YW1J_000782VD90000B8/usernotification
Request
{"version":1,"notes":"Please approve this document.","viewer":"DOCUMENT","usernames":["bsmith"]}
Sample 2 - Send a document to multiple users that will open with the workflow viewer.
Request URL
/v1/document/301YW1J_000782VD90000B8/usernotification
Request
{"version":1,"notes":"Please review this document.","viewer":"WORKFLOW","usernames":["bsmith","jdoe"]}

XML Samples

Sample 1 - Send a document to a user that will open with the document viewer.
Request URL
/v1/document/301YW1J_000782VD90000B8/usernotification
Request
<userNotification>
    <version>1</version>
    <notes>Please approve this document.</notes>
    <viewer>DOCUMENT</viewer>
    <usernames>
        <username>bsmith</username>
    </usernames>
</userNotification>
Sample 2 - Send a document to multiple users that will open with the workflow viewer.
Request URL
/v1/document/301YW1J_000782VD90000B8/usernotification
Request
<userNotification>
    <version>1</version>
    <notes>Please review this document.</notes>
    <viewer>WORKFLOW</viewer>
    <usernames>
        <username>bsmith</username>
        <username>jdoe</username>
    </usernames>
</userNotification>

GET/v1/document/{id}/verification Verify the document's phsobs for correctness.

Expand Operation / Collapse Operation

Verify the document's phsobs for correctness.

Available from version: 1.0.0

Call Properties

Query Parameter
version (optional) Version number of the document. Default to -1 to return current version.
Response
Content
verificationResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

logob type

Contains logob information.

Field Name Data Type Expected Description
id String Yes Id of the Logical Object
logobType logobType Yes Type of the Logical Object
seqNum Integer Yes Sequence number
logobIntegrationType enumeration

Represents integration type of Logob

Constant Name Description
FSS FSS integration type
CAS CAS integration type
logobType enumeration

Represents type of Logob

Constant Name Description
DEFAULT Default Logical Object type
logobVerifyState enumeration

Represents state of Logob

Constant Name Description
PRESUMED_VALID Presumed valid
VALID Valid Phsob
MISSING Phsob missing
ALTERED Phsob altered
phsob type

Contains physical object information.

Field Name Data Type Expected Description
clipId String Yes Clip Id
fileType String Yes File type by extension
id String Yes Id of Phyiscal object
osmTreeId String Yes OSM tree Id
path String Yes OSM Path
state logobVerifyState Yes Verification state
type logobIntegrationType Yes OSM Integration type
verifyTime String Yes Time of validation
workingName String Yes Name of the file when it was captured
verificationResult type

Failed Document information

Field Name Data Type Expected Description
logob logob Yes Failed Logical Object information
phsob phsob Yes Failed Physical Object information
verificationResults type

Contains list of Logical Objects that failed verifcation.

Field Name Data Type Expected Description
verificationResults List of verificationResult [verificationResult] Yes The collection of failed Pages

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/verification
Response
{"verificationResults":[{"logob":{"id":"301YV3Q_000069LGZ00009L","seqNum":1,"logobType":"DEFAULT"},"phsob":{"id":"301YV3Q_000069LGZ00009M","fileType":"tif","workingName":"Demo 03.tif","type":"FSS","state":"MISSING","osmTreeId":"osm_01.00001","path":"00000000/00000000/00000051","clipId":null,"verifyTime":"2014-04-30T13:16:08Z"}},{"logob":{"id":"301YV3Q_000069LGZ00009R","seqNum":2,"logobType":"DEFAULT"},"phsob":{"id":"321YY1R_000STQHQ9000038","fileType":"tif","workingName":"Demo 01.tif","type":"CAS","state":"ALTERED","osmTreeId":"osm_90.00001","path":null,"clipId":"6VPCHB4F4KHTKe66UG30PP2T9FOG418ES7STFP0586CO9EKF8EAG2","verifyTime":"2014-04-30T13:16:08Z"}}]}
Sample 2
Request URL
/v1/document/301YW1J_000782VD90000B8/verification?version=100
Response
{"verificationResults":[{"logob":{"id":"301YV3Q_000069LGZ00009L","seqNum":1,"logobType":"DEFAULT"},"phsob":{"id":"301YV3Q_000069LGZ00009M","fileType":"tif","workingName":"Demo 03.tif","type":"FSS","state":"MISSING","osmTreeId":"osm_01.00001","path":"00000000/00000000/00000051","clipId":null,"verifyTime":"2014-04-30T13:16:08Z"}},{"logob":{"id":"301YV3Q_000069LGZ00009R","seqNum":2,"logobType":"DEFAULT"},"phsob":{"id":"321YY1R_000STQHQ9000038","fileType":"tif","workingName":"Demo 01.tif","type":"CAS","state":"ALTERED","osmTreeId":"osm_90.00001","path":null,"clipId":"6VPCHB4F4KHTKe66UG30PP2T9FOG418ES7STFP0586CO9EKF8EAG2","verifyTime":"2014-04-30T13:16:08Z"}}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/verification
Response
<verificationResults>
    <verificationResults>
        <verificationResult>
            <logob>
                <id>301YV3Q_000069LGZ00009L</id>
                <seqNum>1</seqNum>
                <logobType>DEFAULT</logobType>
            </logob>
            <phsob>
                <id>301YV3Q_000069LGZ00009M</id>
                <fileType>tif</fileType>
                <workingName>Demo 03.tif</workingName>
                <type>FSS</type>
                <state>MISSING</state>
                <osmTreeId>osm_01.00001</osmTreeId>
                <path>00000000/00000000/00000051</path>
                <verifyTime>2014-04-30T13:16:08Z</verifyTime>
            </phsob>
        </verificationResult>
        <verificationResult>
            <logob>
                <id>301YV3Q_000069LGZ00009R</id>
                <seqNum>2</seqNum>
                <logobType>DEFAULT</logobType>
            </logob>
            <phsob>
                <id>321YY1R_000STQHQ9000038</id>
                <fileType>tif</fileType>
                <workingName>Demo 01.tif</workingName>
                <type>CAS</type>
                <state>ALTERED</state>
                <osmTreeId>osm_90.00001</osmTreeId>
                <clipId>6VPCHB4F4KHTKe66UG30PP2T9FOG418ES7STFP0586CO9EKF8EAG2</clipId>
                <verifyTime>2014-04-30T13:16:08Z</verifyTime>
            </phsob>
        </verificationResult>
    </verificationResults>
</verificationResults>
Sample 2
Request URL
/v1/document/301YW1J_000782VD90000B8/verification?version=100
Response
<verificationResults>
    <verificationResults>
        <verificationResult>
            <logob>
                <id>301YV3Q_000069LGZ00009L</id>
                <seqNum>1</seqNum>
                <logobType>DEFAULT</logobType>
            </logob>
            <phsob>
                <id>301YV3Q_000069LGZ00009M</id>
                <fileType>tif</fileType>
                <workingName>Demo 03.tif</workingName>
                <type>FSS</type>
                <state>MISSING</state>
                <osmTreeId>osm_01.00001</osmTreeId>
                <path>00000000/00000000/00000051</path>
                <verifyTime>2014-04-30T13:16:08Z</verifyTime>
            </phsob>
        </verificationResult>
        <verificationResult>
            <logob>
                <id>301YV3Q_000069LGZ00009R</id>
                <seqNum>2</seqNum>
                <logobType>DEFAULT</logobType>
            </logob>
            <phsob>
                <id>321YY1R_000STQHQ9000038</id>
                <fileType>tif</fileType>
                <workingName>Demo 01.tif</workingName>
                <type>CAS</type>
                <state>ALTERED</state>
                <osmTreeId>osm_90.00001</osmTreeId>
                <clipId>6VPCHB4F4KHTKe66UG30PP2T9FOG418ES7STFP0586CO9EKF8EAG2</clipId>
                <verifyTime>2014-04-30T13:16:08Z</verifyTime>
            </phsob>
        </verificationResult>
    </verificationResults>
</verificationResults>

GET/v1/document/{id}/version Retrieves the version history for the given document.

Expand Operation / Collapse Operation

Retrieves the version history for the given document.

Available from version: 1.0.0

Call Properties

Path Parameter
id id of the document to retrieve the version history for.
Response
Content
List of version [version]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkinInfo type

Contains version checkin information.

Field Name Data Type Expected Description
notes String Yes The notes for the version check in
time Long Yes The time the version was checked in
userId String Yes The ID of the user who checked in the version
userName String Yes The name of the user who checked in the version
creationInfo type

Contains information about who added the document to version control and when.

Field Name Data Type Expected Description
time Long Yes The time the document was added to version control
userId String Yes The id fo the user who added the document to version control
userName String Yes The name for the user who added the document to version control
privateUserInfo type

Contains private user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who owns the private version
userName String Yes The name of the user who owns the private version
signatureStatus enumeration

Status of the digital signature

Constant Name Description
PREVIOUSLY_SIGNED The version was previously signed.
NOT_SIGNED The version is unsigned.
SIGNATURE_INVALID The digital signature is invalid.
SIGNATURE_VALID The digital signature is valid.
SIGNATURE_VOID The digital signature is void.
version type

Contains version information.

Field Name Data Type Expected Description
checkinInfo checkinInfo Yes The user who checked in the version, the time the version was checked in, and any notes associated with that version.
creationInfo creationInfo Yes The user who added the document to version control and the time it was added.
isPrivate boolean Yes Whether or not the version is private
pageCount Integer Yes The number of pages in the document
privateUserInfo privateUserInfo Yes The user who owns the private version
signatureStatus signatureStatus Yes The status of the digital signature
versionId String Yes The version's ID
versionNumber Integer Yes The version number

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/version
Response
{"versionHistory":[{"versionId":"321YYC6_0001VD3FH000007","versionNumber":1,"pageCount":1,"creationInfo":{"userId":"321YYCL_0003BW63N000001","userName":"gbuckland","time":1391793376460},"checkinInfo":{"userId":"321YYC6_0001X0SB4000005","userName":"jdoe","time":1391793376460,"notes":"First version of document"},"isPrivate":false,"privateUserInfo":{"userId":null,"userName":null},"signatureStatus":"SIGNATURE_VALID"},{"versionId":"321YYC6_00021GWXS000001","versionNumber":2,"pageCount":1,"creationInfo":{"userId":"321YYCL_0003BW63N000001","userName":"gbuckland","time":1391793376460},"checkinInfo":{"userId":"321YYCK_0002G427700000R","userName":"jsmith","time":1391793373471,"notes":"Reindexed document"},"isPrivate":true,"privateUserInfo":{"userId":"321YYCK_0002G427700000R","userName":"jsmith"},"signatureStatus":"NOT_SIGNED"}]}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/version
Response
<versionHistory>
    <version>
        <versionId>321YYC6_0001VD3FH000007</versionId>
        <versionNumber>1</versionNumber>
        <pageCount>1</pageCount>
        <creationInfo>
            <userId>321YYCL_0003BW63N000001</userId>
            <userName>gbuckland</userName>
            <time>1391793376460</time>
        </creationInfo>
        <checkinInfo>
            <userId>321YYC6_0001X0SB4000005</userId>
            <userName>jdoe</userName>
            <time>1391793376460</time>
            <notes>First version of document</notes>
        </checkinInfo>
        <isPrivate>false</isPrivate>
        <privateUserInfo/>
        <signatureStatus>SIGNATURE_VALID</signatureStatus>
    </version>
    <version>
        <versionId>321YYC6_00021GWXS000001</versionId>
        <versionNumber>2</versionNumber>
        <pageCount>1</pageCount>
        <creationInfo>
            <userId>321YYCL_0003BW63N000001</userId>
            <userName>gbuckland</userName>
            <time>1391793376460</time>
        </creationInfo>
        <checkinInfo>
            <userId>321YYCK_0002G427700000R</userId>
            <userName>jsmith</userName>
            <time>1391793373471</time>
            <notes>Reindexed document</notes>
        </checkinInfo>
        <isPrivate>true</isPrivate>
        <privateUserInfo>
            <userId>321YYCK_0002G427700000R</userId>
            <userName>jsmith</userName>
        </privateUserInfo>
        <signatureStatus>NOT_SIGNED</signatureStatus>
    </version>
</versionHistory>

POST/v1/document/{id}/versionControl/add Adds a given document to version control.

Expand Operation / Collapse Operation

Adds a given document to version control.

Available from version: 1.0.0

Call Properties

Request
Content addToVersionControl
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

addToVersionControl type

Represents a version control action to perform on the document.

Field Name Data Type Expected Description
comments String No Comments can be added when a document is added to version control.
keepHistory Boolean No This flag determines if the document history is kept when adding a document to version control.
versionNumber Integer No When adding a document in version control, the version number becomes the latest version.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/add
Request
{"comments":"Adding document to version control comment.","keepHistory":false,"versionNumber":3}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/add
Request
<addToVersionControl>
    <comments>Adding document to version control comment.</comments>
    <keepHistory>false</keepHistory>
    <versionNumber>3</versionNumber>
</addToVersionControl>

POST/v1/document/{id}/versionControl/checkIn Will check in a document to version control.

Expand Operation / Collapse Operation

Will check in a document to version control.

Available from version: 1.0.0

Call Properties

Request
Content checkIn
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

checkIn type

Represents a version control action to perform on the document.

Field Name Data Type Expected Description
comments String No Comments can be added when a document is checked in to version control.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/checkIn
Request
{"comments":"Checking in a document."}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/checkIn
Request
<checkIn>
    <comments>Checking in a document.</comments>
</checkIn>

POST/v1/document/{id}/versionControl/checkOut Will check out a document from version control.

Expand Operation / Collapse Operation

Will check out a document from version control.

Available from version: 1.0.0

Call Properties

Request
Content checkOut
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

checkOut type

Represents a version control action to perform on the document.

Field Name Data Type Expected Description
comments String No Comments can be added when a document is checked out of version control.
versionNumber Integer No Version number must be the latest version and will default to latest if not provided.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/checkOut
Request
{"comments":"Checking in a document.","versionNumber":5}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/checkOut
Request
<checkOut>
    <comments>Checking in a document.</comments>
    <versionNumber>5</versionNumber>
</checkOut>

POST/v1/document/{id}/versionControl/promoteVersion Promotes a previous version of the given document from version control to latest.

Expand Operation / Collapse Operation

Promotes a previous version of the given document from version control to latest.

Available from version: 1.0.0

Call Properties

Request
Content promoteVersion
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

promoteVersion type

Represents a version control action to perform on the document.

Field Name Data Type Expected Description
versionNumber Integer Yes Version number represents the version of the document to promote to latest.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/promoteVersion
Request
{"versionNumber":5}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/promoteVersion
Request
<promoteVersion>
    <versionNumber>5</versionNumber>
</promoteVersion>

POST/v1/document/{id}/versionControl/remove Removes a given document from version control.

Expand Operation / Collapse Operation

Removes a given document from version control.

Available from version: 1.0.0

Call Properties

Request
Content removeFromVersionControl
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

removeFromVersionControl type

Represents a version control action to perform on the document.

Field Name Data Type Expected Description
keepHistory Boolean No This flag determines if the document history is kept when removing a document from version control.
versionNumber Integer No When removing a document from version control, the version number becomes the latest version.

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/remove
Request
{"keepHistory":true,"versionNumber":3}

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/remove
Request
<removeFromVersionControl>
    <keepHistory>true</keepHistory>
    <versionNumber>3</versionNumber>
</removeFromVersionControl>

POST/v1/document/{id}/versionControl/undoCheckOut Will undo the previous document checkout.

Expand Operation / Collapse Operation

Will undo the previous document checkout.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/undoCheckOut

XML Samples

Sample 1
Request URL
/v1/document/301YW1J_000782VD90000B8/versionControl/undoCheckOut

Document (Version 2)

GET/v2/document/{id} Gets the document information from the server that matches the ID.

Expand Operation / Collapse Operation

Gets the document information from the server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkedOutUserInfo type

Contains checkout user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who has the document checked out
userName String Yes The name of the user who has the document checked out
document type

Represents a document object

Field Name Data Type Expected Description
info info Yes Information about the document
pages List of page [page] Yes Information about the pages in the document
properties List of propertyInstance [property] Yes Custom property information about the document
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow Item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
documentTypeId String Yes The ID of the document type.
drawer String Yes The name of the drawer.
drawerId String Yes The ID of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
id String Yes The document's ID
keys documentKeys Yes The document's set of keys
locationId String Yes The document's location
name String Yes The document's name
versionStatus versionStatus Yes The document's version control status
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
versionStatus type

Version status for a document

Field Name Data Type Expected Description
checkedOutUserInfo checkedOutUserInfo Yes The user who has the document checked out
isCheckedOut boolean Yes Whether or not the document is checked out by a user
isProvisional boolean Yes Whether or not the document version is provisional
isVersioned boolean Yes Whether or not the document is in version control
versionId String Yes The document's current version ID
versionNumber Integer Yes The document's current version number
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"versionStatus":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true,"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H?versionNumber=1
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"versionStatus":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true,"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"versionStatus":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true,"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <versionStatus>
            <versionNumber>5</versionNumber>
            <versionId>301REHR_0003RT6Y1000007</versionId>
            <isProvisional>true</isProvisional>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 2 - versionNumber parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H?versionNumber=1
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <versionStatus>
            <versionNumber>5</versionNumber>
            <versionId>301REHR_0003RT6Y1000007</versionId>
            <isProvisional>true</isProvisional>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 3 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <versionStatus>
            <versionNumber>5</versionNumber>
            <versionId>301REHR_0003RT6Y1000007</versionId>
            <isProvisional>true</isProvisional>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>

PUT/v2/document/{id}/page/{pageId} Updates a page in a document.

Expand Operation / Collapse Operation

Updates a page in a document.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to update.
Request
Content page
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

amount enumeration

The amount to rotate the page

Constant Name Description
DEGREES_90 Rotate the page 90 degrees clockwise
DEGREES_180 Rotate the page 180 degrees clockwise
DEGREES_270 Rotate the page 270 degrees clockwise
mode enumeration

Where to place the page within the document with respect to the other pages in the document.

Constant Name Description
FIRST Make the page the first page in the document.
LAST Make the page the last page in the document.
BEFORE Place the page before the reference page.
AFTER Place the page after the reference page.
moveMode enumeration

Whether to copy or move the page.

Constant Name Description
MOVE Move the page.
COPY Copy the page.
page type

Represents information about a document page

Field Name Data Type Expected Description
label String No An optional parameter used to update the page's label.
location pageLocation No An optional parameter used to update the page's location.
rotation rotation No An optional parameter used to rotate the page.
pageLocation type

Update the pages location within a document

Field Name Data Type Expected Description
documentId String No Document to put the page in. Optional, default is current document.
mode mode Yes How to place the page within the document with respect to other pages.
moveMode moveMode No Whether to copy or move the page. Optional, default is move.
referencePageId String No Reference page in document to determine where to place page. Required if mode is before/after.
rotation type

Rotate a page on a document a given amount

Field Name Data Type Expected Description
amount amount Yes The amount to rotate the page
subPage Integer No The sub-page to rotate if page is a mutlipage TIFF, 1 by default

JSON Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005
Request
{"rotation":{"amount":"DEGREES_90","subPage":3},"location":{"documentId":"301YW1E_00077ZVD900003H","mode":"BEFORE","referencePageId":"301YVD7_0002ZL50K000010","moveMode":"MOVE"},"label":"SamplePageLabel"}

XML Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005
Request
<page>
    <rotation>
        <amount>DEGREES_90</amount>
        <subPage>3</subPage>
    </rotation>
    <location>
        <documentId>301YW1E_00077ZVD900003H</documentId>
        <mode>BEFORE</mode>
        <referencePageId>301YVD7_0002ZL50K000010</referencePageId>
        <moveMode>MOVE</moveMode>
    </location>
    <label>SamplePageLabel</label>
</page>

GET/v2/document/{id}/page/{pageId}/annotation Gets all annotations for the document page stored in the server.

Expand Operation / Collapse Operation

Gets all annotations for the document page stored in the server.

Available from version: 1.0.0

Call Properties

Query Parameters
type (optional) A collection of annotation types used in filtering.
filePageNumber (optional) The sub-page number used to filter annotations. Zero indicates all sub-pages
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
annotations
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

accessInfo type

Represents info about when the annotation was accessed

Field Name Data Type Expected Description
time Long Yes The time the annotation was accessed
userId String Yes The user ID
userName String Yes The user name
annotations type

Represents a collection of annotations

Field Name Data Type Expected Description
arrowAnnotations List of arrowAnnotation [arrowAnnotation] Yes The collection of arrows
checkAnnotations List of checkAnnotation [checkAnnotation] Yes The collection of checks
digitalSignatures List of digitalSignatureAnnotation [digitalSignature] Yes The collection of digital signatures
highlightAnnotations List of highlightAnnotation [highlightAnnotation] Yes The collection of highlight annotations
lineAnnotations List of lineAnnotation [lineAnnotation] Yes The collection of lines
ovalAnnotations List of ovalAnnotation [ovalAnnotation] Yes The collection of ovals
penAnnotations List of penAnnotation [penAnnotation] Yes The collection of pens
pictureStampAnnotations List of pictureStampAnnotation [pictureStampAnnotation] Yes The collection of picture stamps
rectangleAnnotations List of rectangleAnnotation [rectangleAnnotation] Yes The collection of rectangles
stickyNoteAnnotations List of stickyNoteAnnotation [stickyNoteAnnotation] Yes The collection of sticky notes
textAnnotations List of textAnnotation [textAnnotation] Yes The collection of texts
textStampAnnotations List of textStampAnnotation [textStampAnnotation] Yes The collection of text stamps
urlAnnotations List of urlAnnotation [urlAnnotation] Yes The collection of urls
annotationType enumeration

Represents an annotation type

Constant Name Description
ARROW An arrow annotation
CHECK A check annotation
HIGHLIGHT A highlight annotation
LINE A line annotation
RECTANGLE A rectangle annotation
OVAL An oval annotation
PEN A pen annotation
TEXT_STAMP A text stamp annotation
PICTURE_STAMP A picture stamp annotation
TEXT A text annotation
STICKY_NOTE A sticky note annotation
URL A URL annotation
arrowAnnotation type

Represents an arrow annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color for the annotation
penWidth Integer Yes The pen width for the annotation
privileges privileges Yes The privilege information for this annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
checkAnnotation type

Represents an check annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
privileges privileges Yes The privilege information for this annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
digitalSignatureAnnotation type

Represents a digital signature annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the digital signature annotation
filePageNumber Integer Yes The file page number for the digital signature annotation
id String Yes The ID of the digital signature annotation
modificationInfo accessInfo Yes The modification information for the digital signature annotation
privileges privileges Yes The privilege information for this digital signature annotation
reasonID String Yes The ID of the reason associated with this digital signature
reasonText String Yes The text of the reason associated with this digital signature
signingDate Long Yes The time signing occurred
startLocation startLocation Yes The location of the digital signature annotation
status status Yes The digital signature status
userFirstName String Yes The first name of the signing user
userLastName String Yes The last name of the signing user
userName String Yes The name of the signing user
userPrefix String Yes The prefix of the signing user
userSuffix String Yes The suffix of the signing user
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
fileInformation type

Represents information about the file

Field Name Data Type Expected Description
fileExtension String Yes The extension of the file
workingName String Yes The name of the file
font type

Represents an annotation font

Field Name Data Type Expected Description
bold boolean Yes The bold attribute for the font
color String Yes The ARGB color of the pen in HEX starting with a #
face String Yes The font face name
height Integer Yes The font height
italic boolean Yes The italic attribute for the font
strikeout boolean Yes The strikeout attribute for the font
underline boolean Yes The underline attribute for the font
frame type

Represents the frame of an annotation

Field Name Data Type Expected Description
frameColor String Yes The frame color for the annotation
frameCornerRadius Integer Yes The frame corner radius for the annotation
frameMarginBottom Integer Yes The frame bottom margin for the annotation
frameMarginLeft Integer Yes The frame left margin for the annotation
frameMarginRight Integer Yes The frame right margin for the annotation
frameMarginTop Integer Yes The frame top margin for the annotation
frameStyle frameStyle Yes The frame style for the annotation
frameThickness Integer Yes The frame thickness for the annotation
frameStyle enumeration

The frame style of an annotation

Constant Name Description
NONE No frame style
RECTANGLE Rectangle frame style
ROUNDED_RECTANGLE Rounded rectangle frame style
ELLIPSE Ellipse frame style
highlightAnnotation type

Represents a highlight annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
lineAnnotation type

Represents a line annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
privileges privileges Yes The privilege information for this annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
location type

Represents the location of an annotation

Field Name Data Type Expected Description
endPoint point Yes Ending point for the annotation
startPoint point Yes Starting point for the annotation
note type

Represents a note

Field Name Data Type Expected Description
content String Yes Content
date String Yes Date
userName String Yes User Name
ovalAnnotation type

Represents an oval annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
privileges privileges Yes The privilege information for this annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
penAnnotation type

Represents a pen annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
path List of point [point] Yes The path of the pen annotation from a collection of points
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width for the annotation
privileges privileges Yes The privilege information for this annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
pictureStampAnnotation type

Represents a picture stamp annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
fileInformation fileInformation Yes Information about the physical file
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
privileges type

Represents privilege information about an annotation

Field Name Data Type Expected Description
canDelete boolean Yes Flag to determine if the annotation can be deleted
canHide boolean Yes Flag to determine if the annotation can be hidden
canModify boolean Yes Flag to determine if the annotation can be modified
rectangleAnnotation type

Represents a rectangle annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
id String Yes The ID of the annotation
location location Yes The location of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
penColor String Yes The pen color of the annotation
penWidth Integer Yes The pen width of the annotation
privileges privileges Yes The privilege information for this annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
status enumeration

The status of the digital signature

Constant Name Description
VALID Valid signature
EXPIRED Expired signature
INVALID Invalid signature
VOIDED Voided signatured
VOIDED_KEY_PAIR Voided username/password pair that signed the signature
stickyNoteAnnotation type

Represents an sticky note annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
notes List of note [note] Yes The list of individual notes added to a sticky note
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
templateInfo type

Represents info about the template used to create an annotation

Field Name Data Type Expected Description
templateDescription String Yes The template description
templateId String Yes The template ID
templateName String Yes The template name
textAnnotation type

Represents an text annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
textInformation textInformation Yes The text content of the annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
textInformation type

Represents the information about a text annotation

Field Name Data Type Expected Description
font font Yes Information about the font of the annotation text
justify textJustify Yes Flag to indicate justification
text String Yes The text contained in the annotation
textJustify enumeration

The justification of annotation text

Constant Name Description
JUSTIFY_CENTER Center justification
JUSTIFY_LEFT Left justification
JUSTIFY_RIGHT Right justification
textStampAnnotation type

Represents an text stamp annotation

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the annotation
dynamicVariables Boolean Yes The format specifiers in the text content are dynamic
filePageNumber Integer Yes The file page number for the annotation
fillColor String Yes The fill color of the annotation
frame frame Yes Information about the frame of the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
textInformation textInformation Yes The text content of the annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.
urlAnnotation type

Represents a URL annotation

Field Name Data Type Expected Description
actionURL String Yes The action url of the annotation
creationInfo accessInfo Yes The creation information for the annotation
filePageNumber Integer Yes The file page number for the annotation
id String Yes The ID of the annotation
modificationInfo accessInfo Yes The modification information for the annotation
privileges privileges Yes The privilege information for this annotation
startLocation startLocation Yes The location of the annotation
templateInfo templateInfo Yes Information about the template used to create this annotation
textInformation textInformation Yes The text content of the annotation
zOrder Integer Yes The Z-order for display of annotations if one overlaps another.

JSON Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation
Response
{"arrowAnnotations":[{"id":"321YY27_000DRV8ZE000001","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C000007","templateName":"Red Arrow","templateDescription":"Predefined"},"zOrder":2,"creationInfo":{"userId":"321YX18_0000C6VZL000001","userName":"msmith","time":1391793376460},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":false},"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotations":[{"id":"321YX3E_0002CLXPT000001","filePageNumber":2,"templateInfo":{"templateId":"321YX18_000001Q8C000008","templateName":"Green Check","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1363199866783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":true},"location":{"startPoint":{"x":722,"y":811},"endPoint":{"x":823,"y":912}},"penColor":"#FF008000"}],"lineAnnotations":[{"id":"321YY42_000F4RECK000005","filePageNumber":3,"templateInfo":{"templateId":"321YX18_000001Q8C00000F","templateName":"Black Line","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396474318370},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":208,"y":233},"endPoint":{"x":2019,"y":548}},"penColor":"#FF000000","penWidth":3}],"highlightAnnotations":[{"id":"321YY43_000F4BECJ000009","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000D","templateName":"Blue Highlight","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396533368590},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":532,"y":897},"endPoint":{"x":458,"y":45}},"fillColor":"#FFCCFFFF"}],"ovalAnnotations":[{"id":"321YY43_000F4QECK000003","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000J","templateName":"Blue Oval","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396534818487},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":2217,"y":451},"endPoint":{"x":119,"y":680}},"penColor":"#FF0000FF","penWidth":2,"fillColor":"#00000000"}],"penAnnotations":[{"id":"321YY43_000F4BECJ00000G","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000M","templateName":"Red Pen","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538112597},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"penColor":"#FFFF0000","penWidth":3,"path":[{"x":1849,"y":266},{"x":1852,"y":266},{"x":1855,"y":266}]}],"pictureStampAnnotations":[{"id":"321YY43_000F4TECK000005","filePageNumber":1,"templateInfo":{"templateId":"321YX3N_0002RXR9000000W","templateName":"Picture Stamp","templateDescription":"User-defined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538946523},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":249,"y":166}},"fileInformation":{"workingName":null,"fileExtension":"PNG"}}],"rectangleAnnotations":[{"id":"321YY43_000F4JECJ00000F","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000P","templateName":"Solid Red Rectangle","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396540036243},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":1515,"y":2531},"endPoint":{"x":309,"y":110}},"penColor":"#FFFF0000","penWidth":1,"fillColor":"#FFFF0000"}],"stickyNoteAnnotations":[{"id":"321YY43_000F51S4G000001","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000R","templateName":"Sticky Note","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547070910},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":true,"canDelete":false},"startLocation":{"startPoint":{"x":650,"y":1685}},"notes":[{"userName":"jdoe","date":"4/7/2014","content":"Hello World!"},{"userName":"jdoe","date":"4/8/2014","content":"This is some content.\r\nAnd another line of content"}]}],"textAnnotations":[{"id":"321YY43_000F5KS4G000002","filePageNumber":1,"templateInfo":{"templateId":"321YY1W_000DKBFM5000004","templateName":"Blue Text With Date","templateDescription":"User-defined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547509580},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":201,"y":1743}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text <hour.24>:<minute>"}}],"textStampAnnotations":[{"id":"321YY43_000F5BS4G000002","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000V","templateName":"Green Text Stamp","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396549670177},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":1333,"y":66}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF008000","frameThickness":3,"frameCornerRadius":8,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF008000","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Viewed by <user.name> at <hour.24>:<minute>:<second>"},"dynamicVariables":false}],"urlAnnotations":[{"id":"321YY43_000F50S4G000006","filePageNumber":1,"templateInfo":{"templateId":"321YX7C_0006M43PS00001J","templateName":"URL","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396551595783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":935,"y":64}},"textInformation":{"font":{"face":"Arial","color":"#FF0000FF","height":12,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}],"digitalSignatures":[{"id":"321YY43_000F50S4G000086","filePageNumber":1,"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396546096277},"modificationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396546096277},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":123,"y":321}},"userPrefix":"Dr.","userFirstName":"john","userLastName":"doe","userSuffix":"Esq.","userName":"jdoe","reasonText":"I agree to the terms by the placement of my signature on this document.","reasonID":"321YX18_0000CCVZL440021","signingDate":1220227200,"status":"VALID"}]}
Sample 2
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?type=ARROW&type=CHECK&filePageNumber=2
Response
{"arrowAnnotations":[{"id":"321YY27_000DRV8ZE000001","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C000007","templateName":"Red Arrow","templateDescription":"Predefined"},"zOrder":2,"creationInfo":{"userId":"321YX18_0000C6VZL000001","userName":"msmith","time":1391793376460},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":false},"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotations":[{"id":"321YX3E_0002CLXPT000001","filePageNumber":2,"templateInfo":{"templateId":"321YX18_000001Q8C000008","templateName":"Green Check","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1363199866783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":true},"location":{"startPoint":{"x":722,"y":811},"endPoint":{"x":823,"y":912}},"penColor":"#FF008000"}],"lineAnnotations":[],"highlightAnnotations":[],"ovalAnnotations":[],"penAnnotations":[],"pictureStampAnnotations":[],"rectangleAnnotations":[],"stickyNoteAnnotations":[],"textAnnotations":[],"textStampAnnotations":[],"urlAnnotations":[],"digitalSignatures":[]}
Sample 3 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?queueId=321YZ46_000QEJ5XJ000021
Response
{"arrowAnnotations":[{"id":"321YY27_000DRV8ZE000001","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C000007","templateName":"Red Arrow","templateDescription":"Predefined"},"zOrder":2,"creationInfo":{"userId":"321YX18_0000C6VZL000001","userName":"msmith","time":1391793376460},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":false},"location":{"startPoint":{"x":836,"y":1387},"endPoint":{"x":941,"y":1890}},"penColor":"#FFFF0000","penWidth":3}],"checkAnnotations":[{"id":"321YX3E_0002CLXPT000001","filePageNumber":2,"templateInfo":{"templateId":"321YX18_000001Q8C000008","templateName":"Green Check","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1363199866783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":true,"canModify":true,"canDelete":true},"location":{"startPoint":{"x":722,"y":811},"endPoint":{"x":823,"y":912}},"penColor":"#FF008000"}],"lineAnnotations":[{"id":"321YY42_000F4RECK000005","filePageNumber":3,"templateInfo":{"templateId":"321YX18_000001Q8C00000F","templateName":"Black Line","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396474318370},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":208,"y":233},"endPoint":{"x":2019,"y":548}},"penColor":"#FF000000","penWidth":3}],"highlightAnnotations":[{"id":"321YY43_000F4BECJ000009","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000D","templateName":"Blue Highlight","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396533368590},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":532,"y":897},"endPoint":{"x":458,"y":45}},"fillColor":"#FFCCFFFF"}],"ovalAnnotations":[{"id":"321YY43_000F4QECK000003","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000J","templateName":"Blue Oval","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396534818487},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":2217,"y":451},"endPoint":{"x":119,"y":680}},"penColor":"#FF0000FF","penWidth":2,"fillColor":"#00000000"}],"penAnnotations":[{"id":"321YY43_000F4BECJ00000G","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000M","templateName":"Red Pen","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538112597},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"penColor":"#FFFF0000","penWidth":3,"path":[{"x":1849,"y":266},{"x":1852,"y":266},{"x":1855,"y":266}]}],"pictureStampAnnotations":[{"id":"321YY43_000F4TECK000005","filePageNumber":1,"templateInfo":{"templateId":"321YX3N_0002RXR9000000W","templateName":"Picture Stamp","templateDescription":"User-defined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396538946523},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":249,"y":166}},"fileInformation":{"workingName":null,"fileExtension":"PNG"}}],"rectangleAnnotations":[{"id":"321YY43_000F4JECJ00000F","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000P","templateName":"Solid Red Rectangle","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396540036243},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"location":{"startPoint":{"x":1515,"y":2531},"endPoint":{"x":309,"y":110}},"penColor":"#FFFF0000","penWidth":1,"fillColor":"#FFFF0000"}],"stickyNoteAnnotations":[{"id":"321YY43_000F51S4G000001","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000R","templateName":"Sticky Note","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547070910},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":true,"canDelete":false},"startLocation":{"startPoint":{"x":650,"y":1685}},"notes":[{"userName":"jdoe","date":"4/7/2014","content":"Hello World!"},{"userName":"jdoe","date":"4/8/2014","content":"This is some content.\r\nAnd another line of content"}]}],"textAnnotations":[{"id":"321YY43_000F5KS4G000002","filePageNumber":1,"templateInfo":{"templateId":"321YY1W_000DKBFM5000004","templateName":"Blue Text With Date","templateDescription":"User-defined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"aduncan","time":1396547509580},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":201,"y":1743}},"textInformation":{"font":{"face":"Times New Roman","color":"#FF0000FF","height":14,"bold":true,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"My Text <hour.24>:<minute>"}}],"textStampAnnotations":[{"id":"321YY43_000F5BS4G000002","filePageNumber":1,"templateInfo":{"templateId":"321YX18_000001Q8C00000V","templateName":"Green Text Stamp","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396549670177},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":1333,"y":66}},"fillColor":"#00000000","frame":{"frameStyle":"ROUNDED_RECTANGLE","frameColor":"#FF008000","frameThickness":3,"frameCornerRadius":8,"frameMarginLeft":5,"frameMarginRight":5,"frameMarginTop":0,"frameMarginBottom":0},"textInformation":{"font":{"face":"Stencil","color":"#FF008000","height":20,"bold":false,"italic":false,"underline":false,"strikeout":false},"justify":"JUSTIFY_CENTER","text":"Viewed by <user.name> at <hour.24>:<minute>:<second>"},"dynamicVariables":false}],"urlAnnotations":[{"id":"321YY43_000F50S4G000006","filePageNumber":1,"templateInfo":{"templateId":"321YX7C_0006M43PS00001J","templateName":"URL","templateDescription":"Predefined"},"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396551595783},"modificationInfo":{"userId":null,"userName":null,"time":null},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":935,"y":64}},"textInformation":{"font":{"face":"Arial","color":"#FF0000FF","height":12,"bold":false,"italic":false,"underline":true,"strikeout":false},"justify":"JUSTIFY_LEFT","text":"Perceptive Software"},"actionURL":"http://www.perceptivesoftware.com"}],"digitalSignatures":[{"id":"321YY43_000F50S4G000086","filePageNumber":1,"zOrder":1,"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396546096277},"modificationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396546096277},"privileges":{"canHide":false,"canModify":false,"canDelete":false},"startLocation":{"startPoint":{"x":123,"y":321}},"userPrefix":"Dr.","userFirstName":"john","userLastName":"doe","userSuffix":"Esq.","userName":"jdoe","reasonText":"I agree to the terms by the placement of my signature on this document.","reasonID":"321YX18_0000CCVZL440021","signingDate":1220227200,"status":"VALID"}]}

XML Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation
Response
<annotations>
    <arrowAnnotations>
        <arrowAnnotation>
            <id>321YY27_000DRV8ZE000001</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C000007</templateId>
                <templateName>Red Arrow</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>2</zOrder>
            <creationInfo>
                <userId>321YX18_0000C6VZL000001</userId>
                <userName>msmith</userName>
                <time>1391793376460</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>836</x>
                    <y>1387</y>
                </startPoint>
                <endPoint>
                    <x>941</x>
                    <y>1890</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotation>
    </arrowAnnotations>
    <checkAnnotations>
        <checkAnnotation>
            <id>321YX3E_0002CLXPT000001</id>
            <filePageNumber>2</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C000008</templateId>
                <templateName>Green Check</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1363199866783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>true</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>722</x>
                    <y>811</y>
                </startPoint>
                <endPoint>
                    <x>823</x>
                    <y>912</y>
                </endPoint>
            </location>
            <penColor>#FF008000</penColor>
        </checkAnnotation>
    </checkAnnotations>
    <lineAnnotations>
        <lineAnnotation>
            <id>321YY42_000F4RECK000005</id>
            <filePageNumber>3</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000F</templateId>
                <templateName>Black Line</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396474318370</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>208</x>
                    <y>233</y>
                </startPoint>
                <endPoint>
                    <x>2019</x>
                    <y>548</y>
                </endPoint>
            </location>
            <penColor>#FF000000</penColor>
            <penWidth>3</penWidth>
        </lineAnnotation>
    </lineAnnotations>
    <highlightAnnotations>
        <highlightAnnotation>
            <id>321YY43_000F4BECJ000009</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000D</templateId>
                <templateName>Blue Highlight</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396533368590</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>532</x>
                    <y>897</y>
                </startPoint>
                <endPoint>
                    <x>458</x>
                    <y>45</y>
                </endPoint>
            </location>
            <fillColor>#FFCCFFFF</fillColor>
        </highlightAnnotation>
    </highlightAnnotations>
    <ovalAnnotations>
        <ovalAnnotation>
            <id>321YY43_000F4QECK000003</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000J</templateId>
                <templateName>Blue Oval</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396534818487</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>2217</x>
                    <y>451</y>
                </startPoint>
                <endPoint>
                    <x>119</x>
                    <y>680</y>
                </endPoint>
            </location>
            <penColor>#FF0000FF</penColor>
            <penWidth>2</penWidth>
            <fillColor>#00000000</fillColor>
        </ovalAnnotation>
    </ovalAnnotations>
    <penAnnotations>
        <penAnnotation>
            <id>321YY43_000F4BECJ00000G</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000M</templateId>
                <templateName>Red Pen</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538112597</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <path>
                <point>
                    <x>1849</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1852</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1855</x>
                    <y>266</y>
                </point>
            </path>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </penAnnotation>
    </penAnnotations>
    <pictureStampAnnotations>
        <pictureStampAnnotation>
            <id>321YY43_000F4TECK000005</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX3N_0002RXR9000000W</templateId>
                <templateName>Picture Stamp</templateName>
                <templateDescription>User-defined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538946523</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>249</x>
                    <y>166</y>
                </startPoint>
            </startLocation>
            <fileInformation>
                <fileExtension>PNG</fileExtension>
            </fileInformation>
        </pictureStampAnnotation>
    </pictureStampAnnotations>
    <rectangleAnnotations>
        <rectangleAnnotation>
            <id>321YY43_000F4JECJ00000F</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000P</templateId>
                <templateName>Solid Red Rectangle</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396540036243</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>1515</x>
                    <y>2531</y>
                </startPoint>
                <endPoint>
                    <x>309</x>
                    <y>110</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>1</penWidth>
            <fillColor>#FFFF0000</fillColor>
        </rectangleAnnotation>
    </rectangleAnnotations>
    <stickyNoteAnnotations>
        <stickyNoteAnnotation>
            <id>321YY43_000F51S4G000001</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000R</templateId>
                <templateName>Sticky Note</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547070910</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>650</x>
                    <y>1685</y>
                </startPoint>
            </startLocation>
            <notes>
                <note>
                    <userName>jdoe</userName>
                    <date>4/7/2014</date>
                    <content>Hello World!</content>
                </note>
                <note>
                    <userName>jdoe</userName>
                    <date>4/8/2014</date>
                    <content>This is some content.&#13;
And another line of content</content>
                </note>
            </notes>
        </stickyNoteAnnotation>
    </stickyNoteAnnotations>
    <textAnnotations>
        <textAnnotation>
            <id>321YY43_000F5KS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YY1W_000DKBFM5000004</templateId>
                <templateName>Blue Text With Date</templateName>
                <templateDescription>User-defined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547509580</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>201</x>
                    <y>1743</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Times New Roman</face>
                    <color>#FF0000FF</color>
                    <height>14</height>
                    <bold>true</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>My Text &lt;hour.24&gt;:&lt;minute&gt;</text>
            </textInformation>
        </textAnnotation>
    </textAnnotations>
    <textStampAnnotations>
        <textStampAnnotation>
            <id>321YY43_000F5BS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000V</templateId>
                <templateName>Green Text Stamp</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396549670177</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>1333</x>
                    <y>66</y>
                </startPoint>
            </startLocation>
            <fillColor>#00000000</fillColor>
            <frame>
                <frameStyle>ROUNDED_RECTANGLE</frameStyle>
                <frameColor>#FF008000</frameColor>
                <frameThickness>3</frameThickness>
                <frameCornerRadius>8</frameCornerRadius>
                <frameMarginLeft>5</frameMarginLeft>
                <frameMarginRight>5</frameMarginRight>
                <frameMarginTop>0</frameMarginTop>
                <frameMarginBottom>0</frameMarginBottom>
            </frame>
            <textInformation>
                <font>
                    <face>Stencil</face>
                    <color>#FF008000</color>
                    <height>20</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>Viewed by &lt;user.name&gt; at &lt;hour.24&gt;:&lt;minute&gt;:&lt;second&gt;</text>
            </textInformation>
            <dynamicVariables>false</dynamicVariables>
        </textStampAnnotation>
    </textStampAnnotations>
    <urlAnnotations>
        <urlAnnotation>
            <id>321YY43_000F50S4G000006</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX7C_0006M43PS00001J</templateId>
                <templateName>URL</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396551595783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>935</x>
                    <y>64</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Arial</face>
                    <color>#FF0000FF</color>
                    <height>12</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>true</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_LEFT</justify>
                <text>Perceptive Software</text>
            </textInformation>
            <actionURL>http://www.perceptivesoftware.com</actionURL>
        </urlAnnotation>
    </urlAnnotations>
    <digitalSignatures>
        <digitalSignature>
            <id>321YY43_000F50S4G000086</id>
            <filePageNumber>1</filePageNumber>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396546096277</time>
            </creationInfo>
            <modificationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396546096277</time>
            </modificationInfo>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>123</x>
                    <y>321</y>
                </startPoint>
            </startLocation>
            <userPrefix>Dr.</userPrefix>
            <userFirstName>john</userFirstName>
            <userLastName>doe</userLastName>
            <userSuffix>Esq.</userSuffix>
            <userName>jdoe</userName>
            <reasonText>I agree to the terms by the placement of my signature on this document.</reasonText>
            <reasonID>321YX18_0000CCVZL440021</reasonID>
            <signingDate>1220227200</signingDate>
            <status>VALID</status>
        </digitalSignature>
    </digitalSignatures>
</annotations>
Sample 2
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?type=ARROW&type=CHECK&filePageNumber=2
Response
<annotations>
    <arrowAnnotations>
        <arrowAnnotation>
            <id>321YY27_000DRV8ZE000001</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C000007</templateId>
                <templateName>Red Arrow</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>2</zOrder>
            <creationInfo>
                <userId>321YX18_0000C6VZL000001</userId>
                <userName>msmith</userName>
                <time>1391793376460</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>836</x>
                    <y>1387</y>
                </startPoint>
                <endPoint>
                    <x>941</x>
                    <y>1890</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotation>
    </arrowAnnotations>
    <checkAnnotations>
        <checkAnnotation>
            <id>321YX3E_0002CLXPT000001</id>
            <filePageNumber>2</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C000008</templateId>
                <templateName>Green Check</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1363199866783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>true</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>722</x>
                    <y>811</y>
                </startPoint>
                <endPoint>
                    <x>823</x>
                    <y>912</y>
                </endPoint>
            </location>
            <penColor>#FF008000</penColor>
        </checkAnnotation>
    </checkAnnotations>
    <lineAnnotations/>
    <highlightAnnotations/>
    <ovalAnnotations/>
    <penAnnotations/>
    <pictureStampAnnotations/>
    <rectangleAnnotations/>
    <stickyNoteAnnotations/>
    <textAnnotations/>
    <textStampAnnotations/>
    <urlAnnotations/>
    <digitalSignatures/>
</annotations>
Sample 3 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation?queueId=321YZ46_000QEJ5XJ000021
Response
<annotations>
    <arrowAnnotations>
        <arrowAnnotation>
            <id>321YY27_000DRV8ZE000001</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C000007</templateId>
                <templateName>Red Arrow</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>2</zOrder>
            <creationInfo>
                <userId>321YX18_0000C6VZL000001</userId>
                <userName>msmith</userName>
                <time>1391793376460</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>836</x>
                    <y>1387</y>
                </startPoint>
                <endPoint>
                    <x>941</x>
                    <y>1890</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </arrowAnnotation>
    </arrowAnnotations>
    <checkAnnotations>
        <checkAnnotation>
            <id>321YX3E_0002CLXPT000001</id>
            <filePageNumber>2</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C000008</templateId>
                <templateName>Green Check</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1363199866783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>true</canHide>
                <canModify>true</canModify>
                <canDelete>true</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>722</x>
                    <y>811</y>
                </startPoint>
                <endPoint>
                    <x>823</x>
                    <y>912</y>
                </endPoint>
            </location>
            <penColor>#FF008000</penColor>
        </checkAnnotation>
    </checkAnnotations>
    <lineAnnotations>
        <lineAnnotation>
            <id>321YY42_000F4RECK000005</id>
            <filePageNumber>3</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000F</templateId>
                <templateName>Black Line</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396474318370</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>208</x>
                    <y>233</y>
                </startPoint>
                <endPoint>
                    <x>2019</x>
                    <y>548</y>
                </endPoint>
            </location>
            <penColor>#FF000000</penColor>
            <penWidth>3</penWidth>
        </lineAnnotation>
    </lineAnnotations>
    <highlightAnnotations>
        <highlightAnnotation>
            <id>321YY43_000F4BECJ000009</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000D</templateId>
                <templateName>Blue Highlight</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396533368590</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>532</x>
                    <y>897</y>
                </startPoint>
                <endPoint>
                    <x>458</x>
                    <y>45</y>
                </endPoint>
            </location>
            <fillColor>#FFCCFFFF</fillColor>
        </highlightAnnotation>
    </highlightAnnotations>
    <ovalAnnotations>
        <ovalAnnotation>
            <id>321YY43_000F4QECK000003</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000J</templateId>
                <templateName>Blue Oval</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396534818487</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>2217</x>
                    <y>451</y>
                </startPoint>
                <endPoint>
                    <x>119</x>
                    <y>680</y>
                </endPoint>
            </location>
            <penColor>#FF0000FF</penColor>
            <penWidth>2</penWidth>
            <fillColor>#00000000</fillColor>
        </ovalAnnotation>
    </ovalAnnotations>
    <penAnnotations>
        <penAnnotation>
            <id>321YY43_000F4BECJ00000G</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000M</templateId>
                <templateName>Red Pen</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538112597</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <path>
                <point>
                    <x>1849</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1852</x>
                    <y>266</y>
                </point>
                <point>
                    <x>1855</x>
                    <y>266</y>
                </point>
            </path>
            <penColor>#FFFF0000</penColor>
            <penWidth>3</penWidth>
        </penAnnotation>
    </penAnnotations>
    <pictureStampAnnotations>
        <pictureStampAnnotation>
            <id>321YY43_000F4TECK000005</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX3N_0002RXR9000000W</templateId>
                <templateName>Picture Stamp</templateName>
                <templateDescription>User-defined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396538946523</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>249</x>
                    <y>166</y>
                </startPoint>
            </startLocation>
            <fileInformation>
                <fileExtension>PNG</fileExtension>
            </fileInformation>
        </pictureStampAnnotation>
    </pictureStampAnnotations>
    <rectangleAnnotations>
        <rectangleAnnotation>
            <id>321YY43_000F4JECJ00000F</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000P</templateId>
                <templateName>Solid Red Rectangle</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396540036243</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <location>
                <startPoint>
                    <x>1515</x>
                    <y>2531</y>
                </startPoint>
                <endPoint>
                    <x>309</x>
                    <y>110</y>
                </endPoint>
            </location>
            <penColor>#FFFF0000</penColor>
            <penWidth>1</penWidth>
            <fillColor>#FFFF0000</fillColor>
        </rectangleAnnotation>
    </rectangleAnnotations>
    <stickyNoteAnnotations>
        <stickyNoteAnnotation>
            <id>321YY43_000F51S4G000001</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000R</templateId>
                <templateName>Sticky Note</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547070910</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>true</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>650</x>
                    <y>1685</y>
                </startPoint>
            </startLocation>
            <notes>
                <note>
                    <userName>jdoe</userName>
                    <date>4/7/2014</date>
                    <content>Hello World!</content>
                </note>
                <note>
                    <userName>jdoe</userName>
                    <date>4/8/2014</date>
                    <content>This is some content.&#13;
And another line of content</content>
                </note>
            </notes>
        </stickyNoteAnnotation>
    </stickyNoteAnnotations>
    <textAnnotations>
        <textAnnotation>
            <id>321YY43_000F5KS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YY1W_000DKBFM5000004</templateId>
                <templateName>Blue Text With Date</templateName>
                <templateDescription>User-defined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>aduncan</userName>
                <time>1396547509580</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>201</x>
                    <y>1743</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Times New Roman</face>
                    <color>#FF0000FF</color>
                    <height>14</height>
                    <bold>true</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>My Text &lt;hour.24&gt;:&lt;minute&gt;</text>
            </textInformation>
        </textAnnotation>
    </textAnnotations>
    <textStampAnnotations>
        <textStampAnnotation>
            <id>321YY43_000F5BS4G000002</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX18_000001Q8C00000V</templateId>
                <templateName>Green Text Stamp</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396549670177</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>1333</x>
                    <y>66</y>
                </startPoint>
            </startLocation>
            <fillColor>#00000000</fillColor>
            <frame>
                <frameStyle>ROUNDED_RECTANGLE</frameStyle>
                <frameColor>#FF008000</frameColor>
                <frameThickness>3</frameThickness>
                <frameCornerRadius>8</frameCornerRadius>
                <frameMarginLeft>5</frameMarginLeft>
                <frameMarginRight>5</frameMarginRight>
                <frameMarginTop>0</frameMarginTop>
                <frameMarginBottom>0</frameMarginBottom>
            </frame>
            <textInformation>
                <font>
                    <face>Stencil</face>
                    <color>#FF008000</color>
                    <height>20</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>false</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_CENTER</justify>
                <text>Viewed by &lt;user.name&gt; at &lt;hour.24&gt;:&lt;minute&gt;:&lt;second&gt;</text>
            </textInformation>
            <dynamicVariables>false</dynamicVariables>
        </textStampAnnotation>
    </textStampAnnotations>
    <urlAnnotations>
        <urlAnnotation>
            <id>321YY43_000F50S4G000006</id>
            <filePageNumber>1</filePageNumber>
            <templateInfo>
                <templateId>321YX7C_0006M43PS00001J</templateId>
                <templateName>URL</templateName>
                <templateDescription>Predefined</templateDescription>
            </templateInfo>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396551595783</time>
            </creationInfo>
            <modificationInfo/>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>935</x>
                    <y>64</y>
                </startPoint>
            </startLocation>
            <textInformation>
                <font>
                    <face>Arial</face>
                    <color>#FF0000FF</color>
                    <height>12</height>
                    <bold>false</bold>
                    <italic>false</italic>
                    <underline>true</underline>
                    <strikeout>false</strikeout>
                </font>
                <justify>JUSTIFY_LEFT</justify>
                <text>Perceptive Software</text>
            </textInformation>
            <actionURL>http://www.perceptivesoftware.com</actionURL>
        </urlAnnotation>
    </urlAnnotations>
    <digitalSignatures>
        <digitalSignature>
            <id>321YY43_000F50S4G000086</id>
            <filePageNumber>1</filePageNumber>
            <zOrder>1</zOrder>
            <creationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396546096277</time>
            </creationInfo>
            <modificationInfo>
                <userId>321YX18_0000CCVZL000001</userId>
                <userName>jdoe</userName>
                <time>1396546096277</time>
            </modificationInfo>
            <privileges>
                <canHide>false</canHide>
                <canModify>false</canModify>
                <canDelete>false</canDelete>
            </privileges>
            <startLocation>
                <startPoint>
                    <x>123</x>
                    <y>321</y>
                </startPoint>
            </startLocation>
            <userPrefix>Dr.</userPrefix>
            <userFirstName>john</userFirstName>
            <userLastName>doe</userLastName>
            <userSuffix>Esq.</userSuffix>
            <userName>jdoe</userName>
            <reasonText>I agree to the terms by the placement of my signature on this document.</reasonText>
            <reasonID>321YX18_0000CCVZL440021</reasonID>
            <signingDate>1220227200</signingDate>
            <status>VALID</status>
        </digitalSignature>
    </digitalSignatures>
</annotations>

PUT/v2/document/{id}/page/{pageId}/annotation/DIGITAL_SIGNATURE/{annotationId} Updates a digital signature visual representation on a page

Expand Operation / Collapse Operation

Updates a digital signature visual representation on a page

Available from version: 1.0.0

Call Properties

Request
Content digitalSignatureAnnotation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the updated digital signature visual representation.

Call Types and Enumerations

digitalSignatureAnnotation type

Represents a digital signature annotation

Field Name Data Type Expected Description
startLocation startLocation Yes The location of the annotation
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

Represents the starting point of an annotation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation

JSON Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/DIGITAL_SIGNATURE/321YY43_000F5KS4G000002
Request
{"startLocation":{"startPoint":{"x":1256,"y":616}}}

XML Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/DIGITAL_SIGNATURE/321YY43_000F5KS4G000002
Request
<digitalSignatureAnnotation>
    <startLocation>
        <startPoint>
            <x>1256</x>
            <y>616</y>
        </startPoint>
    </startLocation>
</digitalSignatureAnnotation>

DELETE/v2/document/{id}/page/{pageId}/annotation/{type}/{annotationId} Deletes an annotation from a page

Expand Operation / Collapse Operation

Deletes an annotation from a page

Available from version: 1.0.0

Call Properties

Path Parameters
type annotationType The annotation type to delete
annotationId The annotation on the document page to delete.
Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

annotationType enumeration

Represents an annotation type

Constant Name Description
ARROW An arrow annotation
CHECK A check annotation
HIGHLIGHT A highlight annotation
LINE A line annotation
RECTANGLE A rectangle annotation
OVAL An oval annotation
PEN A pen annotation
TEXT_STAMP A text stamp annotation
PICTURE_STAMP A picture stamp annotation
TEXT A text annotation
STICKY_NOTE A sticky note annotation
URL A URL annotation
DIGITAL_SIGNATURE A digital signature

JSON Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051?queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/annotation/ARROW/301YVD7_0002ZL50K000051?queueId=321YZ46_000QEJ5XJ000021

GET/v2/document/{id}/page/{pageId}/file Gets the file associated with a page stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets the file associated with a page stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Query Parameters
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
contentDisposition outputType (optional) Allows requestor to specify the Content-Disposition returned by the server.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
X-IntegrationServer-File-Size The file size of the page.
Content-Disposition Standard Content-Disposition header, returned when including the contentDisposition query parameter.

Call Types and Enumerations

outputType enumeration

The Content-Disposition returned from the server.

Constant Name Description
INLINE Use inline Content-Disposition.
ATTACHMENT Use attachment Content-Disposition.

JSON Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

XML Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

HEAD/v2/document/{id}/page/{pageId}/file Gets the file info associated with a page stored in ImageNow Server, including the ID and content...

Expand Operation / Collapse Operation

Gets the file info associated with a page stored in ImageNow Server, including the ID and content-length.

Available from version: 1.0.0

Call Properties

Query Parameters
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
contentDisposition outputType (optional) Allows requestor to specify the Content-Disposition returned by the server.
Response
Content
Binary
Content-Types
  • application/octet-stream
  • application/xml
  • application/json
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
X-IntegrationServer-File-Size The file size of the page.
Content-Type Note: "application/xml" and "application/json" are deprecated and should no longer be specified as valid Accept types in the request.
Content-Disposition Standard Content-Disposition header, returned when including the contentDisposition query parameter.

Call Types and Enumerations

outputType enumeration

The Content-Disposition returned from the server.

Constant Name Description
INLINE Use inline Content-Disposition.
ATTACHMENT Use attachment Content-Disposition.

JSON Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

XML Samples

Sample 1
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?queueId=321YZ46_000QEJ5XJ000021
Sample 3 - using inline Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=INLINE
Sample 4 - using attachment Content-Disposition
Request URL
/v2/document/301YW1E_00077ZVD900003H/page/301YVD7_0002ZL50K000005/file?contentDisposition=ATTACHMENT

GET/v2/document/{id}/page/{pageId}/preview Gets the preview file associated with a page stored in the Server.

Expand Operation / Collapse Operation

Gets the preview file associated with a page stored in the Server.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to preview.
Query Parameters
maxHeight (optional) The maximum height for the preview image.
maxWidth (optional) The maximum width for the preview image.
pageNumber (optional) The sub-page number to preview.
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
None
Content-Type
  • */*
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
X-IntegrationServer-Available-Pages The total number of sub-pages that exist for the given page.
X-IntegrationServer-Content-Is-Preview True if the response body contains a preview, false if the body contains the original image.
Content-Type The content-type determined by the server based on the file type of the resource.

JSON Samples

Sample 1
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

HEAD/v2/document/{id}/page/{pageId}/preview Gets the preview file info associated with a page stored in the Server.

Expand Operation / Collapse Operation

Gets the preview file info associated with a page stored in the Server.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document that you want to preview.
Query Parameters
maxHeight (optional) The maximum height for the preview image.
maxWidth (optional) The maximum width for the preview image.
pageNumber (optional) The sub-page number to preview.
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
None
Content-Type
  • */*
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
X-IntegrationServer-Available-Pages The total number of sub-pages that exist for the given page.
X-IntegrationServer-Content-Is-Preview True if the response body contains a preview, false if the body contains the original image.
Content-Type The content-type determined by the server based on the file type of the resource.

JSON Samples

Sample 1
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1
Sample 2 - queueId parameter included
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

GET/v2/document/{id}/page/{pageId}/rendition Retrieves a .png rendition of the page specified by pageId from the document specified by id. To ...

Expand Operation / Collapse Operation

Retrieves a .png rendition of the page specified by pageId from the document specified by id. To use this call, File Conversion Service is required.

Available from version: 1.0.0

Call Properties

Path Parameters
pageId The page within the document you want to render
Query Parameters
width (optional) The width (in pixels) of the rendered page
height (optional) The height (in pixels) of the rendered page
pageNumber (optional) Page number to retrieve from within a multi=page TIFF
queueId (optional) Verifies the user's process privilege for the workflow queue tha tthe document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Available-Pages Number of available pages for a mulitple page rendition
X-IntegrationServer-Original-Orientation Orientation of the page source
X-IntegrationServer-Original-Height Height of the page source
X-IntegrationServer-Original-Width Width of the page source
X-IntegrationServer-Original-X-DPI X DPI of the page source
X-IntegrationServer-Original-Y-DPI Y DPI of the page source
X-IntegrationServer-Rendition-Height Height of the page rendition
X-IntegrationServer-Rendition-Width Width of the page rendition
X-IntegrationServer-Content-Is-Rendition Page was successfully rendered
X-IntegrationServer-Original-File-Type File type of the page source
X-IntegrationServer-Original-File-Size File size of the page source

JSON Samples

Sample 1
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?width=600&height=600&pageNumber=1
Sample 2 - queueIdparameter included
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?width=600&height=600&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

XML Samples

Sample 1
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?width=600&height=600&pageNumber=1
Sample 2 - queueIdparameter included
Request URL
/v2/document/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?width=600&height=600&pageNumber=1&queueId=321YZ46_000QEJ5XJ000021

Document (Version 3)

POST/v3/document Store a new document in the server.

Expand Operation / Collapse Operation

Store a new document in the server.

Available from version: 1.0.0

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The action to perform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content document
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json
Additional Header
Location The URI location of the newly created document.

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
document type

Object representing a document to be created

Field Name Data Type Expected Description
info info Yes Metadata information about the document
properties List of propertyInstance [property] Yes Custom property information about the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
keys documentKeys Yes The document's set of keys
locationId String No The document's location
name String No The document name
notes String No The document's notes
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's ID
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's ID
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1 - Request to create a document with a response indicating a naming conflict
Request URL
/v3/document
Request
{"info":{"name":"Document Name","notes":"Document notes.","locationId":"301YVCP_000294NLF000006","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}
Response
{"instanceType":"DOCUMENT","id":"301YW1E_00077ZVD900003H"}
Sample 2 - Request to replace the existing document with the new document
Request URL
/v3/document?action=REPLACE
Request
{"info":{"name":"Document Name","notes":"Document notes.","locationId":"301YVCP_000294NLF000006","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}

XML Samples

Sample 1 - Request to create a document with a response indicating a naming conflict
Request URL
/v3/document
Request
<document>
    <info>
        <name>Document Name</name>
        <notes>Document notes.</notes>
        <locationId>301YVCP_000294NLF000006</locationId>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</document>
Response
<conflictItem>
    <instanceType>DOCUMENT</instanceType>
    <id>301YW1E_00077ZVD900003H</id>
</conflictItem>
Sample 2 - Request to replace the existing document with the new document
Request URL
/v3/document?action=REPLACE
Request
<document>
    <info>
        <name>Document Name</name>
        <notes>Document notes.</notes>
        <locationId>301YVCP_000294NLF000006</locationId>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</document>

GET/v3/document/{id} Gets the document information from the server that matches the ID.

Expand Operation / Collapse Operation

Gets the document information from the server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkedOutUserInfo type

Contains checkout user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who has the document checked out
userName String Yes The name of the user who has the document checked out
document type

Represents a document object

Field Name Data Type Expected Description
info info Yes Information about the document
pages List of page [page] Yes Information about the pages in the document
properties List of propertyInstance [property] Yes Custom property information about the document
versionInfo versionInfo Yes Information about the document's version
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow Item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
documentTypeId String Yes The ID of the document type.
drawer String Yes The name of the drawer.
drawerId String Yes The ID of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
id String Yes The document's ID
keys documentKeys Yes The document's set of keys
locationId String Yes The document's location
name String Yes The document's name
notes String Yes The document's notes
versionStatus versionControlStatus Yes The document's version control status
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
elementId String No The element ID identifies the occurance of the composite property. This field is only set when the returned property is an array or composite.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
versionControlStatus type

Represents the version control status of the document.

Field Name Data Type Expected Description
checkedOutUserInfo checkedOutUserInfo Yes The user who has the document checked out
isCheckedOut boolean Yes Whether or not the document is checked out by a user
isVersioned boolean Yes Whether or not the document is in version control
versionInfo type

Contains version information for the requested document.

Field Name Data Type Expected Description
isProvisional boolean Yes Whether or not the document version is provisional
versionId String Yes The version ID of the document.
versionNumber Integer Yes The version number of the document.
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v3/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber parameter included
Request URL
/v3/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v3/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v3/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 2 - versionNumber parameter included
Request URL
/v3/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 3 - queueId parameter included
Request URL
/v3/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>

PUT/v3/document/{id} Updates the document fields with the provided values.

Expand Operation / Collapse Operation

Updates the document fields with the provided values.

Available from version: 1.0.0

Call Properties

Query Parameters
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's content privilege for the drawer that the document is in.
action actionType (default RETURN_CONFLICTS) (optional) The action to perform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content document
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
document type

Object representing a document to be updated

Field Name Data Type Expected Description
info info Yes Metadata information about the document
properties List of propertyInstance [property] Yes Custom property information about the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
keys documentKeys Yes The document's set of keys
locationId String Yes The document's location ID. This can be a folder ID or drawer ID.
name String Yes The document name
notes String Yes The document's notes
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's ID
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values of the sub-properties
id String Yes The property's ID.
type type Yes The property's type.
value String Yes The property's value.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v3/document/301YW1E_00077ZVD900003H
Request
{"info":{"locationId":"301YVCP_000294NLF000006","name":"Document Name","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"},"notes":"Notes"},"properties":[{"id":"301YVDX_0003RW4Y1000001","type":null,"value":null,"childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"Another StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"42"}]},{"id":"301YVDX_0003RW4Y1000001","type":null,"value":null,"childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"Another StringValue"}]},{"id":"309JRTG_0003RI2I1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v3/document/301YW1E_00077ZVD900003H
Request
<document>
    <info>
        <locationId>301YVCP_000294NLF000006</locationId>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
        </keys>
        <notes>Notes</notes>
    </info>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>Another StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>42</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>Another StringValue</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</document>

Document (Version 4)

GET/v4/document/{id} Gets the document information from the server that matches the ID.

Expand Operation / Collapse Operation

Gets the document information from the server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkedOutUserInfo type

Contains checkout user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who has the document checked out
userName String Yes The name of the user who has the document checked out
document type

Represents a document object

Field Name Data Type Expected Description
info info Yes Information about the document
pages List of page [page] Yes Information about the pages in the document
properties List of propertyInstance [property] Yes Custom property information about the document
versionInfo versionInfo Yes Information about the document's version
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow Item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
documentTypeId String Yes The ID of the document type.
drawer String Yes The name of the drawer.
drawerId String Yes The ID of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
id String Yes The document's ID
keys documentKeys Yes The document's set of keys
locationId String Yes The document's location
name String Yes The document's name
notes String Yes The document's notes
versionStatus versionControlStatus Yes The document's version control status
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
label String Yes The page's label
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
elementId String No The element ID identifies the occurance of the composite property. This field is only set when the returned property is an array or composite.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
versionControlStatus type

Represents the version control status of the document.

Field Name Data Type Expected Description
checkedOutUserInfo checkedOutUserInfo Yes The user who has the document checked out
isCheckedOut boolean Yes Whether or not the document is checked out by a user
isVersioned boolean Yes Whether or not the document is in version control
versionInfo type

Contains version information for the requested document.

Field Name Data Type Expected Description
isProvisional boolean Yes Whether or not the document version is provisional
versionId String Yes The version ID of the document.
versionNumber Integer Yes The version number of the document.
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v4/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber parameter included
Request URL
/v4/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v4/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006"},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v4/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 2 - versionNumber parameter included
Request URL
/v4/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 3 - queueId parameter included
Request URL
/v4/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>

Document (Version 5)

GET/v5/document/{id} Gets the document information from the server that matches the ID. This call now returns creation...

Expand Operation / Collapse Operation

Gets the document information from the server that matches the ID. This call now returns creation and modification user information.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkedOutUserInfo type

Contains checkout user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who has the document checked out
userName String Yes The name of the user who has the document checked out
document type

Represents a document object

Field Name Data Type Expected Description
info info Yes Information about the document
pages List of page [page] Yes Information about the pages in the document
properties List of propertyInstance [property] Yes Custom property information about the document
versionInfo versionInfo Yes Information about the document's version
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
documentTypeId String Yes The ID of the document type.
drawer String Yes The name of the drawer.
drawerId String Yes The ID of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
creationUserInfo userInfo Yes The information about the user who created the document.
id String Yes The document's ID.
keys documentKeys Yes The document's set of keys.
locationId String Yes The document's location.
modificationUserInfo userInfo Yes The information about the user who last modified the document.
name String Yes The document's name.
notes String Yes The document's notes.
versionStatus versionControlStatus Yes The document's version control status.
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
label String Yes The page's label
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
elementId String No The element ID identifies the occurance of the composite property. This field is only set when the returned property is an array or composite.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
userInfo type

Information for a user associated with a document event.

Field Name Data Type Expected Description
time Long Yes The time associated with the user's action.
userId String Yes The user's ID.
userName String Yes The user's name.
versionControlStatus type

Represents the version control status of the document.

Field Name Data Type Expected Description
checkedOutUserInfo checkedOutUserInfo Yes The user who has the document checked out
isCheckedOut boolean Yes Whether or not the document is checked out by a user
isVersioned boolean Yes Whether or not the document is in version control
versionInfo type

Contains version information for the requested document.

Field Name Data Type Expected Description
isProvisional boolean Yes Whether or not the document version is provisional
versionId String Yes The version ID of the document.
versionNumber Integer Yes The version number of the document.
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v5/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber parameter included
Request URL
/v5/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v5/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321YZ92_00074LN21000002","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v5/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 2 - versionNumber parameter included
Request URL
/v5/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 3 - queueId parameter included
Request URL
/v5/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321YZ92_00074LN21000002</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>

Document (Version 6)

GET/v6/document/{id} Gets the document information from the server that matches the ID. This call now returns element ...

Expand Operation / Collapse Operation

Gets the document information from the server that matches the ID. This call now returns element id in the child custom properties.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document
queueId Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkedOutUserInfo type

Contains checkout user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who has the document checked out
userName String Yes The name of the user who has the document checked out
document type

Represents a document object

Field Name Data Type Expected Description
info info Yes Information about the document
pages List of page [page] Yes Information about the pages in the document
properties List of propertyInstance [property] Yes Custom property information about the document
versionInfo versionInfo Yes Information about the document's version
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
documentTypeId String Yes The ID of the document type.
drawer String Yes The name of the drawer.
drawerId String Yes The ID of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
creationUserInfo userInfo Yes The information about the user who created the document.
id String Yes The document's ID.
keys documentKeys Yes The document's set of keys.
locationId String Yes The document's location.
modificationUserInfo userInfo Yes The information about the user who last modified the document.
name String Yes The document's name.
notes String Yes The document's notes.
versionStatus versionControlStatus Yes The document's version control status.
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
label String Yes The page's label
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values for child properties. The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
userInfo type

Information for a user associated with a document event.

Field Name Data Type Expected Description
time Long Yes The time associated with the user's action.
userId String Yes The user's ID.
userName String Yes The user's name.
versionControlStatus type

Represents the version control status of the document.

Field Name Data Type Expected Description
checkedOutUserInfo checkedOutUserInfo Yes The user who has the document checked out
isCheckedOut boolean Yes Whether or not the document is checked out by a user
isVersioned boolean Yes Whether or not the document is in version control
versionInfo type

Contains version information for the requested document.

Field Name Data Type Expected Description
isProvisional boolean Yes Whether or not the document version is provisional
versionId String Yes The version ID of the document.
versionNumber Integer Yes The version number of the document.
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v6/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber parameter included
Request URL
/v6/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v6/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v6/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 2 - versionNumber parameter included
Request URL
/v6/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>
Sample 3 - queueId parameter included
Request URL
/v6/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
</document>

PATCH/v6/document/{id} Updates the document properties and custom properties. This call now only updates properties prov...

Expand Operation / Collapse Operation

Updates the document properties and custom properties. This call now only updates properties provided in this call, including composite and array type custom properties.

Available from version: 1.0.0

Call Properties

Query Parameters
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's content privilege for the drawer that the document is in.
action actionType (default RETURN_CONFLICTS) (optional) The action to perform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content document
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Description
id String The unique ID of the conflicting item.
instanceType instanceType The type of the conflicting item.
document type

Object representing a document to be updated

Field Name Data Type Description
info info Document information
properties List of propertyInstance [property] Custom property information about the document
documentKeys type

Document keys that can be updated via a patch

Field Name Data Type Description
documentTypeId String The ID of the document type.
field1 String The value of field1.
field2 String The value of field2.
field3 String The value of field3.
field4 String The value of field4.
field5 String The value of field5.
info type

Represents a collection of metadata about the document

Field Name Data Type Description
keys documentKeys The document's set of keys
locationId String The document's location ID. This can be a folder ID or drawer ID.
name String The document name
notes String The document's notes
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Description
elementId String The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String The property's ID
name String The property's name
type type The property's type
value String The property's value
propertyInstance type

Represents a server property instance to update

Field Name Data Type Description
childProperties List of propertyChildInstance [childProperty] If type is ARRAY or COMPOSITE, the values of the sub-properties
elementId String The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String The property's ID
name String The property's name
type type The property's type
updateAction propertyUpdateActionType The property's update action. Only used if the property type is ARRAY or COMPOSITE.
value String The property's value
propertyUpdateActionType enumeration

The action to perform on the array or composite property. UPDATE (default), CREATE or DELETE.

Constant Name Description
UPDATE Action that updates an existing property.
CREATE Action that creates a new property.
DELETE Action that deletes an existing property.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v6/document/321Z03B_0000N2ZCW00002D
Request
{"info":{"locationId":"321YZDH_00006LVBF00000N","name":"Document Name","keys":{"field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentTypeId":"321YYBW_00002GRFX00000W"},"notes":"Notes"},"properties":[{"id":"321YZDH_00006SVBF00000R","name":"Composite Property 1","elementId":"321Z077_0002LK30P000005","type":"COMPOSITE","value":null,"updateAction":"UPDATE","childProperties":[{"id":"321YZDH_000071VBF000007","name":"Number Type Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"321YZDH_00006SVBF00000L","name":null,"elementId":null,"type":"NUMBER","value":"15"}]},{"id":"321YZDH_000071VBF000007","name":"Date Property 1","elementId":null,"type":"DATE","value":"1057609769000","updateAction":null,"childProperties":null},{"id":"321YZDH_00006WVBF000017","name":"String Property 1","elementId":null,"type":"STRING","value":"String Test Value","updateAction":null,"childProperties":null},{"id":"321YZDH_00006WVBF000011","name":"Flag Property 1","elementId":null,"type":"FLAG","value":"1","updateAction":null,"childProperties":null}]}
Sample 2 - Only update field3
Request URL
/v6/document/321YZ2T_0002QMEK700003J
Request
{"info":{"locationId":"321YZDH_00006LVBF00000N","name":"Document Name","keys":{"field1":null,"field2":null,"field3":"Field3_Update","field4":null,"field5":null,"documentTypeId":"321YYBW_00002GRFX00000W"},"notes":"Notes"},"properties":[]}

XML Samples

Sample 1
Request URL
/v6/document/321Z03B_0000N2ZCW00002D
Request
<document>
    <info>
        <locationId>321YZDH_00006LVBF00000N</locationId>
        <name>Document Name</name>
        <keys>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentTypeId>321YYBW_00002GRFX00000W</documentTypeId>
        </keys>
        <notes>Notes</notes>
    </info>
    <properties>
        <property>
            <id>321YZDH_00006SVBF00000R</id>
            <name>Composite Property 1</name>
            <elementId>321Z077_0002LK30P000005</elementId>
            <type>COMPOSITE</type>
            <updateAction>UPDATE</updateAction>
            <childProperties>
                <childProperty>
                    <id>321YZDH_000071VBF000007</id>
                    <name>Number Type Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>321YZDH_00006SVBF00000L</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>321YZDH_000071VBF000007</id>
            <name>Date Property 1</name>
            <type>DATE</type>
            <value>1057609769000</value>
        </property>
        <property>
            <id>321YZDH_00006WVBF000017</id>
            <name>String Property 1</name>
            <type>STRING</type>
            <value>String Test Value</value>
        </property>
        <property>
            <id>321YZDH_00006WVBF000011</id>
            <name>Flag Property 1</name>
            <type>FLAG</type>
            <value>1</value>
        </property>
    </properties>
</document>
Sample 2 - Only update field3
Request URL
/v6/document/321YZ2T_0002QMEK700003J
Request
<document>
    <info>
        <locationId>321YZDH_00006LVBF00000N</locationId>
        <name>Document Name</name>
        <keys>
            <field3>Field3_Update</field3>
            <documentTypeId>321YYBW_00002GRFX00000W</documentTypeId>
        </keys>
        <notes>Notes</notes>
    </info>
    <properties/>
</document>

Document (Version 7)

GET/v7/document/{id} Gets the document information from the server that matches the ID. Includes privilege information...

Expand Operation / Collapse Operation

Gets the document information from the server that matches the ID. Includes privilege information. Succeeds if user has either the 'search' or 'open' privilege.

Available from version: 1.0.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document.
queueId Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkedOutUserInfo type

Contains checkout user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who has the document checked out
userName String Yes The name of the user who has the document checked out
document type

Represents a document object

Field Name Data Type Expected Description
info info Yes Information about the document
pages List of page [page] Yes Information about the pages in the document
privileges documentPrivileges Yes Information about the user's privileges on the document
properties List of propertyInstance [property] Yes Custom property information about the document
versionInfo versionInfo Yes Information about the document's version
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
documentTypeId String Yes The ID of the document type.
drawer String Yes The name of the drawer.
drawerId String Yes The ID of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
documentPrivileges type

Full set of document privileges

Field Name Data Type Expected Description
createOrAppend Boolean Yes Indicates the user can append pages to the document.
delete Boolean Yes Indicates the user can delete and restore the document.
deleteIfSigned Boolean Yes Indicates the user can delete and restore the document if it is digitally signed.
deletePage Boolean Yes Indicates the user can delete pages from the document.
deleteSignatureRepresentation Boolean Yes Indicates the user can delete visual representations of their signatures after the document is saved
deleteVersionControlHistory Boolean Yes Indicates the user can delete the version control history for the document.
exportFromGrid Boolean Yes Indicates the user can export the document from the explorer grid.
exportFromViewer Boolean Yes Indicates the user can export the document from the document viewer.
mailWebLinkFromGrid Boolean Yes Indicates the user can email a Perceptive Experience link or a WebNow link to the document from the explorer grid.
mailWebLinkFromViewer Boolean Yes Indicates the user can email a Perceptive Experience link or a WebNow link to the document from the document viewer.
merge Boolean Yes Indicates the user can merge the document with another document.
modifyCustomProperties Boolean Yes Indicates the user can modify custom property values on the document.
modifyDrawer Boolean Yes Indicates the user can move the document to another drawer.
modifyKeys Boolean Yes Indicates the user can modify the Field1 through Field5 document keys.
modifyNotes Boolean Yes Indicates the user can create, modify and delete notes on the document.
modifyPageLabel Boolean Yes Indicates the user can modify page labels.
modifyType Boolean Yes Indicates the user can modify the type of document.
moveInDrawer Boolean Yes Indicates the user can move the document within the current drawer.
movePage Boolean Yes Indicates the user can remove a page from the document and add it to another accessible document.
moveSignatureRepresentation Boolean Yes Indicates the user can move visual representations of their signatures after the document is saved.
overridePrivate Boolean Yes Indicates the user can change the status on a private document checked out through version control.
printFromGrid Boolean Yes Indicates the user can print the document from the explorer grid.
printFromViewer Boolean Yes Indicates the user can print the document from the document viewer.
removeFromVersionControl Boolean Yes Indicates the user can remove the document from version control.
rename Boolean Yes Indicates the user can change the name of the document.
reorderPage Boolean Yes Indicates the user can change the order of pages in the document.
sign Boolean Yes Indicates the user can digitally sign the document. A user must have this privilege to complete a signature required task type.
undoThirdPartyCheckOut Boolean Yes Indicates the user can reverse the document being checked out by another user.
useVersionControl Boolean Yes Indicates the user can add the document to version control, check a document in and out, view a document's history, undo a document's checkout, and get the latest version of the document in version control.
view Boolean Yes Indicates the user can open the document.
voidSignature Boolean Yes Indicates the user can void digital signatures for all users on the document.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
creationUserInfo userInfo Yes The information about the user who created the document.
id String Yes The document's ID.
keys documentKeys Yes The document's set of keys.
locationId String Yes The document's location.
modificationUserInfo userInfo Yes The information about the user who last modified the document.
name String Yes The document's name.
notes String Yes The document's notes.
versionStatus versionControlStatus Yes The document's version control status.
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
label String Yes The page's label
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values for child properties. The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
userInfo type

Information for a user associated with a document event.

Field Name Data Type Expected Description
time Long Yes The time associated with the user's action.
userId String Yes The user's ID.
userName String Yes The user's name.
versionControlStatus type

Represents the version control status of the document.

Field Name Data Type Expected Description
checkedOutUserInfo checkedOutUserInfo Yes The user who has the document checked out
isCheckedOut boolean Yes Whether or not the document is checked out by a user
isVersioned boolean Yes Whether or not the document is in version control
versionInfo type

Contains version information for the requested document.

Field Name Data Type Expected Description
isProvisional boolean Yes Whether or not the document version is provisional
versionId String Yes The version ID of the document.
versionNumber Integer Yes The version number of the document.
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v7/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"privileges":{"modifyKeys":false,"delete":true,"deletePage":false,"reorderPage":false,"merge":false,"modifyNotes":false,"sign":false,"voidSignature":false,"useVersionControl":false,"removeFromVersionControl":false,"deleteVersionControlHistory":false,"undoThirdPartyCheckOut":false,"modifyCustomProperties":false,"view":false,"deleteIfSigned":false,"printFromViewer":false,"mailWebLinkFromViewer":false,"exportFromViewer":false,"exportFromGrid":true,"printFromGrid":false,"mailWebLinkFromGrid":false,"createOrAppend":true,"moveSignatureRepresentation":false,"deleteSignatureRepresentation":false,"overridePrivate":false,"movePage":false,"moveInDrawer":false,"rename":false,"modifyDrawer":false,"modifyType":false,"modifyPageLabel":false},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber parameter included
Request URL
/v7/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"privileges":{"modifyKeys":false,"delete":true,"deletePage":false,"reorderPage":false,"merge":false,"modifyNotes":false,"sign":false,"voidSignature":false,"useVersionControl":false,"removeFromVersionControl":false,"deleteVersionControlHistory":false,"undoThirdPartyCheckOut":false,"modifyCustomProperties":false,"view":false,"deleteIfSigned":false,"printFromViewer":false,"mailWebLinkFromViewer":false,"exportFromViewer":false,"exportFromGrid":true,"printFromGrid":false,"mailWebLinkFromGrid":false,"createOrAppend":true,"moveSignatureRepresentation":false,"deleteSignatureRepresentation":false,"overridePrivate":false,"movePage":false,"moveInDrawer":false,"rename":false,"modifyDrawer":false,"modifyType":false,"modifyPageLabel":false},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v7/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"privileges":{"modifyKeys":false,"delete":true,"deletePage":false,"reorderPage":false,"merge":false,"modifyNotes":false,"sign":false,"voidSignature":false,"useVersionControl":false,"removeFromVersionControl":false,"deleteVersionControlHistory":false,"undoThirdPartyCheckOut":false,"modifyCustomProperties":false,"view":false,"deleteIfSigned":false,"printFromViewer":false,"mailWebLinkFromViewer":false,"exportFromViewer":false,"exportFromGrid":true,"printFromGrid":false,"mailWebLinkFromGrid":false,"createOrAppend":true,"moveSignatureRepresentation":false,"deleteSignatureRepresentation":false,"overridePrivate":false,"movePage":false,"moveInDrawer":false,"rename":false,"modifyDrawer":false,"modifyType":false,"modifyPageLabel":false},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v7/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
    <privileges>
        <modifyKeys>false</modifyKeys>
        <delete>true</delete>
        <deletePage>false</deletePage>
        <reorderPage>false</reorderPage>
        <merge>false</merge>
        <modifyNotes>false</modifyNotes>
        <sign>false</sign>
        <voidSignature>false</voidSignature>
        <useVersionControl>false</useVersionControl>
        <removeFromVersionControl>false</removeFromVersionControl>
        <deleteVersionControlHistory>false</deleteVersionControlHistory>
        <undoThirdPartyCheckOut>false</undoThirdPartyCheckOut>
        <modifyCustomProperties>false</modifyCustomProperties>
        <view>false</view>
        <deleteIfSigned>false</deleteIfSigned>
        <printFromViewer>false</printFromViewer>
        <mailWebLinkFromViewer>false</mailWebLinkFromViewer>
        <exportFromViewer>false</exportFromViewer>
        <exportFromGrid>true</exportFromGrid>
        <printFromGrid>false</printFromGrid>
        <mailWebLinkFromGrid>false</mailWebLinkFromGrid>
        <createOrAppend>true</createOrAppend>
        <moveSignatureRepresentation>false</moveSignatureRepresentation>
        <deleteSignatureRepresentation>false</deleteSignatureRepresentation>
        <overridePrivate>false</overridePrivate>
        <movePage>false</movePage>
        <moveInDrawer>false</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>false</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyPageLabel>false</modifyPageLabel>
    </privileges>
</document>
Sample 2 - versionNumber parameter included
Request URL
/v7/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
    <privileges>
        <modifyKeys>false</modifyKeys>
        <delete>true</delete>
        <deletePage>false</deletePage>
        <reorderPage>false</reorderPage>
        <merge>false</merge>
        <modifyNotes>false</modifyNotes>
        <sign>false</sign>
        <voidSignature>false</voidSignature>
        <useVersionControl>false</useVersionControl>
        <removeFromVersionControl>false</removeFromVersionControl>
        <deleteVersionControlHistory>false</deleteVersionControlHistory>
        <undoThirdPartyCheckOut>false</undoThirdPartyCheckOut>
        <modifyCustomProperties>false</modifyCustomProperties>
        <view>false</view>
        <deleteIfSigned>false</deleteIfSigned>
        <printFromViewer>false</printFromViewer>
        <mailWebLinkFromViewer>false</mailWebLinkFromViewer>
        <exportFromViewer>false</exportFromViewer>
        <exportFromGrid>true</exportFromGrid>
        <printFromGrid>false</printFromGrid>
        <mailWebLinkFromGrid>false</mailWebLinkFromGrid>
        <createOrAppend>true</createOrAppend>
        <moveSignatureRepresentation>false</moveSignatureRepresentation>
        <deleteSignatureRepresentation>false</deleteSignatureRepresentation>
        <overridePrivate>false</overridePrivate>
        <movePage>false</movePage>
        <moveInDrawer>false</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>false</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyPageLabel>false</modifyPageLabel>
    </privileges>
</document>
Sample 3 - queueId parameter included
Request URL
/v7/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
    <privileges>
        <modifyKeys>false</modifyKeys>
        <delete>true</delete>
        <deletePage>false</deletePage>
        <reorderPage>false</reorderPage>
        <merge>false</merge>
        <modifyNotes>false</modifyNotes>
        <sign>false</sign>
        <voidSignature>false</voidSignature>
        <useVersionControl>false</useVersionControl>
        <removeFromVersionControl>false</removeFromVersionControl>
        <deleteVersionControlHistory>false</deleteVersionControlHistory>
        <undoThirdPartyCheckOut>false</undoThirdPartyCheckOut>
        <modifyCustomProperties>false</modifyCustomProperties>
        <view>false</view>
        <deleteIfSigned>false</deleteIfSigned>
        <printFromViewer>false</printFromViewer>
        <mailWebLinkFromViewer>false</mailWebLinkFromViewer>
        <exportFromViewer>false</exportFromViewer>
        <exportFromGrid>true</exportFromGrid>
        <printFromGrid>false</printFromGrid>
        <mailWebLinkFromGrid>false</mailWebLinkFromGrid>
        <createOrAppend>true</createOrAppend>
        <moveSignatureRepresentation>false</moveSignatureRepresentation>
        <deleteSignatureRepresentation>false</deleteSignatureRepresentation>
        <overridePrivate>false</overridePrivate>
        <movePage>false</movePage>
        <moveInDrawer>false</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>false</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyPageLabel>false</modifyPageLabel>
    </privileges>
</document>

Document (Version 8)

GET/v8/document/{id} Gets the document information from the server that matches the ID. Includes 'Send to ShareBase' p...

Expand Operation / Collapse Operation

Gets the document information from the server that matches the ID. Includes 'Send to ShareBase' privilege information.

Available from version: 6.1.0

Call Properties

Query Parameters
versionNumber (optional) Version number of the document.
queueId Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

checkedOutUserInfo type

Contains checkout user information.

Field Name Data Type Expected Description
userId String Yes The id of the user who has the document checked out
userName String Yes The name of the user who has the document checked out
document type

Represents a document object

Field Name Data Type Expected Description
info info Yes Information about the document
pages List of page [page] Yes Information about the pages in the document
privileges documentPrivileges Yes Information about the user's privileges on the document
properties List of propertyInstance [property] Yes Custom property information about the document
versionInfo versionInfo Yes Information about the document's version
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow item IDs for the document
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
documentTypeId String Yes The ID of the document type.
drawer String Yes The name of the drawer.
drawerId String Yes The ID of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
documentPrivileges type

Full set of document privileges

Field Name Data Type Expected Description
createOrAppend Boolean Yes Indicates the user can append pages to the document.
delete Boolean Yes Indicates the user can delete and restore the document.
deleteIfSigned Boolean Yes Indicates the user can delete and restore the document if it is digitally signed.
deletePage Boolean Yes Indicates the user can delete pages from the document.
deleteSignatureRepresentation Boolean Yes Indicates the user can delete visual representations of their signatures after the document is saved
deleteVersionControlHistory Boolean Yes Indicates the user can delete the version control history for the document.
exportFromGrid Boolean Yes Indicates the user can export the document from the explorer grid.
exportFromViewer Boolean Yes Indicates the user can export the document from the document viewer.
mailWebLinkFromGrid Boolean Yes Indicates the user can email a Perceptive Experience link or a WebNow link to the document from the explorer grid.
mailWebLinkFromViewer Boolean Yes Indicates the user can email a Perceptive Experience link or a WebNow link to the document from the document viewer.
merge Boolean Yes Indicates the user can merge the document with another document.
modifyCustomProperties Boolean Yes Indicates the user can modify custom property values on the document.
modifyDrawer Boolean Yes Indicates the user can move the document to another drawer.
modifyKeys Boolean Yes Indicates the user can modify the Field1 through Field5 document keys.
modifyNotes Boolean Yes Indicates the user can create, modify and delete notes on the document.
modifyPageLabel Boolean Yes Indicates the user can modify page labels.
modifyType Boolean Yes Indicates the user can modify the type of document.
moveInDrawer Boolean Yes Indicates the user can move the document within the current drawer.
movePage Boolean Yes Indicates the user can remove a page from the document and add it to another accessible document.
moveSignatureRepresentation Boolean Yes Indicates the user can move visual representations of their signatures after the document is saved.
overridePrivate Boolean Yes Indicates the user can change the status on a private document checked out through version control.
printFromGrid Boolean Yes Indicates the user can print the document from the explorer grid.
printFromViewer Boolean Yes Indicates the user can print the document from the document viewer.
removeFromVersionControl Boolean Yes Indicates the user can remove the document from version control.
rename Boolean Yes Indicates the user can change the name of the document.
reorderPage Boolean Yes Indicates the user can change the order of pages in the document.
sendToShareBaseFromGrid Boolean Yes Indicates the user can send the document to ShareBase from the explorer grid.
sendToShareBaseFromViewer Boolean Yes Indicates the user can send the document to ShareBase from the document viewer.
sign Boolean Yes Indicates the user can digitally sign the document. A user must have this privilege to complete a signature required task type.
undoThirdPartyCheckOut Boolean Yes Indicates the user can reverse the document being checked out by another user.
useVersionControl Boolean Yes Indicates the user can add the document to version control, check a document in and out, view a document's history, undo a document's checkout, and get the latest version of the document in version control.
view Boolean Yes Indicates the user can open the document.
voidSignature Boolean Yes Indicates the user can void digital signatures for all users on the document.
info type

Represents a collection of metadata about the document

Field Name Data Type Expected Description
creationUserInfo userInfo Yes The information about the user who created the document.
id String Yes The document's ID.
keys documentKeys Yes The document's set of keys.
locationId String Yes The document's location.
modificationUserInfo userInfo Yes The information about the user who last modified the document.
name String Yes The document's name.
notes String Yes The document's notes.
versionStatus versionControlStatus Yes The document's version control status.
page type

Represents information about a document page

Field Name Data Type Expected Description
extension String Yes The page's file extension
id String Yes The page's id
label String Yes The page's label
name String Yes The page's name
pageNumber Integer Yes The page's sequence number
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values for child properties. The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
userInfo type

Information for a user associated with a document event.

Field Name Data Type Expected Description
time Long Yes The time associated with the user's action.
userId String Yes The user's ID.
userName String Yes The user's name.
versionControlStatus type

Represents the version control status of the document.

Field Name Data Type Expected Description
checkedOutUserInfo checkedOutUserInfo Yes The user who has the document checked out
isCheckedOut boolean Yes Whether or not the document is checked out by a user
isVersioned boolean Yes Whether or not the document is in version control
versionInfo type

Contains version information for the requested document.

Field Name Data Type Expected Description
isProvisional boolean Yes Whether or not the document version is provisional
versionId String Yes The version ID of the document.
versionNumber Integer Yes The version number of the document.
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v8/document/301YW1E_00077ZVD900003H
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"privileges":{"modifyKeys":false,"delete":true,"deletePage":false,"reorderPage":false,"merge":false,"modifyNotes":false,"sign":false,"voidSignature":false,"useVersionControl":false,"removeFromVersionControl":false,"deleteVersionControlHistory":false,"undoThirdPartyCheckOut":false,"modifyCustomProperties":false,"view":false,"deleteIfSigned":false,"printFromViewer":false,"mailWebLinkFromViewer":false,"exportFromViewer":false,"sendToShareBaseFromViewer":true,"exportFromGrid":true,"printFromGrid":false,"mailWebLinkFromGrid":false,"sendToShareBaseFromGrid":false,"createOrAppend":true,"moveSignatureRepresentation":false,"deleteSignatureRepresentation":false,"overridePrivate":false,"movePage":false,"moveInDrawer":false,"rename":false,"modifyDrawer":false,"modifyType":false,"modifyPageLabel":false},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 2 - versionNumber parameter included
Request URL
/v8/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"privileges":{"modifyKeys":false,"delete":true,"deletePage":false,"reorderPage":false,"merge":false,"modifyNotes":false,"sign":false,"voidSignature":false,"useVersionControl":false,"removeFromVersionControl":false,"deleteVersionControlHistory":false,"undoThirdPartyCheckOut":false,"modifyCustomProperties":false,"view":false,"deleteIfSigned":false,"printFromViewer":false,"mailWebLinkFromViewer":false,"exportFromViewer":false,"sendToShareBaseFromViewer":true,"exportFromGrid":true,"printFromGrid":false,"mailWebLinkFromGrid":false,"sendToShareBaseFromGrid":false,"createOrAppend":true,"moveSignatureRepresentation":false,"deleteSignatureRepresentation":false,"overridePrivate":false,"movePage":false,"moveInDrawer":false,"rename":false,"modifyDrawer":false,"modifyType":false,"modifyPageLabel":false},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}
Sample 3 - queueId parameter included
Request URL
/v8/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
{"info":{"id":"301YW1E_00077ZVD900003H","name":"Document Name","keys":{"drawer":"Default","drawerId":"301YVCP_000294NLF000007","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default","documentTypeId":"301YVCP_000294NLF000004"},"notes":"The document's notes","versionStatus":{"isCheckedOut":true,"isVersioned":true,"checkedOutUserInfo":{"userId":"test007","userName":"JSmith"}},"locationId":"301YVCP_000294NLF000006","creationUserInfo":{"userId":"321Z046_000KQ93X1000010","userName":"JDoe","time":1448982440000},"modificationUserInfo":{"userId":"321Z046_000KQR3X1000009","userName":"JSmith","time":1448991140000}},"versionInfo":{"versionNumber":5,"versionId":"301REHR_0003RT6Y1000007","isProvisional":true},"privileges":{"modifyKeys":false,"delete":true,"deletePage":false,"reorderPage":false,"merge":false,"modifyNotes":false,"sign":false,"voidSignature":false,"useVersionControl":false,"removeFromVersionControl":false,"deleteVersionControlHistory":false,"undoThirdPartyCheckOut":false,"modifyCustomProperties":false,"view":false,"deleteIfSigned":false,"printFromViewer":false,"mailWebLinkFromViewer":false,"exportFromViewer":false,"sendToShareBaseFromViewer":true,"exportFromGrid":true,"printFromGrid":false,"mailWebLinkFromGrid":false,"sendToShareBaseFromGrid":false,"createOrAppend":true,"moveSignatureRepresentation":false,"deleteSignatureRepresentation":false,"overridePrivate":false,"movePage":false,"moveInDrawer":false,"rename":false,"modifyDrawer":false,"modifyType":false,"modifyPageLabel":false},"workflowItems":[{"id":"321YW4H_0001X241L00000M"}],"pages":[{"id":"301YVD7_0002ZL50K000005","name":"SampleFile.txt","label":"SampleDocumentLabel","extension":"txt","pageNumber":1},{"id":"301YVD9_000303045000001","name":"SampleDocument.doc","label":null,"extension":"doc","pageNumber":1}],"properties":[{"id":"307ERHD_0003RW4Y1000001","name":"Composite Property","elementId":"321YZ8Z_0007007PD000004","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000001","name":"Child Property 1","elementId":null,"type":"STRING","value":"StringValue"},{"id":"304RHEF_0003RW4Y1000001","name":"Child Property 2","elementId":null,"type":"NUMBER","value":"15"}]},{"id":"307ERHD_0003RW4Y1000001","name":"An Array Property","elementId":"321Z07P_000B43L33000005","type":"ARRAY","value":"","childProperties":[{"id":"302DFWX_0003RW4Y1000001","name":"A String","elementId":"321Z07K_0009S40PJ000007","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000001","name":"Another String","elementId":null,"type":"STRING","value":"StringValue2"}]},{"id":"301YVDX_0003RW4Y1000001","name":"Date Property","elementId":null,"type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","name":"Flag Property","elementId":null,"type":"FLAG","value":"0","childProperties":null},{"id":"307HKRP_0003RH5H1000001","name":"List Property","elementId":null,"type":"LIST","value":"Option1","childProperties":null},{"id":"309JRTG_0003RI2I1000001","name":"Group Property","elementId":null,"type":"USER_GROUP","value":"Group1","childProperties":null},{"id":"301REHR_0003RT6Y1000001","name":"User List","elementId":null,"type":"USER_LIST","value":"User1","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v8/document/301YW1E_00077ZVD900003H
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
    <privileges>
        <modifyKeys>false</modifyKeys>
        <delete>true</delete>
        <deletePage>false</deletePage>
        <reorderPage>false</reorderPage>
        <merge>false</merge>
        <modifyNotes>false</modifyNotes>
        <sign>false</sign>
        <voidSignature>false</voidSignature>
        <useVersionControl>false</useVersionControl>
        <removeFromVersionControl>false</removeFromVersionControl>
        <deleteVersionControlHistory>false</deleteVersionControlHistory>
        <undoThirdPartyCheckOut>false</undoThirdPartyCheckOut>
        <modifyCustomProperties>false</modifyCustomProperties>
        <view>false</view>
        <deleteIfSigned>false</deleteIfSigned>
        <printFromViewer>false</printFromViewer>
        <mailWebLinkFromViewer>false</mailWebLinkFromViewer>
        <exportFromViewer>false</exportFromViewer>
        <sendToShareBaseFromViewer>true</sendToShareBaseFromViewer>
        <exportFromGrid>true</exportFromGrid>
        <printFromGrid>false</printFromGrid>
        <mailWebLinkFromGrid>false</mailWebLinkFromGrid>
        <sendToShareBaseFromGrid>false</sendToShareBaseFromGrid>
        <createOrAppend>true</createOrAppend>
        <moveSignatureRepresentation>false</moveSignatureRepresentation>
        <deleteSignatureRepresentation>false</deleteSignatureRepresentation>
        <overridePrivate>false</overridePrivate>
        <movePage>false</movePage>
        <moveInDrawer>false</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>false</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyPageLabel>false</modifyPageLabel>
    </privileges>
</document>
Sample 2 - versionNumber parameter included
Request URL
/v8/document/301YW1E_00077ZVD900003H?versionNumber=5
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
    <privileges>
        <modifyKeys>false</modifyKeys>
        <delete>true</delete>
        <deletePage>false</deletePage>
        <reorderPage>false</reorderPage>
        <merge>false</merge>
        <modifyNotes>false</modifyNotes>
        <sign>false</sign>
        <voidSignature>false</voidSignature>
        <useVersionControl>false</useVersionControl>
        <removeFromVersionControl>false</removeFromVersionControl>
        <deleteVersionControlHistory>false</deleteVersionControlHistory>
        <undoThirdPartyCheckOut>false</undoThirdPartyCheckOut>
        <modifyCustomProperties>false</modifyCustomProperties>
        <view>false</view>
        <deleteIfSigned>false</deleteIfSigned>
        <printFromViewer>false</printFromViewer>
        <mailWebLinkFromViewer>false</mailWebLinkFromViewer>
        <exportFromViewer>false</exportFromViewer>
        <sendToShareBaseFromViewer>true</sendToShareBaseFromViewer>
        <exportFromGrid>true</exportFromGrid>
        <printFromGrid>false</printFromGrid>
        <mailWebLinkFromGrid>false</mailWebLinkFromGrid>
        <sendToShareBaseFromGrid>false</sendToShareBaseFromGrid>
        <createOrAppend>true</createOrAppend>
        <moveSignatureRepresentation>false</moveSignatureRepresentation>
        <deleteSignatureRepresentation>false</deleteSignatureRepresentation>
        <overridePrivate>false</overridePrivate>
        <movePage>false</movePage>
        <moveInDrawer>false</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>false</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyPageLabel>false</modifyPageLabel>
    </privileges>
</document>
Sample 3 - queueId parameter included
Request URL
/v8/document/301YW1E_00077ZVD900003H?queueId=321YZ46_000QEJ5XJ000021
Response
<document>
    <info>
        <id>301YW1E_00077ZVD900003H</id>
        <name>Document Name</name>
        <keys>
            <drawer>Default</drawer>
            <drawerId>301YVCP_000294NLF000007</drawerId>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
            <documentType>Default</documentType>
            <documentTypeId>301YVCP_000294NLF000004</documentTypeId>
        </keys>
        <notes>The document's notes</notes>
        <versionStatus>
            <isCheckedOut>true</isCheckedOut>
            <isVersioned>true</isVersioned>
            <checkedOutUserInfo>
                <userId>test007</userId>
                <userName>JSmith</userName>
            </checkedOutUserInfo>
        </versionStatus>
        <locationId>301YVCP_000294NLF000006</locationId>
        <creationUserInfo>
            <userId>321Z046_000KQ93X1000010</userId>
            <userName>JDoe</userName>
            <time>1448982440000</time>
        </creationUserInfo>
        <modificationUserInfo>
            <userId>321Z046_000KQR3X1000009</userId>
            <userName>JSmith</userName>
            <time>1448991140000</time>
        </modificationUserInfo>
    </info>
    <workflowItems>
        <workflowItem>
            <id>321YW4H_0001X241L00000M</id>
        </workflowItem>
    </workflowItems>
    <versionInfo>
        <versionNumber>5</versionNumber>
        <versionId>301REHR_0003RT6Y1000007</versionId>
        <isProvisional>true</isProvisional>
    </versionInfo>
    <pages>
        <page>
            <id>301YVD7_0002ZL50K000005</id>
            <name>SampleFile.txt</name>
            <label>SampleDocumentLabel</label>
            <extension>txt</extension>
            <pageNumber>1</pageNumber>
        </page>
        <page>
            <id>301YVD9_000303045000001</id>
            <name>SampleDocument.doc</name>
            <extension>doc</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
    <properties>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>Composite Property</name>
            <elementId>321YZ8Z_0007007PD000004</elementId>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Child Property 1</name>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>304RHEF_0003RW4Y1000001</id>
                    <name>Child Property 2</name>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>307ERHD_0003RW4Y1000001</id>
            <name>An Array Property</name>
            <elementId>321Z07P_000B43L33000005</elementId>
            <type>ARRAY</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>302DFWX_0003RW4Y1000001</id>
                    <name>A String</name>
                    <elementId>321Z07K_0009S40PJ000007</elementId>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000001</id>
                    <name>Another String</name>
                    <type>STRING</type>
                    <value>StringValue2</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <name>Date Property</name>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <name>Flag Property</name>
            <type>FLAG</type>
            <value>0</value>
        </property>
        <property>
            <id>307HKRP_0003RH5H1000001</id>
            <name>List Property</name>
            <type>LIST</type>
            <value>Option1</value>
        </property>
        <property>
            <id>309JRTG_0003RI2I1000001</id>
            <name>Group Property</name>
            <type>USER_GROUP</type>
            <value>Group1</value>
        </property>
        <property>
            <id>301REHR_0003RT6Y1000001</id>
            <name>User List</name>
            <type>USER_LIST</type>
            <value>User1</value>
        </property>
    </properties>
    <privileges>
        <modifyKeys>false</modifyKeys>
        <delete>true</delete>
        <deletePage>false</deletePage>
        <reorderPage>false</reorderPage>
        <merge>false</merge>
        <modifyNotes>false</modifyNotes>
        <sign>false</sign>
        <voidSignature>false</voidSignature>
        <useVersionControl>false</useVersionControl>
        <removeFromVersionControl>false</removeFromVersionControl>
        <deleteVersionControlHistory>false</deleteVersionControlHistory>
        <undoThirdPartyCheckOut>false</undoThirdPartyCheckOut>
        <modifyCustomProperties>false</modifyCustomProperties>
        <view>false</view>
        <deleteIfSigned>false</deleteIfSigned>
        <printFromViewer>false</printFromViewer>
        <mailWebLinkFromViewer>false</mailWebLinkFromViewer>
        <exportFromViewer>false</exportFromViewer>
        <sendToShareBaseFromViewer>true</sendToShareBaseFromViewer>
        <exportFromGrid>true</exportFromGrid>
        <printFromGrid>false</printFromGrid>
        <mailWebLinkFromGrid>false</mailWebLinkFromGrid>
        <sendToShareBaseFromGrid>false</sendToShareBaseFromGrid>
        <createOrAppend>true</createOrAppend>
        <moveSignatureRepresentation>false</moveSignatureRepresentation>
        <deleteSignatureRepresentation>false</deleteSignatureRepresentation>
        <overridePrivate>false</overridePrivate>
        <movePage>false</movePage>
        <moveInDrawer>false</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>false</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyPageLabel>false</modifyPageLabel>
    </privileges>
</document>

DocumentType (Version 1)

GET/v1/documentType Gets all document types stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets all document types stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
List of documentType [documentType]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

documentType type

Represents a document type.

Field Name Data Type Expected Description
description String Yes A description of the document type.
id String Yes The unique id of the document type.
name String Yes The name of the document type.

JSON Samples

Sample 1
Request URL
/v1/documentType
Response
{"documentTypes":[{"name":"Default","id":"1000184816_1738021400","description":"Default Document Type"},{"name":"Document Type","id":"301YW2J_00003B4TG000004","description":"System Test Document Type"},{"name":"Expense Report Document Type","id":"301YW2J_00000JJ4700002R","description":"2012 Expense Report Document Type"}]}

XML Samples

Sample 1
Request URL
/v1/documentType
Response
<documentTypes>
    <documentType>
        <name>Default</name>
        <id>1000184816_1738021400</id>
        <description>Default Document Type</description>
    </documentType>
    <documentType>
        <name>Document Type</name>
        <id>301YW2J_00003B4TG000004</id>
        <description>System Test Document Type</description>
    </documentType>
    <documentType>
        <name>Expense Report Document Type</name>
        <id>301YW2J_00000JJ4700002R</id>
        <description>2012 Expense Report Document Type</description>
    </documentType>
</documentTypes>

GET/v1/documentType/{id} Gets the document type stored in ImageNow Server that matches the ID.

Expand Operation / Collapse Operation

Gets the document type stored in ImageNow Server that matches the ID.

Available from version: 1.0.0

Call Properties

Response
Content
documentType
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
documentType type

Represents a document type

Field Name Data Type Expected Description
description String Yes A description of the document type.
formId String No The unique form id for an associated form.
id String Yes The unique id of the document type.
name String Yes The name of the document type.
properties List of typeProperty [property] Yes The custom properties associated with the document type.
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
typeProperty type

Represents an ImageNow Property

Field Name Data Type Expected Description
required boolean Yes Is this property required or not.
children List of childProperty [child] No Children's list for composite and array type, it only has property id and isRequired field.
defaultValue String No The default value for this property
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of String [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes Property type, it's an enum type.
userGroupId String No User group id for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.

JSON Samples

Sample 1
Request URL
/v1/documentType/301YW2J_00000JJ4700002R
Response
{"name":"Expense Report Document Type","id":"301YW2J_00000JJ4700002R","description":"2012 Expense Report Document Type","formId":null,"properties":[{"id":"301YW2J_00000HJ47000012","name":"List","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":null,"required":false,"listValueCandidates":["List Item 1","List Item 2","List Item 3"],"userList":null,"children":null,"formats":[]}]}

XML Samples

Sample 1
Request URL
/v1/documentType/301YW2J_00000JJ4700002R
Response
<documentType>
    <name>Expense Report Document Type</name>
    <id>301YW2J_00000JJ4700002R</id>
    <description>2012 Expense Report Document Type</description>
    <properties>
        <property>
            <id>301YW2J_00000HJ47000012</id>
            <name>List</name>
            <type>LIST</type>
            <listValueCandidates>
                <listValueCandidate>List Item 1</listValueCandidate>
                <listValueCandidate>List Item 2</listValueCandidate>
                <listValueCandidate>List Item 3</listValueCandidate>
            </listValueCandidates>
            <formats/>
            <required>false</required>
        </property>
    </properties>
</documentType>

DocumentType (Version 2)

GET/v2/documentType Gets all document types stored on the server.

Expand Operation / Collapse Operation

Gets all document types stored on the server.

Available from version: 4.7.0

Call Properties

Query Parameter
includeInactive (optional) Include inactive document types in the response. Default is false.
Response
Content
List of documentType [documentType]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

documentType type

Represents a document type.

Field Name Data Type Expected Description
description String Yes A description of the document type.
id String Yes The unique id of the document type.
isActive Boolean Yes The active status of the document type
name String Yes The name of the document type.

JSON Samples

Sample 1 - Retrieve all active document types.
Request URL
/v2/documentType
Response
{"documentTypes":[{"name":"Default","id":"1000184816_1738021400","description":"Default Document Type","isActive":true},{"name":"Document Type","id":"301YW2J_00003B4TG000004","description":"System Test Document Type","isActive":null},{"name":"Expense Report Document Type","id":"301YW2J_00000JJ4700002R","description":"2012 Expense Report Document Type","isActive":null}]}
Sample 2 - Retrieve all active and in-active document types using includeInactive query parameter.
Request URL
/v2/documentType?includeInactive=true
Response
{"documentTypes":[{"name":"Default","id":"1000184816_1738021400","description":"Default Document Type","isActive":false},{"name":"Document Type","id":"301YW2J_00003B4TG000004","description":"System Test Document Type","isActive":null},{"name":"Expense Report Document Type","id":"301YW2J_00000JJ4700002R","description":"2012 Expense Report Document Type","isActive":null},{"name":"Expense Report Document Type","id":"301YW2J_00000JJ4700002R","description":"2012 Expense Report Document Type","isActive":null}]}

XML Samples

Sample 1 - Retrieve all active document types.
Request URL
/v2/documentType
Response
<documentTypes>
    <documentType>
        <name>Default</name>
        <id>1000184816_1738021400</id>
        <description>Default Document Type</description>
        <isActive>true</isActive>
    </documentType>
    <documentType>
        <name>Document Type</name>
        <id>301YW2J_00003B4TG000004</id>
        <description>System Test Document Type</description>
    </documentType>
    <documentType>
        <name>Expense Report Document Type</name>
        <id>301YW2J_00000JJ4700002R</id>
        <description>2012 Expense Report Document Type</description>
    </documentType>
</documentTypes>
Sample 2 - Retrieve all active and in-active document types using includeInactive query parameter.
Request URL
/v2/documentType?includeInactive=true
Response
<documentTypes>
    <documentType>
        <name>Default</name>
        <id>1000184816_1738021400</id>
        <description>Default Document Type</description>
        <isActive>false</isActive>
    </documentType>
    <documentType>
        <name>Document Type</name>
        <id>301YW2J_00003B4TG000004</id>
        <description>System Test Document Type</description>
    </documentType>
    <documentType>
        <name>Expense Report Document Type</name>
        <id>301YW2J_00000JJ4700002R</id>
        <description>2012 Expense Report Document Type</description>
    </documentType>
    <documentType>
        <name>Expense Report Document Type</name>
        <id>301YW2J_00000JJ4700002R</id>
        <description>2012 Expense Report Document Type</description>
    </documentType>
</documentTypes>

DocumentTypeList (Version 1)

GET/v1/documentTypeList Gets all the doc type lists in ImageNow Server

Expand Operation / Collapse Operation

Gets all the doc type lists in ImageNow Server

Available from version: 1.0.0

Call Properties

Response
Content
List of documentTypeList [documentTypeList]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

documentTypeList type

Field Name Data Type Expected Description
description String Yes A description of the document type list.
id String Yes The unique id of the document type list.
name String Yes The name of the document type list.

JSON Samples

Sample 1
Request URL
/v1/documentTypeList
Response
{"documentTypeLists":[{"id":"301YW2M_00003SRGV000006","name":"Accounting Document Type List","description":"Document Type List for the Accounting Department"},{"id":"301YW2M_00000HJ4700001P","name":"Marketing Document Type List","description":"Document Type List for the Marketing Department"}]}

XML Samples

Sample 1
Request URL
/v1/documentTypeList
Response
<documentTypeLists>
    <documentTypeList>
        <id>301YW2M_00003SRGV000006</id>
        <name>Accounting Document Type List</name>
        <description>Document Type List for the Accounting Department</description>
    </documentTypeList>
    <documentTypeList>
        <id>301YW2M_00000HJ4700001P</id>
        <name>Marketing Document Type List</name>
        <description>Document Type List for the Marketing Department</description>
    </documentTypeList>
</documentTypeLists>

GET/v1/documentTypeList/{id} Gets the doc type list in ImageNow Server that matches the ID.

Expand Operation / Collapse Operation

Gets the doc type list in ImageNow Server that matches the ID.

Available from version: 1.0.0

Call Properties

Response
Content
documentTypeList
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

documentType type

Field Name Data Type Expected Description
id String Yes The unique id of the document type.
name String Yes The name of the document type.
documentTypeList type

Represents a document type list

Field Name Data Type Expected Description
description String Yes A description of the document type list.
documentTypes List of documentType [documentType] Yes The document types in the list.
id String Yes The unique id of the document type list.
name String Yes The name of the document type list.

JSON Samples

Sample 1
Request URL
/v1/documentTypeList/301YW2M_00000HJ4700001P
Response
{"id":"301YW2M_00000HJ4700001P","name":"Accounting Document Type List","description":"Document Type List for the Accounting department","documentTypes":[{"name":"Expense Report Document Type","id":"301YW2J_00000JJ4700002R"},{"name":"Travel Voucher Document Type","id":"301YW2J_00000JJ4700001G"}]}

XML Samples

Sample 1
Request URL
/v1/documentTypeList/301YW2M_00000HJ4700001P
Response
<documentTypeList>
    <id>301YW2M_00000HJ4700001P</id>
    <name>Accounting Document Type List</name>
    <description>Document Type List for the Accounting department</description>
    <documentTypes>
        <documentType>
            <name>Expense Report Document Type</name>
            <id>301YW2J_00000JJ4700002R</id>
        </documentType>
        <documentType>
            <name>Travel Voucher Document Type</name>
            <id>301YW2J_00000JJ4700001G</id>
        </documentType>
    </documentTypes>
</documentTypeList>

Drawer (Version 1)

GET/v1/drawer Gets all drawers stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets all drawers stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
List of drawer [drawer]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

drawer type

Represents a drawer

Field Name Data Type Expected Description
id String Yes The unique ID of the drawer
name String Yes The name of the drawer.

JSON Samples

Sample 1
Request URL
/v1/drawer
Response
{"drawers":[{"name":"Default","id":"1013184795_6887711448"},{"name":"Folders","id":"1000184723_1734091423"}]}

XML Samples

Sample 1
Request URL
/v1/drawer
Response
<drawers>
    <drawer>
        <name>Default</name>
        <id>1013184795_6887711448</id>
    </drawer>
    <drawer>
        <name>Folders</name>
        <id>1000184723_1734091423</id>
    </drawer>
</drawers>

GET/v1/drawer/{id} Gets one drawer stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets one drawer stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
drawer
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

document type

Represents a document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
name String Yes The document's name
targetId String No If a shortcut, the unique id of the target document.
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
drawer type

Represents a drawer

Field Name Data Type Expected Description
containedDocuments List of document [document] No The documents contained within this drawer. Does not include documents in contained folders.
containedFolders List of folder [folder] No The folders contained within this drawer.
id String Yes The unique ID of the drawer
name String Yes The name of the drawer.
folder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
name String Yes The name of the folder.
targetId String No If a shortcut, the unique id of the target folder.
typeId String Yes The type id of the folder.

JSON Samples

Sample 1
Request URL
/v1/drawer/1013184795_6887711448
Response
{"name":"Default","id":"1013184795_6887711448","containedFolders":[{"name":"Regular Folder","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006"},{"name":"Other Folder","id":"301YVDD_00005MTV200000J","targetId":null,"typeId":"301YVDD_00005ETV2000006"}],"containedDocuments":[{"id":"301YW1D_00023XZPQ000035","targetId":null,"name":"Document 1","keys":{"drawer":"Default","field1":"f1","field2":"f2","field3":"f3","field4":"f4","field5":"f5","documentType":"Default"}},{"id":"301YW1D_00023XZPQ000039","targetId":null,"name":"Document 2","keys":{"drawer":"Default","field1":"f1-2","field2":"f2-2","field3":"f3-2","field4":"f4-2","field5":"f5-2","documentType":"Default"}}]}

XML Samples

Sample 1
Request URL
/v1/drawer/1013184795_6887711448
Response
<drawer>
    <name>Default</name>
    <id>1013184795_6887711448</id>
    <containedFolders>
        <folder>
            <name>Regular Folder</name>
            <id>301YVDD_00005MTV200000H</id>
            <typeId>301YVDD_00005ETV2000006</typeId>
        </folder>
        <folder>
            <name>Other Folder</name>
            <id>301YVDD_00005MTV200000J</id>
            <typeId>301YVDD_00005ETV2000006</typeId>
        </folder>
    </containedFolders>
    <containedDocuments>
        <document>
            <id>301YW1D_00023XZPQ000035</id>
            <name>Document 1</name>
            <keys>
                <drawer>Default</drawer>
                <field1>f1</field1>
                <field2>f2</field2>
                <field3>f3</field3>
                <field4>f4</field4>
                <field5>f5</field5>
                <documentType>Default</documentType>
            </keys>
        </document>
        <document>
            <id>301YW1D_00023XZPQ000039</id>
            <name>Document 2</name>
            <keys>
                <drawer>Default</drawer>
                <field1>f1-2</field1>
                <field2>f2-2</field2>
                <field3>f3-2</field3>
                <field4>f4-2</field4>
                <field5>f5-2</field5>
                <documentType>Default</documentType>
            </keys>
        </document>
    </containedDocuments>
</drawer>

POST/v1/drawer/{id}/content This API operation moves a set of existing ImageNow documents, folders, and shortcuts to a drawer...

Expand Operation / Collapse Operation

This API operation moves a set of existing ImageNow documents, folders, and shortcuts to a drawer. The items you are moving can reside anywhere in the ImageNow system and can exist in multiple locations, since you specify the items by their unique ID. The drawerContentItem data type provides the necessary information for ImageNow Server to successfully move the item, such as the type of the item (instanceType) and the unique ID of the document, folder, or shortcut.

Available from version: 1.0.0

Example 1 in the following table shows a request to move items and a response indicating a naming conflict. Example 2 shows a request to use APPEND to append the document with the naming conflict to the existing document.

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The request contains the list of items to move along with an action parameter. The action parameter is an enumeration.
Request
Content List of drawerContentItem [item]
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
List of drawerConflict [drawerConflict] (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS This is the default action, which returns a response code of 200 if the move was successful, or a response code of 409 if the move failed along with a list of conflicting items. If you try to move an item of the same type and same name of an existing item, such as moving a document with the name JuneExpenseReport into a drawer that already has a document with the name JuneExpenseReport, Integration Server reports this as a conflicting item. The list of conflicting items provides identifying information for the existing item in the drawer along and for the item you are trying to move.
APPEND Use APPEND for conflict resolution. This allows you to append a document to an existing document in the drawer. When the document appends, it takes on the custom property values and workflow properties of the target document.
REPLACE Use REPLACE for conflict resolution. This allows you to replace an existing document in a drawer with a document you are moving.
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
drawerConflict type

Contains two items; the item that tried to move, and the conflicting item.

Field Name Data Type Expected Description
conflictingItem conflictItem Yes The conflicting item.
item conflictItem Yes The item that tried to move.
drawerContentItem type

A document, folder, or shortcut contained in a drawer.

Field Name Data Type Expected Description
id String Yes The unique ID of the item.
instanceType instanceType Yes The type of item.
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.

JSON Samples

Sample 1 - Request to move with a response indicating a naming conflict
Request URL
/v1/drawer/1013184795_6887711448/content
Request
{"drawerContents":[{"instanceType":"DOCUMENT","id":"301YW1D_000251ZDM000021"},{"instanceType":"FOLDER","id":"301YW1D_000250ZDM00002D"}]}
Response
{"drawerConflicts":[{"item":{"instanceType":"DOCUMENT","id":"301YW1D_000251ZDM000021"},"conflictingItem":{"instanceType":"DOCUMENT","id":"301YW1B_00018DYSX000001"}}]}
Sample 2 - Request to append the document with the naming conflict to the existing document!
Request URL
/v1/drawer/1013184795_6887711448/content?action=APPEND
Request
{"drawerContents":[{"instanceType":"DOCUMENT","id":"301YW1D_000251ZDM000021"},{"instanceType":"FOLDER","id":"301YW1D_000250ZDM00002D"}]}

XML Samples

Sample 1 - Request to move with a response indicating a naming conflict
Request URL
/v1/drawer/1013184795_6887711448/content
Request
<drawerContents>
    <item>
        <instanceType>DOCUMENT</instanceType>
        <id>301YW1D_000251ZDM000021</id>
    </item>
    <item>
        <instanceType>FOLDER</instanceType>
        <id>301YW1D_000250ZDM00002D</id>
    </item>
</drawerContents>
Response
<drawerConflicts>
    <drawerConflict>
        <item>
            <instanceType>DOCUMENT</instanceType>
            <id>301YW1D_000251ZDM000021</id>
        </item>
        <conflictingItem>
            <instanceType>DOCUMENT</instanceType>
            <id>301YW1B_00018DYSX000001</id>
        </conflictingItem>
    </drawerConflict>
</drawerConflicts>
Sample 2 - Request to append the document with the naming conflict to the existing document!
Request URL
/v1/drawer/1013184795_6887711448/content?action=APPEND
Request
<drawerContents>
    <item>
        <instanceType>DOCUMENT</instanceType>
        <id>301YW1D_000251ZDM000021</id>
    </item>
    <item>
        <instanceType>FOLDER</instanceType>
        <id>301YW1D_000250ZDM00002D</id>
    </item>
</drawerContents>

Drawer (Version 2)

GET/v2/drawer Gets all drawers stored in ImageNow Server that the user has some privilege to.

Expand Operation / Collapse Operation

Gets all drawers stored in ImageNow Server that the user has some privilege to.

Available from version: 1.0.0

Call Properties

Response
Content
List of drawer [drawer]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

drawer type

Represents a drawer

Field Name Data Type Expected Description
canCreateContent boolean Yes Tells if the user making the request has create privileges for this drawer
canCreateContentShortcut boolean Yes Tells if the user making the request has create shortcut privileges for this drawer
canMoveContent boolean Yes Tells if the user making the request has move privileges for this drawer
canSearchContent boolean Yes Tells if the user making the request has search privileges for this drawer
description String Yes The description of the drawer
id String Yes The unique ID of the drawer
name String Yes The name of the drawer.

JSON Samples

Sample 1
Request URL
/v2/drawer
Response
{"drawers":[{"name":"Default","id":"1013184795_6887711448","description":"Default drawer description","canSearchContent":true,"canCreateContent":false,"canCreateContentShortcut":false,"canMoveContent":false},{"name":"Folders","id":"1000184723_1734091423","description":"Folders drawer description","canSearchContent":false,"canCreateContent":true,"canCreateContentShortcut":true,"canMoveContent":false}]}

XML Samples

Sample 1
Request URL
/v2/drawer
Response
<drawers>
    <drawer>
        <name>Default</name>
        <id>1013184795_6887711448</id>
        <description>Default drawer description</description>
        <canSearchContent>true</canSearchContent>
        <canCreateContent>false</canCreateContent>
        <canCreateContentShortcut>false</canCreateContentShortcut>
        <canMoveContent>false</canMoveContent>
    </drawer>
    <drawer>
        <name>Folders</name>
        <id>1000184723_1734091423</id>
        <description>Folders drawer description</description>
        <canSearchContent>false</canSearchContent>
        <canCreateContent>true</canCreateContent>
        <canCreateContentShortcut>true</canCreateContentShortcut>
        <canMoveContent>false</canMoveContent>
    </drawer>
</drawers>

GET/v2/drawer/{id} Gets one drawer stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets one drawer stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
drawer
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

drawer type

Represents a drawer

Field Name Data Type Expected Description
canCreateContent boolean Yes Tells if the user making the request has create privileges for this drawer
canCreateContentShortcut boolean Yes Tells if the user making the request has create shortcut privileges for this drawer
canMoveContent boolean Yes Tells if the user making the request has move privileges for this drawer
canSearchContent boolean Yes Tells if the user making the request has create privileges for this drawer
description String Yes The description of the drawer
id String Yes The unique ID of the drawer
name String Yes The name of the drawer.

JSON Samples

Sample 1
Request URL
/v2/drawer/1013184795_6887711448
Response
{"name":"Default","id":"1013184795_6887711448","description":"Default drawer description","canSearchContent":true,"canCreateContent":false,"canCreateContentShortcut":false,"canMoveContent":false}

XML Samples

Sample 1
Request URL
/v2/drawer/1013184795_6887711448
Response
<drawer>
    <name>Default</name>
    <id>1013184795_6887711448</id>
    <description>Default drawer description</description>
    <canSearchContent>true</canSearchContent>
    <canCreateContent>false</canCreateContent>
    <canCreateContentShortcut>false</canCreateContentShortcut>
    <canMoveContent>false</canMoveContent>
</drawer>

GET/v2/drawer/{id}/content Get the folders and documents contained in the drawer.

Expand Operation / Collapse Operation

Get the folders and documents contained in the drawer.

Available from version: 1.0.0

Call Properties

Response
Content
drawerContents
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

document type

Represents a document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
name String Yes The document's name
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
drawerContents type

Represents the folders and documents contained in a drawer

Field Name Data Type Expected Description
containedDocuments List of document [document] No The documents contained within this drawer. Does not include documents in contained folders.
containedFolders List of folder [folder] No The folders contained within this drawer.
folder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
name String Yes The name of the folder.
typeId String Yes The type id of the folder.

JSON Samples

Sample 1
Request URL
/v2/drawer/1013184785_688771148/content
Response
{"containedFolders":[{"name":"Regular Folder","id":"301YVDD_00005MTV200000H","typeId":"301YVDD_00005ETV2000006"},{"name":"Other Folder","id":"301YVDD_00005MTV200000J","typeId":"301YVDD_00005ETV2000006"}],"containedDocuments":[{"id":"301YW1D_00023XZPQ000035","name":"Document 1","keys":{"drawer":"Default","field1":"f1","field2":"f2","field3":"f3","field4":"f4","field5":"f5","documentType":"Default"}},{"id":"301YW1D_00023XZPQ000039","name":"Document 2","keys":{"drawer":"Default","field1":"f1-2","field2":"f2-2","field3":"f3-2","field4":"f4-2","field5":"f5-2","documentType":"Default"}}]}

XML Samples

Sample 1
Request URL
/v2/drawer/1013184785_688771148/content
Response
<drawerContents>
    <containedFolders>
        <folder>
            <name>Regular Folder</name>
            <id>301YVDD_00005MTV200000H</id>
            <typeId>301YVDD_00005ETV2000006</typeId>
        </folder>
        <folder>
            <name>Other Folder</name>
            <id>301YVDD_00005MTV200000J</id>
            <typeId>301YVDD_00005ETV2000006</typeId>
        </folder>
    </containedFolders>
    <containedDocuments>
        <document>
            <id>301YW1D_00023XZPQ000035</id>
            <name>Document 1</name>
            <keys>
                <drawer>Default</drawer>
                <field1>f1</field1>
                <field2>f2</field2>
                <field3>f3</field3>
                <field4>f4</field4>
                <field5>f5</field5>
                <documentType>Default</documentType>
            </keys>
        </document>
        <document>
            <id>301YW1D_00023XZPQ000039</id>
            <name>Document 2</name>
            <keys>
                <drawer>Default</drawer>
                <field1>f1-2</field1>
                <field2>f2-2</field2>
                <field3>f3-2</field3>
                <field4>f4-2</field4>
                <field5>f5-2</field5>
                <documentType>Default</documentType>
            </keys>
        </document>
    </containedDocuments>
</drawerContents>

DrawerManagement (Version 1)

GET/v1/management/drawer Retrieves all drawers owned by a department.

Expand Operation / Collapse Operation

Retrieves all drawers owned by a department.

Available from version: 1.0.0

Call Properties

Query Parameter
departmentId Id of the department to retrieve drawers for.
Response
Content
List of drawer [drawer]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

drawer type

Represents a drawer that can be managed.

Field Name Data Type Expected Description
description String Yes The description of the drawer.
id String Yes The unique ID of the drawer.
name String Yes The name of the drawer.

JSON Samples

Sample 1
Request URL
/v1/management/drawer?departmentId=301YVDM_0018XTGGH030301
Response
{"drawers":[{"id":"1013184795_6887711448","name":"Default","description":"Default drawer description"},{"id":"301YVDD_00005MTV200000A","name":"Drawer name","description":"Description for drawer"}]}

XML Samples

Sample 1
Request URL
/v1/management/drawer?departmentId=301YVDM_0018XTGGH030301
Response
<drawers>
    <drawer>
        <id>1013184795_6887711448</id>
        <name>Default</name>
        <description>Default drawer description</description>
    </drawer>
    <drawer>
        <id>301YVDD_00005MTV200000A</id>
        <name>Drawer name</name>
        <description>Description for drawer</description>
    </drawer>
</drawers>

POST/v1/management/drawer Creates a drawer

Expand Operation / Collapse Operation

Creates a drawer

Available from version: 1.0.0

Call Properties

Request
Content drawer
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

digitalSignatureVerificationInterval type

Interval for automatic digital signature verifications

Field Name Data Type Expected Description
amount Integer Yes The amount of the unit to set as the interval
unit intervalUnit Yes The unit of measurement for the amount for the interval
drawer type

Represents a drawer for creation

Field Name Data Type Expected Description
departmentId String Yes The department id the drawer belongs to
description String Yes The description of the drawer
digitalSignatureVerificationInterval digitalSignatureVerificationInterval No The automatic digital signature verification interval. To turn off, leave null or set amount to 0
name String Yes The name of the drawer.
intervalUnit enumeration

The unit of measurement for the interval

Constant Name Description
YEARS Measure the interval in years
MONTHS Measure the interval in months
WEEKS Measure the interval in weeks
DAYS Measure the interval in days

JSON Samples

Sample 1
Request URL
/v1/management/drawer
Request
{"name":"Drawer name","description":"Description for drawer","departmentId":"301YVDM_0018XTGGH030301","digitalSignatureVerificationInterval":{"amount":3,"unit":"MONTHS"}}

XML Samples

Sample 1
Request URL
/v1/management/drawer
Request
<drawer>
    <name>Drawer name</name>
    <description>Description for drawer</description>
    <departmentId>301YVDM_0018XTGGH030301</departmentId>
    <digitalSignatureVerificationInterval>
        <amount>3</amount>
        <unit>MONTHS</unit>
    </digitalSignatureVerificationInterval>
</drawer>

DELETE/v1/management/drawer/{id} Deletes a drawer

Expand Operation / Collapse Operation

Deletes a drawer

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/management/drawer/301YVDD_00005MTV200000A

XML Samples

Sample 1
Request URL
/v1/management/drawer/301YVDD_00005MTV200000A

GET/v1/management/drawer/{id} Get an individual drawer that includes system information

Expand Operation / Collapse Operation

Get an individual drawer that includes system information

Available from version: 1.0.0

Call Properties

Response
Content
drawer
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

digitalSignatureVerificationInterval type

Interval for automatic digital signature verifications

Field Name Data Type Expected Description
amount Integer Yes The amount of the unit to set as the interval
unit intervalUnit Yes The unit of measurement for the amount for the interval
drawer type

Represents a drawer

Field Name Data Type Expected Description
description String Yes The description of the drawer
digitalSignatureVerificationInterval digitalSignatureVerificationInterval No The automatic digital signature verification interval. To turn off, leave null or set amount to 0
id String Yes The unique ID of the drawer
name String Yes The name of the drawer.
intervalUnit enumeration

The unit of measurement for the interval

Constant Name Description
YEARS Measure the interval in years
MONTHS Measure the interval in months
WEEKS Measure the interval in weeks
DAYS Measure the interval in days

JSON Samples

Sample 1
Request URL
/v1/management/drawer/1013184795_6887711448
Response
{"name":"Default","id":"1013184795_6887711448","description":"Default drawer description","digitalSignatureVerificationInterval":{"amount":3,"unit":"MONTHS"}}

XML Samples

Sample 1
Request URL
/v1/management/drawer/1013184795_6887711448
Response
<drawer>
    <name>Default</name>
    <id>1013184795_6887711448</id>
    <description>Default drawer description</description>
    <digitalSignatureVerificationInterval>
        <amount>3</amount>
        <unit>MONTHS</unit>
    </digitalSignatureVerificationInterval>
</drawer>

PUT/v1/management/drawer/{id} Updates a drawer

Expand Operation / Collapse Operation

Updates a drawer

Available from version: 1.0.0

Call Properties

Request
Content drawer
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

digitalSignatureVerificationInterval type

Interval for automatic digital signature verifications

Field Name Data Type Expected Description
amount Integer Yes The amount of the unit to set as the interval
unit intervalUnit Yes The unit of measurement for the amount for the interval
drawer type

Represents a drawer for update

Field Name Data Type Expected Description
description String Yes The new description of the drawer
digitalSignatureVerificationInterval digitalSignatureVerificationInterval No The new automatic digital signature verification interval. To turn off, leave null or set amount to 0
name String Yes The new name of the drawer.
intervalUnit enumeration

The unit of measurement for the interval

Constant Name Description
YEARS Measure the interval in years
MONTHS Measure the interval in months
WEEKS Measure the interval in weeks
DAYS Measure the interval in days

JSON Samples

Sample 1
Request URL
/v1/management/drawer/301YVDD_00005MTV200000A
Request
{"name":"Drawer name","description":"Description for drawer","digitalSignatureVerificationInterval":{"amount":3,"unit":"MONTHS"}}

XML Samples

Sample 1
Request URL
/v1/management/drawer/301YVDD_00005MTV200000A
Request
<drawer>
    <name>Drawer name</name>
    <description>Description for drawer</description>
    <digitalSignatureVerificationInterval>
        <amount>3</amount>
        <unit>MONTHS</unit>
    </digitalSignatureVerificationInterval>
</drawer>

Folder (Version 1)

POST/v1/folder Creates a folder.

Expand Operation / Collapse Operation

Creates a folder.

Available from version: 1.0.0

Call Properties

Request
Content folder
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the newly created folder.

Call Types and Enumerations

folder type

Represents a folder to be created

Field Name Data Type Expected Description
name String Yes The name of the folder.
parentId String Yes The id of the parent folder.
properties List of propertyInstance [property] Yes The custom properties of the folder.
typeId String Yes The type id of the folder.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v1/folder
Request
{"name":"New Folder","parentId":"301YV8C_0008MBCRS00003G","typeId":"301YT3D_003ESEWKF000017","properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]},{"id":"301YVDX_0003RW4Y1000007","type":"DATE","value":"476064000000","childProperties":null},{"id":"301YVDX_0003RW4Y1000008","type":"FLAG","value":"0","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v1/folder
Request
<folder>
    <name>New Folder</name>
    <parentId>301YV8C_0008MBCRS00003G</parentId>
    <typeId>301YT3D_003ESEWKF000017</typeId>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000007</id>
            <type>DATE</type>
            <value>476064000000</value>
        </property>
        <property>
            <id>301YVDX_0003RW4Y1000008</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</folder>

POST/v1/folder/searchResult Searches for folders that satisfy the given criteria.

Expand Operation / Collapse Operation

Searches for folders that satisfy the given criteria.

Available from version: 1.0.0

Call Properties

Request
Content folderSearchCriteria
Content-Types
  • application/xml
  • application/json
Response
Content
folderSearchResult
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

folder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
instanceType instanceType Yes The instance type of the folder.
name String Yes The name of the folder.
path path Yes The path of the folder.
folderSearchCriteria type

The search criteria for finding a list of folders

Field Name Data Type Expected Description
drawerId String No The id of the drawer to limit the search to.
mode folderSearchMode Yes The folder search mode.
startsWith String Yes The string to search by.
folderSearchMode enumeration

The mode with which to search for folders

Constant Name Description
MOVE Mode to search for the folders to which instances can be moved.
SHORTCUT Mode to search for the folders in which shortcuts can be created.
CREATE Mode to search for the folders in which documents and folders can be created.
folderSearchResult type

The search result for a folder search.

Field Name Data Type Expected Description
folders List of folder [folder] Yes A list of matching folders.
hasMore boolean Yes Indicates if there are more results than what is returned.
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.

JSON Samples

Sample 1 - Search all of ImageNow Server
Request URL
/v1/folder/searchResult
Request
{"mode":"SHORTCUT","startsWith":"June","drawerId":null}
Response
{"hasMore":false,"folders":[{"name":"June Expense Reports","id":"301YVD8_000233WSQ000002","instanceType":"FOLDER","path":{"pathSegments":["Expense Reports","June Expense Reports"]}},{"name":"June Budgets","id":"301YVC3_0000EH8XE000002","instanceType":"FOLDER","path":{"pathSegments":["Budgets","Departments","June Budgets"]}}]}
Sample 2 - Search a single drawer
Request URL
/v1/folder/searchResult
Request
{"mode":"SHORTCUT","startsWith":"June","drawerId":"1000184723_1734091423"}
Response
{"hasMore":false,"folders":[{"name":"June Expense Reports","id":"301YVD8_000233WSQ000002","instanceType":"FOLDER","path":{"pathSegments":["Expense Reports","June Expense Reports"]}}]}

XML Samples

Sample 1 - Search all of ImageNow Server
Request URL
/v1/folder/searchResult
Request
<folderSearchCriteria>
    <mode>SHORTCUT</mode>
    <startsWith>June</startsWith>
</folderSearchCriteria>
Response
<folderSearchResult>
    <folders>
        <folder>
            <name>June Expense Reports</name>
            <id>301YVD8_000233WSQ000002</id>
            <instanceType>FOLDER</instanceType>
            <path>
                <pathSegments>
                    <pathSegment>Expense Reports</pathSegment>
                    <pathSegment>June Expense Reports</pathSegment>
                </pathSegments>
            </path>
        </folder>
        <folder>
            <name>June Budgets</name>
            <id>301YVC3_0000EH8XE000002</id>
            <instanceType>FOLDER</instanceType>
            <path>
                <pathSegments>
                    <pathSegment>Budgets</pathSegment>
                    <pathSegment>Departments</pathSegment>
                    <pathSegment>June Budgets</pathSegment>
                </pathSegments>
            </path>
        </folder>
    </folders>
    <hasMore>false</hasMore>
</folderSearchResult>
Sample 2 - Search a single drawer
Request URL
/v1/folder/searchResult
Request
<folderSearchCriteria>
    <mode>SHORTCUT</mode>
    <startsWith>June</startsWith>
    <drawerId>1000184723_1734091423</drawerId>
</folderSearchCriteria>
Response
<folderSearchResult>
    <folders>
        <folder>
            <name>June Expense Reports</name>
            <id>301YVD8_000233WSQ000002</id>
            <instanceType>FOLDER</instanceType>
            <path>
                <pathSegments>
                    <pathSegment>Expense Reports</pathSegment>
                    <pathSegment>June Expense Reports</pathSegment>
                </pathSegments>
            </path>
        </folder>
    </folders>
    <hasMore>false</hasMore>
</folderSearchResult>

DELETE/v1/folder/{id} Deletes a folder.

Expand Operation / Collapse Operation

Deletes a folder.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/folder/301YVDD_00005MTV200000H

XML Samples

Sample 1
Request URL
/v1/folder/301YVDD_00005MTV200000H

GET/v1/folder/{id} Gets the folder and it's contents.

Expand Operation / Collapse Operation

Gets the folder and it's contents.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Response
Content
folder
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

containedDocument type

Represents a document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
name String Yes The document's name
targetId String No If a shortcut, the unique id of the target document.
containedFolder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
name String Yes The name of the folder.
targetId String No If a shortcut, the unique id of the target folder.
typeId String Yes The type id of the folder.
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
folder type

Represents a folder

Field Name Data Type Expected Description
containedDocuments List of containedDocument [containedDocument] Yes The documents contained with this folder. Does not include documents in contained folders.
containedFolders List of containedFolder [containedFolder] Yes The folders contained within this folder.
hasMoreContainedItems boolean Yes Indicates if there are more contained documents or folders than what is returned.
id String Yes The unique id of the folder or shortcut.
locationId String Yes The folder's location
name String Yes The name of the folder.
properties List of propertyInstance [property] Yes The custom properties of the folder.
targetId String No If a shortcut, the unique id of the target folder.
typeId String Yes The type id of the folder.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v1/folder/301YVDD_00005MTV200000H
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}]}
Sample 2 - queueId parameter included
Request URL
/v1/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}]}

XML Samples

Sample 1
Request URL
/v1/folder/301YVDD_00005MTV200000H
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
</folder>
Sample 2 - queueId parameter included
Request URL
/v1/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
</folder>

PUT/v1/folder/{id} Updates the name and folder type for a given folder.

Expand Operation / Collapse Operation

Updates the name and folder type for a given folder.

Available from version: 1.0.0

Call Properties

Request
Content folder
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

folder type

Represents a folder to be updated

Field Name Data Type Expected Description
name String Yes The name of the folder.
properties List of propertyInstance [property] Yes The properties associated with the new folder type.
typeId String Yes The type id of the folder.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v1/folder/301YV7E_0005NY0T400001Y
Request
{"name":"FolderName","typeId":"301YV8X_0009WEZ1Y00001W","properties":[{"id":"301YVDX_0003RW4Y1000001","type":"COMPOSITE","value":"","childProperties":[{"id":"301YVDX_0003RW4Y1000002","type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","type":"NUMBER","value":"15"}]}]}

XML Samples

Sample 1
Request URL
/v1/folder/301YV7E_0005NY0T400001Y
Request
<folder>
    <name>FolderName</name>
    <typeId>301YV8X_0009WEZ1Y00001W</typeId>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <value/>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>

POST/v1/folder/{id}/content This API operation moves a set of existing ImageNow documents, folders, and shortcuts to a folder...

Expand Operation / Collapse Operation

This API operation moves a set of existing ImageNow documents, folders, and shortcuts to a folder. The items you are moving can reside anywhere in the ImageNow system and can exist in multiple locations, since you specify the items by their unique ID. The folderContentItem data type provides the necessary information for ImageNow Server to successfully move the item, such as the type of the item (instanceType) and the unique ID of the document, folder, or shortcut.

Available from version: 1.0.0

Example 1 in the following table shows a request to move items and a response indicating a naming conflict. Example 2 shows a request to use APPEND to append the document with the naming conflict to the existing document.

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The request contains the list of items to move along with an action parameter. The action parameter is an enumeration.
Request
Content List of folderContentItem [item]
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
List of folderConflict [folderConflict] (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS This is the default action, which returns a response code of 200 if the move was successful, or a response code of 409 if the move failed along with a list of conflicting items. If you try to move an item of the same type and same name of an existing item, such as moving a document with the name JuneExpenseReport into a folder that already has a document with the name JuneExpenseReport, Integration Server reports this as a conflicting item. The list of conflicting items provides identifying information for the existing item in the folder along and for the item you are trying to move.
APPEND Use APPEND for conflict resolution. This allows you to append a document to an existing document in the folder. When the document appends, it takes on the custom property values and workflow properties of the target document.
REPLACE Use REPLACE for conflict resolution. This allows you to replace an existing document in a folder with a document you are moving.
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
folderConflict type

Contains two items; the item that tried to move, and the conflicting item.

Field Name Data Type Expected Description
conflictingItem conflictItem Yes The conflicting item.
item conflictItem Yes The item that tried to move.
folderContentItem type

A document, folder, or shortcut contained in a folder.

Field Name Data Type Expected Description
id String Yes The unique ID of the item.
instanceType instanceType Yes The type of item.
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.

JSON Samples

Sample 1 - Request to move with a response indicating a naming conflict
Request URL
/v1/folder/301YV7E_0005NY0T400001Y/content
Request
{"folderContents":[{"instanceType":"DOCUMENT","id":"301YW1D_000251ZDM000021"},{"instanceType":"FOLDER","id":"301YW1D_000250ZDM00002D"}]}
Response
{"folderConflicts":[{"item":{"instanceType":"DOCUMENT","id":"301YW1D_000251ZDM000021"},"conflictingItem":{"instanceType":"DOCUMENT","id":"301YW1B_00018DYSX000001"}}]}
Sample 2 - Request to append the document with the naming conflict to the existing document
Request URL
/v1/folder/301YV7E_0005NY0T400001Y/content?action=APPEND
Request
{"folderContents":[{"instanceType":"DOCUMENT","id":"301YW1D_000251ZDM000021"},{"instanceType":"FOLDER","id":"301YW1D_000250ZDM00002D"}]}

XML Samples

Sample 1 - Request to move with a response indicating a naming conflict
Request URL
/v1/folder/301YV7E_0005NY0T400001Y/content
Request
<folderContents>
    <item>
        <instanceType>DOCUMENT</instanceType>
        <id>301YW1D_000251ZDM000021</id>
    </item>
    <item>
        <instanceType>FOLDER</instanceType>
        <id>301YW1D_000250ZDM00002D</id>
    </item>
</folderContents>
Response
<folderConflicts>
    <folderConflict>
        <item>
            <instanceType>DOCUMENT</instanceType>
            <id>301YW1D_000251ZDM000021</id>
        </item>
        <conflictingItem>
            <instanceType>DOCUMENT</instanceType>
            <id>301YW1B_00018DYSX000001</id>
        </conflictingItem>
    </folderConflict>
</folderConflicts>
Sample 2 - Request to append the document with the naming conflict to the existing document
Request URL
/v1/folder/301YV7E_0005NY0T400001Y/content?action=APPEND
Request
<folderContents>
    <item>
        <instanceType>DOCUMENT</instanceType>
        <id>301YW1D_000251ZDM000021</id>
    </item>
    <item>
        <instanceType>FOLDER</instanceType>
        <id>301YW1D_000250ZDM00002D</id>
    </item>
</folderContents>

GET/v1/folder/{id}/documentType Gets associated document types for a folder. Additionally, each document type has a flag to indic...

Expand Operation / Collapse Operation

Gets associated document types for a folder. Additionally, each document type has a flag to indicate if it is required in the folder and if a document of that type exists within that folder.

Available from version: 1.0.0

Call Properties

Query Parameters
required (optional) Return only required document types (true) or return non-required document types (false). If not supplied, returns both required and non-required document types.
present (optional) Return only present document types (true) or return missing document types (false). If not supplied, returns both present and missing document types.
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Response
Content
List of documentType [documentType]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

documentType type

Represents associated document type of a folder

Field Name Data Type Expected Description
description String Yes A description of the document type.
id String Yes The unique id of the document type.
name String Yes The name of the document type.
present boolean Yes Whether the document type is present.
required boolean Yes Whether the document type is required.

JSON Samples

Sample 1 - Request all document types associated with the folder
Request URL
/v1/folder/301YVDD_00005MTV200000H/documentType
Response
{"documentTypes":[{"name":"Expense Report","id":"301YVDD_00005MTV2000006","description":"Expense Report document type","required":true,"present":false},{"name":"Receipt","id":"301YVDD_00005MTV2000134","description":"Receipt document type","required":true,"present":true}]}
Sample 2 - Get the associated document types of a folder with required = true and present = false
Request URL
/v1/folder/301YVDD_00005MTV200000H/documentType?required=true&present=false
Response
{"documentTypes":[{"name":"Expense Report","id":"301YVDD_00005MTV2000006","description":"Expense Report document type","required":true,"present":false}]}
Sample 3 - queueId parameter included
Request URL
/v1/folder/301YVDD_00005MTV200000H/documentType?queueId=321YZ46_000QEJ5XJ000021
Response
{"documentTypes":[{"name":"Expense Report","id":"301YVDD_00005MTV2000006","description":"Expense Report document type","required":true,"present":false},{"name":"Receipt","id":"301YVDD_00005MTV2000134","description":"Receipt document type","required":true,"present":true}]}

XML Samples

Sample 1 - Request all document types associated with the folder
Request URL
/v1/folder/301YVDD_00005MTV200000H/documentType
Response
<documentTypes>
    <documentType>
        <name>Expense Report</name>
        <id>301YVDD_00005MTV2000006</id>
        <description>Expense Report document type</description>
        <required>true</required>
        <present>false</present>
    </documentType>
    <documentType>
        <name>Receipt</name>
        <id>301YVDD_00005MTV2000134</id>
        <description>Receipt document type</description>
        <required>true</required>
        <present>true</present>
    </documentType>
</documentTypes>
Sample 2 - Get the associated document types of a folder with required = true and present = false
Request URL
/v1/folder/301YVDD_00005MTV200000H/documentType?required=true&present=false
Response
<documentTypes>
    <documentType>
        <name>Expense Report</name>
        <id>301YVDD_00005MTV2000006</id>
        <description>Expense Report document type</description>
        <required>true</required>
        <present>false</present>
    </documentType>
</documentTypes>
Sample 3 - queueId parameter included
Request URL
/v1/folder/301YVDD_00005MTV200000H/documentType?queueId=321YZ46_000QEJ5XJ000021
Response
<documentTypes>
    <documentType>
        <name>Expense Report</name>
        <id>301YVDD_00005MTV2000006</id>
        <description>Expense Report document type</description>
        <required>true</required>
        <present>false</present>
    </documentType>
    <documentType>
        <name>Receipt</name>
        <id>301YVDD_00005MTV2000134</id>
        <description>Receipt document type</description>
        <required>true</required>
        <present>true</present>
    </documentType>
</documentTypes>

PUT/v1/folder/{id}/name Update the name of a folder stored in ImageNow Server.

Expand Operation / Collapse Operation

Update the name of a folder stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Query Parameter
action actionType (default RETURN_CONFLICTS) (optional) The action to preform if a conflict occurs. APPEND, REPLACE, or RETURN_CONFLICTS (default)
Request
Content itemName
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

A document, folder, or shortcut that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
itemName type

Represents the desired name of a item

Field Name Data Type Expected Description
name String Yes The desired name of the item.

JSON Samples

Sample 1 - Request to rename a folder with a response indicating a naming conflict
Request URL
/v1/folder/301YW1D_000251ZDM000045/name
Request
{"name":"New Folder Name"}
Response
{"instanceType":"FOLDER","id":"301YW1B_00018DYSX000001"}
Sample 2 - Request to append the folder with the naming conflict to the existing folder
Request URL
/v1/folder/301YW1D_000251ZDM000045/name?action=APPEND
Request
{"name":"New Folder Name"}

XML Samples

Sample 1 - Request to rename a folder with a response indicating a naming conflict
Request URL
/v1/folder/301YW1D_000251ZDM000045/name
Request
<itemName>
    <name>New Folder Name</name>
</itemName>
Response
<conflictItem>
    <instanceType>FOLDER</instanceType>
    <id>301YW1B_00018DYSX000001</id>
</conflictItem>
Sample 2 - Request to append the folder with the naming conflict to the existing folder
Request URL
/v1/folder/301YW1D_000251ZDM000045/name?action=APPEND
Request
<itemName>
    <name>New Folder Name</name>
</itemName>

GET/v1/folder/{id}/path Gets a folder's path.

Expand Operation / Collapse Operation

Gets a folder's path.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Response
Content
path
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.

JSON Samples

Sample 1
Request URL
/v1/folder/301YVDD_00005MTV200000H/path
Response
{"pathSegments":["Budgets","Departments","June Budgets"]}
Sample 2 - queueId parameter included
Request URL
/v1/folder/301YVDD_00005MTV200000H/path?queueId=321YZ46_000QEJ5XJ000021
Response
{"pathSegments":["Budgets","Departments","June Budgets"]}

XML Samples

Sample 1
Request URL
/v1/folder/301YVDD_00005MTV200000H/path
Response
<path>
    <pathSegments>
        <pathSegment>Budgets</pathSegment>
        <pathSegment>Departments</pathSegment>
        <pathSegment>June Budgets</pathSegment>
    </pathSegments>
</path>
Sample 2 - queueId parameter included
Request URL
/v1/folder/301YVDD_00005MTV200000H/path?queueId=321YZ46_000QEJ5XJ000021
Response
<path>
    <pathSegments>
        <pathSegment>Budgets</pathSegment>
        <pathSegment>Departments</pathSegment>
        <pathSegment>June Budgets</pathSegment>
    </pathSegments>
</path>

Folder (Version 2)

GET/v2/folder/{id} Gets the folder and it's contents.

Expand Operation / Collapse Operation

Gets the folder and it's contents.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Response
Content
folder
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

containedDocument type

Represents a document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
name String Yes The document's name
targetId String No If a shortcut, the unique id of the target document.
containedFolder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
name String Yes The name of the folder.
targetId String No If a shortcut, the unique id of the target folder.
typeId String Yes The type id of the folder.
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
folder type

Represents a folder

Field Name Data Type Expected Description
containedDocuments List of containedDocument [containedDocument] Yes The documents contained with this folder. Does not include documents in contained folders.
containedFolders List of containedFolder [containedFolder] Yes The folders contained within this folder.
hasMoreContainedItems boolean Yes Indicates if there are more contained documents or folders than what is returned.
id String Yes The unique ID of the folder or shortcut.
locationId String Yes The folder's location
name String Yes The name of the folder.
properties List of propertyInstance [property] Yes The custom properties of the folder.
targetId String No If a shortcut, the unique ID of the target folder.
typeId String Yes The type ID of the folder.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values for child properties. The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v2/folder/301YVDD_00005MTV200000H
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}]}
Sample 2
Request URL
/v2/folder/321Z07W_000BTX8BG00001H
Response
{"name":"Scanned Docs","id":"321Z07W_000BTX8BG00001H","targetId":null,"typeId":"321Z07W_000BTS8BG000014","locationId":"3000184723_1734091423","hasMoreContainedItems":false,"properties":[{"id":"321Z07W_000BTQ8BF00000T","name":"StringProp","elementId":null,"type":"STRING","value":"BEG LLC","childProperties":null},{"id":"321Z07W_000BTR8BG000026","name":"NumberProp","elementId":null,"type":"NUMBER","value":"15.000000","childProperties":null},{"id":"321Z07W_000BTZ8BG00001K","name":"ArrayCustomStringProp","elementId":null,"type":"ARRAY","value":null,"childProperties":[{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000C","type":"STRING","value":"Michigan"},{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000E","type":"STRING","value":"Ohio"}]}],"containedFolders":[],"containedDocuments":[]}
Sample 3 - queueId parameter included
Request URL
/v2/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}]}

XML Samples

Sample 1
Request URL
/v2/folder/301YVDD_00005MTV200000H
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
</folder>
Sample 2
Request URL
/v2/folder/321Z07W_000BTX8BG00001H
Response
<folder>
    <name>Scanned Docs</name>
    <id>321Z07W_000BTX8BG00001H</id>
    <typeId>321Z07W_000BTS8BG000014</typeId>
    <locationId>3000184723_1734091423</locationId>
    <properties>
        <property>
            <id>321Z07W_000BTQ8BF00000T</id>
            <name>StringProp</name>
            <type>STRING</type>
            <value>BEG LLC</value>
        </property>
        <property>
            <id>321Z07W_000BTR8BG000026</id>
            <name>NumberProp</name>
            <type>NUMBER</type>
            <value>15.000000</value>
        </property>
        <property>
            <id>321Z07W_000BTZ8BG00001K</id>
            <name>ArrayCustomStringProp</name>
            <type>ARRAY</type>
            <childProperties>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000C</elementId>
                    <type>STRING</type>
                    <value>Michigan</value>
                </childProperty>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000E</elementId>
                    <type>STRING</type>
                    <value>Ohio</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
    <containedFolders/>
    <containedDocuments/>
    <hasMoreContainedItems>false</hasMoreContainedItems>
</folder>
Sample 3 - queueId parameter included
Request URL
/v2/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
</folder>

PATCH/v2/folder/{id} Updates the name, folder type or properties provided for a given folder.

Expand Operation / Collapse Operation

Updates the name, folder type or properties provided for a given folder.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Request
Content folder
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

folder type

Represents a folder to be updated

Field Name Data Type Expected Description
name String No The name of the folder.
properties List of propertyInstance [property] No The properties associated with the folder type.
typeId String No The type ID of the folder.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance to update

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is ARRAY or COMPOSITE, the values of the sub-properties
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
updateAction propertyUpdateActionType Yes The property's update action. Only used if the property type is ARRAY or COMPOSITE.
value String Yes The property's value
propertyUpdateActionType enumeration

The action to perform on the array or composite property. UPDATE (default), CREATE or DELETE.

Constant Name Description
UPDATE Action that updates an existing property.
CREATE Action that creates a new property.
DELETE Action that deletes an existing property.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v2/folder/301YV7E_0005NY0T400001Y
Request
{"name":"FolderName","typeId":"301YV8X_0009WEZ1Y00001W","properties":[{"id":"301YVDX_0003RW4Y1000001","name":null,"elementId":null,"type":"COMPOSITE","value":null,"updateAction":null,"childProperties":[{"id":"301YVDX_0003RW4Y1000002","name":null,"elementId":null,"type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","name":null,"elementId":null,"type":"NUMBER","value":"15"}]}]}
Sample 2 - add new array element
Request URL
/v2/folder/321Z07N_0008MKNDB00000D
Request
{"name":null,"typeId":null,"properties":[{"id":"321Z07N_0008MLNDB000001","name":null,"elementId":null,"type":"ARRAY","value":null,"updateAction":"CREATE","childProperties":[{"id":"321Z07N_0008MLNDB000002","name":null,"elementId":null,"type":"STRING","value":"StringValue"}]}]}
Sample 3 - update an existing array value
Request URL
/v2/folder/321Z07T_0009V6MM5000005
Request
{"name":null,"typeId":null,"properties":[{"id":"321Z07T_0009YLVXE00001M","name":null,"elementId":null,"type":"ARRAY","value":null,"updateAction":"UPDATE","childProperties":[{"id":null,"name":"PO Box String Custom Property","elementId":"321Z07T_0009V6MM5000004","type":"STRING","value":"Box 995"}]}]}
Sample 4 - queueId parameter included
Request URL
/v2/folder/301YV7E_0005NY0T400001Y?queueId=321YZ46_000QEJ5XJ000021
Request
{"name":"FolderName","typeId":"301YV8X_0009WEZ1Y00001W","properties":[{"id":"301YVDX_0003RW4Y1000001","name":null,"elementId":null,"type":"COMPOSITE","value":null,"updateAction":null,"childProperties":[{"id":"301YVDX_0003RW4Y1000002","name":null,"elementId":null,"type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","name":null,"elementId":null,"type":"NUMBER","value":"15"}]}]}

XML Samples

Sample 1
Request URL
/v2/folder/301YV7E_0005NY0T400001Y
Request
<folder>
    <name>FolderName</name>
    <typeId>301YV8X_0009WEZ1Y00001W</typeId>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>
Sample 2 - add new array element
Request URL
/v2/folder/321Z07N_0008MKNDB00000D
Request
<folder>
    <properties>
        <property>
            <id>321Z07N_0008MLNDB000001</id>
            <type>ARRAY</type>
            <updateAction>CREATE</updateAction>
            <childProperties>
                <childProperty>
                    <id>321Z07N_0008MLNDB000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>
Sample 3 - update an existing array value
Request URL
/v2/folder/321Z07T_0009V6MM5000005
Request
<folder>
    <properties>
        <property>
            <id>321Z07T_0009YLVXE00001M</id>
            <type>ARRAY</type>
            <updateAction>UPDATE</updateAction>
            <childProperties>
                <childProperty>
                    <name>PO Box String Custom Property</name>
                    <elementId>321Z07T_0009V6MM5000004</elementId>
                    <type>STRING</type>
                    <value>Box 995</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>
Sample 4 - queueId parameter included
Request URL
/v2/folder/301YV7E_0005NY0T400001Y?queueId=321YZ46_000QEJ5XJ000021
Request
<folder>
    <name>FolderName</name>
    <typeId>301YV8X_0009WEZ1Y00001W</typeId>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>

Folder (Version 3)

GET/v3/folder/{id} Gets the folder and its contents. Returns associated workflow items.

Expand Operation / Collapse Operation

Gets the folder and its contents. Returns associated workflow items.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Response
Content
folder
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

containedDocument type

Represents a document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
name String Yes The document's name
targetId String No If a shortcut, the unique id of the target document.
containedFolder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
name String Yes The name of the folder.
targetId String No If a shortcut, the unique id of the target folder.
typeId String Yes The type id of the folder.
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
folder type

Represents a folder. Contains workflow items.

Field Name Data Type Expected Description
containedDocuments List of containedDocument [containedDocument] Yes The documents contained with this folder. Does not include documents in contained folders.
containedFolders List of containedFolder [containedFolder] Yes The folders contained within this folder.
hasMoreContainedItems boolean Yes Indicates if there are more contained documents or folders than what is returned.
id String Yes The unique ID of the folder or shortcut.
locationId String Yes The folder's location
name String Yes The name of the folder.
properties List of propertyInstance [property] Yes The custom properties of the folder.
targetId String No If a shortcut, the unique ID of the target folder.
typeId String Yes The type ID of the folder.
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow item IDs for the folder
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values for child properties. The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v3/folder/301YVDD_00005MTV200000H
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}],"workflowItems":[{"id":"321YXCN_0000FX5B6000003"},{"id":"321YXCN_0000FX5B6000008"}]}
Sample 2
Request URL
/v3/folder/321Z07W_000BTX8BG00001H
Response
{"name":"Scanned Docs","id":"321Z07W_000BTX8BG00001H","targetId":null,"typeId":"321Z07W_000BTS8BG000014","locationId":"3000184723_1734091423","hasMoreContainedItems":false,"properties":[{"id":"321Z07W_000BTQ8BF00000T","name":"StringProp","elementId":null,"type":"STRING","value":"BEG LLC","childProperties":null},{"id":"321Z07W_000BTR8BG000026","name":"NumberProp","elementId":null,"type":"NUMBER","value":"15.000000","childProperties":null},{"id":"321Z07W_000BTZ8BG00001K","name":"ArrayCustomStringProp","elementId":null,"type":"ARRAY","value":null,"childProperties":[{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000C","type":"STRING","value":"Michigan"},{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000E","type":"STRING","value":"Ohio"}]}],"containedFolders":[],"containedDocuments":[],"workflowItems":[]}
Sample 3 - queueId parameter included
Request URL
/v3/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}],"workflowItems":[{"id":"321YXCN_0000FX5B6000003"},{"id":"321YXCN_0000FX5B6000008"}]}

XML Samples

Sample 1
Request URL
/v3/folder/301YVDD_00005MTV200000H
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems>
        <workflowItem>
            <id>321YXCN_0000FX5B6000003</id>
        </workflowItem>
        <workflowItem>
            <id>321YXCN_0000FX5B6000008</id>
        </workflowItem>
    </workflowItems>
</folder>
Sample 2
Request URL
/v3/folder/321Z07W_000BTX8BG00001H
Response
<folder>
    <name>Scanned Docs</name>
    <id>321Z07W_000BTX8BG00001H</id>
    <typeId>321Z07W_000BTS8BG000014</typeId>
    <locationId>3000184723_1734091423</locationId>
    <properties>
        <property>
            <id>321Z07W_000BTQ8BF00000T</id>
            <name>StringProp</name>
            <type>STRING</type>
            <value>BEG LLC</value>
        </property>
        <property>
            <id>321Z07W_000BTR8BG000026</id>
            <name>NumberProp</name>
            <type>NUMBER</type>
            <value>15.000000</value>
        </property>
        <property>
            <id>321Z07W_000BTZ8BG00001K</id>
            <name>ArrayCustomStringProp</name>
            <type>ARRAY</type>
            <childProperties>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000C</elementId>
                    <type>STRING</type>
                    <value>Michigan</value>
                </childProperty>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000E</elementId>
                    <type>STRING</type>
                    <value>Ohio</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
    <containedFolders/>
    <containedDocuments/>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems/>
</folder>
Sample 3 - queueId parameter included
Request URL
/v3/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems>
        <workflowItem>
            <id>321YXCN_0000FX5B6000003</id>
        </workflowItem>
        <workflowItem>
            <id>321YXCN_0000FX5B6000008</id>
        </workflowItem>
    </workflowItems>
</folder>

PATCH/v3/folder/{id} Updates the name, location, folder type or properties provided for a given folder.

Expand Operation / Collapse Operation

Updates the name, location, folder type or properties provided for a given folder.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Request
Content folder
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

folder type

Represents a folder to be updated

Field Name Data Type Expected Description
locationId String No The location ID of the folder.
name String No The name of the folder.
properties List of propertyInstance [property] No The properties associated with the folder type.
typeId String No The type ID of the folder.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance to update

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is ARRAY or COMPOSITE, the values of the sub-properties
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
updateAction propertyUpdateActionType Yes The property's update action. Only used if the property type is ARRAY or COMPOSITE.
value String Yes The property's value
propertyUpdateActionType enumeration

The action to perform on the array or composite property. UPDATE (default), CREATE or DELETE.

Constant Name Description
UPDATE Action that updates an existing property.
CREATE Action that creates a new property.
DELETE Action that deletes an existing property.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v3/folder/301YV7E_0005NY0T400001Y
Request
{"name":"FolderName","typeId":"301YV8X_0009WEZ1Y00001W","locationId":"321Z28Z_0000HH3CF000043","properties":[{"id":"301YVDX_0003RW4Y1000001","name":null,"elementId":null,"type":"COMPOSITE","value":null,"updateAction":null,"childProperties":[{"id":"301YVDX_0003RW4Y1000002","name":null,"elementId":null,"type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","name":null,"elementId":null,"type":"NUMBER","value":"15"}]}]}
Sample 2 - add new array element
Request URL
/v3/folder/321Z07N_0008MKNDB00000D
Request
{"name":null,"typeId":null,"locationId":null,"properties":[{"id":"321Z07N_0008MLNDB000001","name":null,"elementId":null,"type":"ARRAY","value":null,"updateAction":"CREATE","childProperties":[{"id":"321Z07N_0008MLNDB000002","name":null,"elementId":null,"type":"STRING","value":"StringValue"}]}]}
Sample 3 - update an existing array value
Request URL
/v3/folder/321Z07T_0009V6MM5000005
Request
{"name":null,"typeId":null,"locationId":null,"properties":[{"id":"321Z07T_0009YLVXE00001M","name":null,"elementId":null,"type":"ARRAY","value":null,"updateAction":"UPDATE","childProperties":[{"id":null,"name":"PO Box String Custom Property","elementId":"321Z07T_0009V6MM5000004","type":"STRING","value":"Box 995"}]}]}
Sample 4 - queueId parameter included
Request URL
/v3/folder/301YV7E_0005NY0T400001Y?queueId=321YZ46_000QEJ5XJ000021
Request
{"name":"FolderName","typeId":"301YV8X_0009WEZ1Y00001W","locationId":"321Z28Z_0000HH3CF000043","properties":[{"id":"301YVDX_0003RW4Y1000001","name":null,"elementId":null,"type":"COMPOSITE","value":null,"updateAction":null,"childProperties":[{"id":"301YVDX_0003RW4Y1000002","name":null,"elementId":null,"type":"STRING","value":"StringValue"},{"id":"301YVDX_0003RW4Y1000003","name":null,"elementId":null,"type":"NUMBER","value":"15"}]}]}

XML Samples

Sample 1
Request URL
/v3/folder/301YV7E_0005NY0T400001Y
Request
<folder>
    <name>FolderName</name>
    <typeId>301YV8X_0009WEZ1Y00001W</typeId>
    <locationId>321Z28Z_0000HH3CF000043</locationId>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>
Sample 2 - add new array element
Request URL
/v3/folder/321Z07N_0008MKNDB00000D
Request
<folder>
    <properties>
        <property>
            <id>321Z07N_0008MLNDB000001</id>
            <type>ARRAY</type>
            <updateAction>CREATE</updateAction>
            <childProperties>
                <childProperty>
                    <id>321Z07N_0008MLNDB000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>
Sample 3 - update an existing array value
Request URL
/v3/folder/321Z07T_0009V6MM5000005
Request
<folder>
    <properties>
        <property>
            <id>321Z07T_0009YLVXE00001M</id>
            <type>ARRAY</type>
            <updateAction>UPDATE</updateAction>
            <childProperties>
                <childProperty>
                    <name>PO Box String Custom Property</name>
                    <elementId>321Z07T_0009V6MM5000004</elementId>
                    <type>STRING</type>
                    <value>Box 995</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>
Sample 4 - queueId parameter included
Request URL
/v3/folder/301YV7E_0005NY0T400001Y?queueId=321YZ46_000QEJ5XJ000021
Request
<folder>
    <name>FolderName</name>
    <typeId>301YV8X_0009WEZ1Y00001W</typeId>
    <locationId>321Z28Z_0000HH3CF000043</locationId>
    <properties>
        <property>
            <id>301YVDX_0003RW4Y1000001</id>
            <type>COMPOSITE</type>
            <childProperties>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000002</id>
                    <type>STRING</type>
                    <value>StringValue</value>
                </childProperty>
                <childProperty>
                    <id>301YVDX_0003RW4Y1000003</id>
                    <type>NUMBER</type>
                    <value>15</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
</folder>

Folder (Version 4)

GET/v4/folder/{id} Gets the folder and its contents. Returns associated workflow items.

Expand Operation / Collapse Operation

Gets the folder and its contents. Returns associated workflow items.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Response
Content
folder
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

containedDocument type

Represents a document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
name String Yes The document's name
targetId String No If a shortcut, the unique id of the target document.
containedFolder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
name String Yes The name of the folder.
targetId String No If a shortcut, the unique id of the target folder.
typeId String Yes The type id of the folder.
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
folder type

Represents a folder. Contains workflow items.

Field Name Data Type Expected Description
containedDocuments List of containedDocument [containedDocument] Yes The documents contained with this folder. Does not include documents in contained folders.
containedFolders List of containedFolder [containedFolder] Yes The folders contained within this folder.
folderType String Yes The name of the folder's type.
hasMoreContainedItems boolean Yes Indicates if there are more contained documents or folders than what is returned.
id String Yes The unique ID of the folder or shortcut.
locationId String Yes The folder's location
name String Yes The name of the folder.
properties List of propertyInstance [property] Yes The custom properties of the folder.
targetId String No If a shortcut, the unique ID of the target folder.
typeId String Yes The ID of the folder's type.
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow item IDs for the folder
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values for child properties. The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v4/folder/301YVDD_00005MTV200000H
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","folderType":"My Folder Type","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}],"workflowItems":[{"id":"321YXCN_0000FX5B6000003"},{"id":"321YXCN_0000FX5B6000008"}]}
Sample 2
Request URL
/v4/folder/321Z07W_000BTX8BG00001H
Response
{"name":"Scanned Docs","id":"321Z07W_000BTX8BG00001H","targetId":null,"typeId":"321Z07W_000BTS8BG000014","folderType":"My Folder Type","locationId":"3000184723_1734091423","hasMoreContainedItems":false,"properties":[{"id":"321Z07W_000BTQ8BF00000T","name":"StringProp","elementId":null,"type":"STRING","value":"BEG LLC","childProperties":null},{"id":"321Z07W_000BTR8BG000026","name":"NumberProp","elementId":null,"type":"NUMBER","value":"15.000000","childProperties":null},{"id":"321Z07W_000BTZ8BG00001K","name":"ArrayCustomStringProp","elementId":null,"type":"ARRAY","value":null,"childProperties":[{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000C","type":"STRING","value":"Michigan"},{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000E","type":"STRING","value":"Ohio"}]}],"containedFolders":[],"containedDocuments":[],"workflowItems":[]}
Sample 3 - queueId parameter included
Request URL
/v4/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","folderType":"My Folder Type","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}],"workflowItems":[{"id":"321YXCN_0000FX5B6000003"},{"id":"321YXCN_0000FX5B6000008"}]}

XML Samples

Sample 1
Request URL
/v4/folder/301YVDD_00005MTV200000H
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <folderType>My Folder Type</folderType>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems>
        <workflowItem>
            <id>321YXCN_0000FX5B6000003</id>
        </workflowItem>
        <workflowItem>
            <id>321YXCN_0000FX5B6000008</id>
        </workflowItem>
    </workflowItems>
</folder>
Sample 2
Request URL
/v4/folder/321Z07W_000BTX8BG00001H
Response
<folder>
    <name>Scanned Docs</name>
    <id>321Z07W_000BTX8BG00001H</id>
    <typeId>321Z07W_000BTS8BG000014</typeId>
    <folderType>My Folder Type</folderType>
    <locationId>3000184723_1734091423</locationId>
    <properties>
        <property>
            <id>321Z07W_000BTQ8BF00000T</id>
            <name>StringProp</name>
            <type>STRING</type>
            <value>BEG LLC</value>
        </property>
        <property>
            <id>321Z07W_000BTR8BG000026</id>
            <name>NumberProp</name>
            <type>NUMBER</type>
            <value>15.000000</value>
        </property>
        <property>
            <id>321Z07W_000BTZ8BG00001K</id>
            <name>ArrayCustomStringProp</name>
            <type>ARRAY</type>
            <childProperties>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000C</elementId>
                    <type>STRING</type>
                    <value>Michigan</value>
                </childProperty>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000E</elementId>
                    <type>STRING</type>
                    <value>Ohio</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
    <containedFolders/>
    <containedDocuments/>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems/>
</folder>
Sample 3 - queueId parameter included
Request URL
/v4/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <folderType>My Folder Type</folderType>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems>
        <workflowItem>
            <id>321YXCN_0000FX5B6000003</id>
        </workflowItem>
        <workflowItem>
            <id>321YXCN_0000FX5B6000008</id>
        </workflowItem>
    </workflowItems>
</folder>

Folder (Version 5)

GET/v5/folder/{id} Gets the folder, its contents, the user's privileges and associated workflow items.

Expand Operation / Collapse Operation

Gets the folder, its contents, the user's privileges and associated workflow items.

Available from version: 1.0.0

Call Properties

Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's view privilege for the folder.
Response
Content
folder
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

containedDocument type

Represents a document

Field Name Data Type Expected Description
id String Yes The document's id
keys documentKeys Yes The document's set of keys
name String Yes The document's name
targetId String No If a shortcut, the unique id of the target document.
containedFolder type

Represents a folder

Field Name Data Type Expected Description
id String Yes The unique id of the folder or shortcut.
name String Yes The name of the folder.
targetId String No If a shortcut, the unique id of the target folder.
typeId String Yes The type id of the folder.
documentKeys type

Full set of document keys

Field Name Data Type Expected Description
documentType String Yes The name of the document type.
drawer String Yes The name of the drawer.
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
folder type

Represents a folder. Contains workflow items.

Field Name Data Type Expected Description
containedDocuments List of containedDocument [containedDocument] Yes The documents contained with this folder. Does not include documents in contained folders.
containedFolders List of containedFolder [containedFolder] Yes The folders contained within this folder.
folderType String Yes The name of the folder's type.
hasMoreContainedItems boolean Yes Indicates if there are more contained documents or folders than what is returned.
id String Yes The unique ID of the folder or shortcut.
locationId String Yes The folder's location
name String Yes The name of the folder.
privileges folderPrivileges Yes Information about the user's privileges on the folder
properties List of propertyInstance [property] Yes The custom properties of the folder.
targetId String No If a shortcut, the unique ID of the target folder.
typeId String Yes The ID of the folder's type.
workflowItems List of workflowItemIds [workflowItem] Yes The associated workflow item IDs for the folder
folderPrivileges type

Full set of folder privileges

Field Name Data Type Expected Description
createShortcuts Boolean Yes Indicates the user can create shortcuts within the folder.
delete Boolean Yes Indicates the user can delete or restore the folder.
modifyCustomProperties Boolean Yes Indicates the user can modify custom property values on the folder.
modifyDrawer Boolean Yes Indicates the user can move the folder to a different drawer.
modifyStatus Boolean Yes Indicates the user can activate or disable the folder.
modifyType Boolean Yes Indicates the user can modify the type of folder.
moveInDrawer Boolean Yes Indicates the user can move the folder within the current drawer.
removeShortcuts Boolean Yes Indicates the user can delete shortcuts within the folder.
rename Boolean Yes Indicates the user can rename the folder.
view Boolean Yes Indicates the user can open the folder.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes The values for child properties. The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
elementId String Yes The property's element ID. Only used if the property type is ARRAY or COMPOSITE.
id String Yes The property's ID
name String Yes The property's name
type type Yes The property's type
value String Yes The property's value
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
workflowItemIds type

The ID of a workflow item

Field Name Data Type Expected Description
id String Yes The unique ID of the workflow item.

JSON Samples

Sample 1
Request URL
/v5/folder/301YVDD_00005MTV200000H
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","folderType":"My Folder Type","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"privileges":{"createShortcuts":true,"removeShortcuts":true,"delete":false,"view":true,"modifyCustomProperties":true,"moveInDrawer":true,"rename":false,"modifyDrawer":true,"modifyType":false,"modifyStatus":false},"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}],"workflowItems":[{"id":"321YXCN_0000FX5B6000003"},{"id":"321YXCN_0000FX5B6000008"}]}
Sample 2
Request URL
/v5/folder/321Z07W_000BTX8BG00001H
Response
{"name":"Scanned Docs","id":"321Z07W_000BTX8BG00001H","targetId":null,"typeId":"321Z07W_000BTS8BG000014","folderType":"My Folder Type","locationId":"3000184723_1734091423","hasMoreContainedItems":false,"privileges":null,"properties":[{"id":"321Z07W_000BTQ8BF00000T","name":"StringProp","elementId":null,"type":"STRING","value":"BEG LLC","childProperties":null},{"id":"321Z07W_000BTR8BG000026","name":"NumberProp","elementId":null,"type":"NUMBER","value":"15.000000","childProperties":null},{"id":"321Z07W_000BTZ8BG00001K","name":"ArrayCustomStringProp","elementId":null,"type":"ARRAY","value":null,"childProperties":[{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000C","type":"STRING","value":"Michigan"},{"id":"321Z07W_000BV18BG000012","name":"ArrayStringProp","elementId":"321Z07X_000C3TH4500000E","type":"STRING","value":"Ohio"}]}],"containedFolders":[],"containedDocuments":[],"workflowItems":[]}
Sample 3 - queueId parameter included
Request URL
/v5/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
{"name":"Attachments Only","id":"301YVDD_00005MTV200000H","targetId":null,"typeId":"301YVDD_00005ETV2000006","folderType":"My Folder Type","locationId":"301YVCP_000294NLF000006","hasMoreContainedItems":false,"privileges":{"createShortcuts":true,"removeShortcuts":true,"delete":false,"view":true,"modifyCustomProperties":true,"moveInDrawer":true,"rename":false,"modifyDrawer":true,"modifyType":false,"modifyStatus":false},"properties":[],"containedFolders":[{"name":"Messages","id":"301YVDD_00005HTV2000006","targetId":null,"typeId":"301YVDD_00005BTV2000005"}],"containedDocuments":[{"id":"301YVDN_00017TPRF00006M","targetId":null,"name":"Financial Report.pdf","keys":{"drawer":"Default","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5","documentType":"Default"}}],"workflowItems":[{"id":"321YXCN_0000FX5B6000003"},{"id":"321YXCN_0000FX5B6000008"}]}

XML Samples

Sample 1
Request URL
/v5/folder/301YVDD_00005MTV200000H
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <folderType>My Folder Type</folderType>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems>
        <workflowItem>
            <id>321YXCN_0000FX5B6000003</id>
        </workflowItem>
        <workflowItem>
            <id>321YXCN_0000FX5B6000008</id>
        </workflowItem>
    </workflowItems>
    <privileges>
        <createShortcuts>true</createShortcuts>
        <removeShortcuts>true</removeShortcuts>
        <delete>false</delete>
        <view>true</view>
        <modifyCustomProperties>true</modifyCustomProperties>
        <moveInDrawer>true</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>true</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyStatus>false</modifyStatus>
    </privileges>
</folder>
Sample 2
Request URL
/v5/folder/321Z07W_000BTX8BG00001H
Response
<folder>
    <name>Scanned Docs</name>
    <id>321Z07W_000BTX8BG00001H</id>
    <typeId>321Z07W_000BTS8BG000014</typeId>
    <folderType>My Folder Type</folderType>
    <locationId>3000184723_1734091423</locationId>
    <properties>
        <property>
            <id>321Z07W_000BTQ8BF00000T</id>
            <name>StringProp</name>
            <type>STRING</type>
            <value>BEG LLC</value>
        </property>
        <property>
            <id>321Z07W_000BTR8BG000026</id>
            <name>NumberProp</name>
            <type>NUMBER</type>
            <value>15.000000</value>
        </property>
        <property>
            <id>321Z07W_000BTZ8BG00001K</id>
            <name>ArrayCustomStringProp</name>
            <type>ARRAY</type>
            <childProperties>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000C</elementId>
                    <type>STRING</type>
                    <value>Michigan</value>
                </childProperty>
                <childProperty>
                    <id>321Z07W_000BV18BG000012</id>
                    <name>ArrayStringProp</name>
                    <elementId>321Z07X_000C3TH4500000E</elementId>
                    <type>STRING</type>
                    <value>Ohio</value>
                </childProperty>
            </childProperties>
        </property>
    </properties>
    <containedFolders/>
    <containedDocuments/>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems/>
</folder>
Sample 3 - queueId parameter included
Request URL
/v5/folder/301YVDD_00005MTV200000H?queueId=321YZ46_000QEJ5XJ000021
Response
<folder>
    <name>Attachments Only</name>
    <id>301YVDD_00005MTV200000H</id>
    <typeId>301YVDD_00005ETV2000006</typeId>
    <folderType>My Folder Type</folderType>
    <locationId>301YVCP_000294NLF000006</locationId>
    <properties/>
    <containedFolders>
        <containedFolder>
            <name>Messages</name>
            <id>301YVDD_00005HTV2000006</id>
            <typeId>301YVDD_00005BTV2000005</typeId>
        </containedFolder>
    </containedFolders>
    <containedDocuments>
        <containedDocument>
            <id>301YVDN_00017TPRF00006M</id>
            <name>Financial Report.pdf</name>
            <keys>
                <drawer>Default</drawer>
                <field1>Field1</field1>
                <field2>Field2</field2>
                <field3>Field3</field3>
                <field4>Field4</field4>
                <field5>Field5</field5>
                <documentType>Default</documentType>
            </keys>
        </containedDocument>
    </containedDocuments>
    <hasMoreContainedItems>false</hasMoreContainedItems>
    <workflowItems>
        <workflowItem>
            <id>321YXCN_0000FX5B6000003</id>
        </workflowItem>
        <workflowItem>
            <id>321YXCN_0000FX5B6000008</id>
        </workflowItem>
    </workflowItems>
    <privileges>
        <createShortcuts>true</createShortcuts>
        <removeShortcuts>true</removeShortcuts>
        <delete>false</delete>
        <view>true</view>
        <modifyCustomProperties>true</modifyCustomProperties>
        <moveInDrawer>true</moveInDrawer>
        <rename>false</rename>
        <modifyDrawer>true</modifyDrawer>
        <modifyType>false</modifyType>
        <modifyStatus>false</modifyStatus>
    </privileges>
</folder>

FolderType (Version 1)

GET/v1/folderType Gets the folder type and related capture profile information stored in the ImageNow server.

Expand Operation / Collapse Operation

Gets the folder type and related capture profile information stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Response
Content
List of folderType [folderType]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

folderType type

Represents a folder type in a get all call

Field Name Data Type Expected Description
id String Yes The unique id for the folder type.
name String Yes The name of the folder type.

JSON Samples

Sample 1
Request URL
/v1/folderType
Response
{"folderTypes":[{"id":"301YV96_00000W4270000V5","name":"Expense Reports"},{"id":"301YV96_00000S4270001XY","name":"Payroll"}]}

XML Samples

Sample 1
Request URL
/v1/folderType
Response
<folderTypes>
    <folderType>
        <id>301YV96_00000W4270000V5</id>
        <name>Expense Reports</name>
    </folderType>
    <folderType>
        <id>301YV96_00000S4270001XY</id>
        <name>Payroll</name>
    </folderType>
</folderTypes>

GET/v1/folderType/{id} Gets the folder type and related capture profile information stored in the ImageNow server.

Expand Operation / Collapse Operation

Gets the folder type and related capture profile information stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Response
Content
folderType
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureProfile type

Represents a single Capture Profile.

Field Name Data Type Expected Description
id String Yes The ID of the capture profile
name String Yes The name of the capture profile
sourceType sourceType Yes The type of the source profile associated with this capture profile
childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
folderType type

Represents a folder type

Field Name Data Type Expected Description
captureProfiles List of captureProfile [captureProfile] Yes The capture profiles associated with the folder type.
id String Yes The unique id for the folder type.
name String Yes The name of the folder type.
properties List of typeProperty [property] Yes The properties associated with the folder type.
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
typeProperty type

Represents an ImageNow Property

Field Name Data Type Expected Description
required boolean Yes Is this property required or not.
children List of childProperty [child] No Children's list for composite and array type, it only has property id and isRequired field.
defaultValue String No The default value for this property
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of String [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes Property type, it's an enum type.
userGroupId String No User group id for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.

JSON Samples

Sample 1
Request URL
/v1/folderType/1000184724_1734091424
Response
{"id":"1000184724_1734091424","name":"Default","captureProfiles":[{"id":"301YVCC_0003NT7PN000002","name":"Import Agent","sourceType":"IMPORT_AGENT"}],"properties":[{"id":"301YVCC_0003NV7PC00000G","name":"Availability","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":null,"required":true,"listValueCandidates":["March 3","June 30","July 21"],"userList":null,"children":null,"formats":[]},{"id":"301YVCC_0003NV7PC00000P","name":"Another number","type":"NUMBER","userGroupId":null,"userGroupName":null,"defaultValue":"12.3456789","required":true,"listValueCandidates":null,"userList":null,"children":null,"formats":[]}]}

XML Samples

Sample 1
Request URL
/v1/folderType/1000184724_1734091424
Response
<folderType>
    <id>1000184724_1734091424</id>
    <name>Default</name>
    <captureProfiles>
        <captureProfile>
            <id>301YVCC_0003NT7PN000002</id>
            <name>Import Agent</name>
            <sourceType>IMPORT_AGENT</sourceType>
        </captureProfile>
    </captureProfiles>
    <properties>
        <property>
            <id>301YVCC_0003NV7PC00000G</id>
            <name>Availability</name>
            <type>LIST</type>
            <listValueCandidates>
                <listValueCandidate>March 3</listValueCandidate>
                <listValueCandidate>June 30</listValueCandidate>
                <listValueCandidate>July 21</listValueCandidate>
            </listValueCandidates>
            <formats/>
            <required>true</required>
        </property>
        <property>
            <id>301YVCC_0003NV7PC00000P</id>
            <name>Another number</name>
            <type>NUMBER</type>
            <defaultValue>12.3456789</defaultValue>
            <formats/>
            <required>true</required>
        </property>
    </properties>
</folderType>

FolderType (Version 2)

GET/v2/folderType Gets all folder types with privileges stored on the server.

Expand Operation / Collapse Operation

Gets all folder types with privileges stored on the server.

Available from version: 6.2.0

Call Properties

Query Parameter
includeInactive (optional) Include inactive folder types in the response. Default is false.
Response
Content
List of folderType [folderType]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

folderType type

Represents a folder type in a get all call

Field Name Data Type Expected Description
id String Yes The unique id for the folder type.
isActive Boolean Yes The active status of the folder type.
name String Yes The name of the folder type.
privileges folderTypePrivileges Yes Information about the user's privileges on the folder type.
folderTypePrivileges type

Full set of folder type privileges

Field Name Data Type Expected Description
manage Boolean Yes Indicates the user can manage the folder type.
use Boolean Yes Indicates the user can use folders of the folder type.

JSON Samples

Sample 1 - Retrieve all active folder types.
Request URL
/v2/folderType
Response
{"folderTypes":[{"id":"301YV96_00000W4270000V5","name":"Expense Reports","isActive":true,"privileges":{"manage":false,"use":true}}]}
Sample 2 - Retrieve all active and inactive folder types.
Request URL
/v2/folderType?includeInactive=true
Response
{"folderTypes":[{"id":"301YV96_00000W4270000V5","name":"Expense Reports","isActive":true,"privileges":{"manage":false,"use":true}},{"id":"301YV96_00000S4270001XY","name":"Payroll","isActive":false,"privileges":{"manage":true,"use":true}}]}

XML Samples

Sample 1 - Retrieve all active folder types.
Request URL
/v2/folderType
Response
<folderTypes>
    <folderType>
        <id>301YV96_00000W4270000V5</id>
        <name>Expense Reports</name>
        <isActive>true</isActive>
        <privileges>
            <manage>false</manage>
            <use>true</use>
        </privileges>
    </folderType>
</folderTypes>
Sample 2 - Retrieve all active and inactive folder types.
Request URL
/v2/folderType?includeInactive=true
Response
<folderTypes>
    <folderType>
        <id>301YV96_00000W4270000V5</id>
        <name>Expense Reports</name>
        <isActive>true</isActive>
        <privileges>
            <manage>false</manage>
            <use>true</use>
        </privileges>
    </folderType>
    <folderType>
        <id>301YV96_00000S4270001XY</id>
        <name>Payroll</name>
        <isActive>false</isActive>
        <privileges>
            <manage>true</manage>
            <use>true</use>
        </privileges>
    </folderType>
</folderTypes>

GET/v2/folderType/{id} Gets the folder type and related capture profile information stored in the server. Includes formId.

Expand Operation / Collapse Operation

Gets the folder type and related capture profile information stored in the server. Includes formId.

Available from version: 1.0.0

Call Properties

Response
Content
folderType
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureProfile type

Represents a single Capture Profile.

Field Name Data Type Expected Description
id String Yes The ID of the capture profile
name String Yes The name of the capture profile
sourceType sourceType Yes The type of the source profile associated with this capture profile
childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
folderType type

Represents a folder type. Includes formId

Field Name Data Type Expected Description
captureProfiles List of captureProfile [captureProfile] Yes The capture profiles associated with the folder type.
formId String No The unique form id for an associated form.
id String Yes The unique id for the folder type.
name String Yes The name of the folder type.
properties List of typeProperty [property] Yes The properties associated with the folder type.
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
sourceType enumeration

This table lists the possible values for the captureSourceType enumeration, which indicates the capture source for the capture profile.

Constant Name Description
FAX_AGENT The source for the capture profile is the Fax Agent type, which enables you to process incoming faxes directly into ImageNow by converting them into documents.
CONNECTOR_SAP The source for the capture profile is the SAP ArchiveLink type, which allows you to upload metadata stored in ImageNow to SAP software.
IMPORT_AGENT The source for the capture profile is the Import Agent type, which uses data available from the Import Agent to identify possible index values. ImageNow Import Agent, installed with the ImageNow Server, is responsible for handling all automated import routines on the server.
INTERACT_OUTLOOK The source for the capture profile is the Interact for Outlook type, which allows you to capture Microsoft Outlook email and attachments.
EXTERNAL The source for the capture profile is the External Interface type, which allows you to capture metadata from a variety of external sources.
MOBILE The source for the capture profile is the Mobile type, which allows you to capture metadata from a mobile device. This is undocumented in version of of the call to get all capture profiles.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
typeProperty type

Represents an ImageNow Property

Field Name Data Type Expected Description
required boolean Yes Is this property required or not.
children List of childProperty [child] No Children's list for composite and array type, it only has property id and isRequired field.
defaultValue String No The default value for this property
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of String [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes Property type, it's an enum type.
userGroupId String No User group id for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.

JSON Samples

Sample 1
Request URL
/v2/folderType/1000184724_1734091424
Response
{"id":"1000184724_1734091424","name":"Default","formId":"321YXCN_0000CL5B500001Z","captureProfiles":[{"id":"301YVCC_0003NT7PN000002","name":"Import Agent","sourceType":"IMPORT_AGENT"}],"properties":[{"id":"301YVCC_0003NV7PC00000G","name":"Availability","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":null,"required":true,"listValueCandidates":["March 3","June 30","July 21"],"userList":null,"children":null,"formats":[]},{"id":"301YVCC_0003NV7PC00000P","name":"Another number","type":"NUMBER","userGroupId":null,"userGroupName":null,"defaultValue":"12.3456789","required":true,"listValueCandidates":null,"userList":null,"children":null,"formats":[]}]}

XML Samples

Sample 1
Request URL
/v2/folderType/1000184724_1734091424
Response
<folderType>
    <id>1000184724_1734091424</id>
    <name>Default</name>
    <formId>321YXCN_0000CL5B500001Z</formId>
    <captureProfiles>
        <captureProfile>
            <id>301YVCC_0003NT7PN000002</id>
            <name>Import Agent</name>
            <sourceType>IMPORT_AGENT</sourceType>
        </captureProfile>
    </captureProfiles>
    <properties>
        <property>
            <id>301YVCC_0003NV7PC00000G</id>
            <name>Availability</name>
            <type>LIST</type>
            <listValueCandidates>
                <listValueCandidate>March 3</listValueCandidate>
                <listValueCandidate>June 30</listValueCandidate>
                <listValueCandidate>July 21</listValueCandidate>
            </listValueCandidates>
            <formats/>
            <required>true</required>
        </property>
        <property>
            <id>301YVCC_0003NV7PC00000P</id>
            <name>Another number</name>
            <type>NUMBER</type>
            <defaultValue>12.3456789</defaultValue>
            <formats/>
            <required>true</required>
        </property>
    </properties>
</folderType>

FolderTypeList (Version 1)

GET/v1/folderTypeList Gets all folder type lists.

Expand Operation / Collapse Operation

Gets all folder type lists.

Available from version: 1.0.0

Call Properties

Response
Content
List of folderTypeList [folderTypeList]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

folderTypeList type

Field Name Data Type Expected Description
description String Yes A description of the folder type list.
id String Yes The unique id of the folder type list.
name String Yes The name of the folder type list.

JSON Samples

Sample 1
Request URL
/v1/folderTypeList
Response
{"folderTypeLists":[{"id":"301YW2M_00003SRGV000006","name":"Accounting Folder Type List","description":"Folder Type List for the Accounting Department"},{"id":"301YW2M_00000HJ4700001P","name":"Marketing Folder Type List","description":"Folder Type List for the Marketing Department"}]}

XML Samples

Sample 1
Request URL
/v1/folderTypeList
Response
<folderTypeLists>
    <folderTypeList>
        <id>301YW2M_00003SRGV000006</id>
        <name>Accounting Folder Type List</name>
        <description>Folder Type List for the Accounting Department</description>
    </folderTypeList>
    <folderTypeList>
        <id>301YW2M_00000HJ4700001P</id>
        <name>Marketing Folder Type List</name>
        <description>Folder Type List for the Marketing Department</description>
    </folderTypeList>
</folderTypeLists>

GET/v1/folderTypeList/{id} Gets the folder type list that matches the given ID.

Expand Operation / Collapse Operation

Gets the folder type list that matches the given ID.

Available from version: 1.0.0

Call Properties

Response
Content
folderTypeList
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

folderType type

Field Name Data Type Expected Description
id String Yes The unique id of the folder type.
name String Yes The name of the folder type.
folderTypeList type

Represents a folder type list

Field Name Data Type Expected Description
description String Yes A description of the folder type list.
folderTypes List of folderType [folderType] Yes The folder types in the list.
id String Yes The unique id of the folder type list.
name String Yes The name of the folder type list.

JSON Samples

Sample 1
Request URL
/v1/folderTypeList/301YW2M_00000HJ4700001P
Response
{"id":"301YW2M_00000HJ4700001P","name":"Accounting Folder Type List","description":"Folder Type List for the Accounting department","folderTypes":[{"name":"Expense Report Folder Type","id":"301YW2J_00000JJ4700002R"},{"name":"Travel Voucher Folder Type","id":"301YW2J_00000JJ4700001G"}]}

XML Samples

Sample 1
Request URL
/v1/folderTypeList/301YW2M_00000HJ4700001P
Response
<folderTypeList>
    <id>301YW2M_00000HJ4700001P</id>
    <name>Accounting Folder Type List</name>
    <description>Folder Type List for the Accounting department</description>
    <folderTypes>
        <folderType>
            <name>Expense Report Folder Type</name>
            <id>301YW2J_00000JJ4700002R</id>
        </folderType>
        <folderType>
            <name>Travel Voucher Folder Type</name>
            <id>301YW2J_00000JJ4700001G</id>
        </folderType>
    </folderTypes>
</folderTypeList>

Form (Version 1)

GET/v1/form Gets all forms in ImageNow Server.

Expand Operation / Collapse Operation

Gets all forms in ImageNow Server.

Available from version: 1.0.0

Call Properties

Query Parameter
includeInactive (optional) Determines whether to include inactive forms or not, default is false
Response
Content
List of form [form]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

form type

Represents a form

Field Name Data Type Expected Description
active boolean Yes Represents if the form is active or not
description String Yes The form's description
id String Yes The Id of the form
name String Yes The name of the form

JSON Samples

Sample 1 - Request without the includeInactive parameter (inactive forms not returned)
Request URL
/v1/form
Response
{"forms":[{"id":"301YV7P_0006LW3XE000001","name":"Travel Form","description":"Company travel itinerary form","active":true}]}
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL
/v1/form?includeInactive=true
Response
{"forms":[{"id":"301YV88_000867L3Q000048","name":"Expense Report Form","description":"Expense Report Form for 2011","active":false},{"id":"301YV7P_0006LW3XE000001","name":"Travel Form","description":"Company travel itinerary form","active":true}]}

XML Samples

Sample 1 - Request without the includeInactive parameter (inactive forms not returned)
Request URL
/v1/form
Response
<forms>
    <form>
        <id>301YV7P_0006LW3XE000001</id>
        <name>Travel Form</name>
        <description>Company travel itinerary form</description>
        <active>true</active>
    </form>
</forms>
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL
/v1/form?includeInactive=true
Response
<forms>
    <form>
        <id>301YV88_000867L3Q000048</id>
        <name>Expense Report Form</name>
        <description>Expense Report Form for 2011</description>
        <active>false</active>
    </form>
    <form>
        <id>301YV7P_0006LW3XE000001</id>
        <name>Travel Form</name>
        <description>Company travel itinerary form</description>
        <active>true</active>
    </form>
</forms>

GET/v1/form/{id} Gets the form with a given ID from ImageNow Server.

Expand Operation / Collapse Operation

Gets the form with a given ID from ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
form
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

form type

Represents a form

Field Name Data Type Expected Description
active boolean Yes Represents if the form is active or not
description String Yes The form's description
id String Yes The Id of the form
name String Yes The name of the form

JSON Samples

Sample 1
Request URL
/v1/form/301YV7P_0006LW3XE000001
Response
{"id":"301YV7P_0006LW3XE000001","name":"Travel Form","description":"Company travel itinerary form","active":true}

XML Samples

Sample 1
Request URL
/v1/form/301YV7P_0006LW3XE000001
Response
<form>
    <id>301YV7P_0006LW3XE000001</id>
    <name>Travel Form</name>
    <description>Company travel itinerary form</description>
    <active>true</active>
</form>

DELETE/v1/form/{id}/document/{docId} Deletes the form data associated with a given document version and form.

Expand Operation / Collapse Operation

Deletes the form data associated with a given document version and form.

Available from version: 1.0.0

Call Properties

Path Parameters
docId The id of the document the form is from
Query Parameters
version The version of the document to get the form for
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2&queueId=429LO7X_0306LW3XE020003

XML Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2&queueId=429LO7X_0306LW3XE020003

GET/v1/form/{id}/document/{docId} Gets the form data associated with a given document version and form.

Expand Operation / Collapse Operation

Gets the form data associated with a given document version and form.

Available from version: 1.0.0

Call Properties

Path Parameters
docId The id of the document the form is from
Query Parameters
version The version of the document to get the form for
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Header
X-IntegrationServer-Resource-ID The id of object the form data is associated with

JSON Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2&queueId=429LO7X_0306LW3XE020003

XML Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000001?version=2&queueId=429LO7X_0306LW3XE020003

PUT/v1/form/{id}/document/{docId} Store form data to a specific version of a document.

Expand Operation / Collapse Operation

Store form data to a specific version of a document.

Available from version: 1.0.0

Call Properties

Path Parameters
docId The id of the document the form is for
Query Parameters
version The version of the document to submit the form for
queueId (optional) Verifies the user's process privilege for the workflow queue that the document is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content Binary
Content-Type
  • application/octet-stream
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000007?version=2
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000007?version=2&queueId=429LO7X_0306LW3XE020003

XML Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000007?version=2
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/document/301YV7P_0006LW3XE000007?version=2&queueId=429LO7X_0306LW3XE020003

DELETE/v1/form/{id}/folder/{folderId} Deletes the form data associated with the given folder and form.

Expand Operation / Collapse Operation

Deletes the form data associated with the given folder and form.

Available from version: 1.0.0

Call Properties

Path Parameters
folderId The id of the folder the form is from
Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G?queueId=429LO7X_0306LW3XE020003

XML Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G?queueId=429LO7X_0306LW3XE020003

GET/v1/form/{id}/folder/{folderId} Gets the form data associated with the given folder and form.

Expand Operation / Collapse Operation

Gets the form data associated with the given folder and form.

Available from version: 1.0.0

Call Properties

Path Parameters
folderId The id of the folder the form is from
Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's open content privilege for the drawer that the document is in.
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Header
X-IntegrationServer-Resource-ID The id of object the form data is associated with

JSON Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G?queueId=429LO7X_0306LW3XE020003

XML Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G?queueId=429LO7X_0306LW3XE020003

PUT/v1/form/{id}/folder/{folderId} Store form data to a folder.

Expand Operation / Collapse Operation

Store form data to a folder.

Available from version: 1.0.0

Call Properties

Path Parameters
folderId The id of the folder the form is for
Query Parameter
queueId (optional) Verifies the user's process privilege for the workflow queue that the folder is in. Overrides the user's open content privilege for the drawer that the document is in.
Request
Content Binary
Content-Type
  • application/octet-stream
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G?queueId=429LO7X_0306LW3XE020003

XML Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G
Sample 2 - with workflow queue id
Request URL
/v1/form/301YV3R_00053T1T900007S/folder/301YV7L_00093MJP900021G?queueId=429LO7X_0306LW3XE020003

GET/v1/form/{id}/presentation Gets all presentations for the given form in ImageNow Server.

Expand Operation / Collapse Operation

Gets all presentations for the given form in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
List of presentation [presentation]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

presentation type

Represents a form presentation file

Field Name Data Type Expected Description
id String Yes The presentation file's id
name String Yes The presentation file's name
privileges userPrivilege Yes The presentation file's user privileges for this form
userPrivilege type

Represents a form presentation user privilege

Field Name Data Type Expected Description
createPriv boolean Yes Indicates if this user has create privileges
deletePriv boolean Yes Indicates if this user has delete privileges
modifyPriv boolean Yes Indicates if this user has modify privileges
viewPriv boolean Yes Indicates if this user has view privileges

JSON Samples

Sample 1
Request URL
/v1/form/301YV7P_0006LW3XE000001/presentation
Response
{"presentations":[{"id":"301YV7N_00066B09G000001","name":"Travel Form Presentation 1","privileges":{"createPriv":true,"deletePriv":false,"modifyPriv":true,"viewPriv":true}},{"id":"301YV7N_0006DCJKQ000009","name":"Travel Form Presentation 2","privileges":{"createPriv":true,"deletePriv":false,"modifyPriv":false,"viewPriv":true}}]}

XML Samples

Sample 1
Request URL
/v1/form/301YV7P_0006LW3XE000001/presentation
Response
<presentations>
    <presentation>
        <id>301YV7N_00066B09G000001</id>
        <name>Travel Form Presentation 1</name>
        <privileges>
            <createPriv>true</createPriv>
            <deletePriv>false</deletePriv>
            <modifyPriv>true</modifyPriv>
            <viewPriv>true</viewPriv>
        </privileges>
    </presentation>
    <presentation>
        <id>301YV7N_0006DCJKQ000009</id>
        <name>Travel Form Presentation 2</name>
        <privileges>
            <createPriv>true</createPriv>
            <deletePriv>false</deletePriv>
            <modifyPriv>false</modifyPriv>
            <viewPriv>true</viewPriv>
        </privileges>
    </presentation>
</presentations>

GET/v1/form/{id}/presentation/{presentationId} Gets the information for all the files for the given presentation of the given form in ImageNow S...

Expand Operation / Collapse Operation

Gets the information for all the files for the given presentation of the given form in ImageNow Server.

Available from version: 1.0.0

Call Properties

Path Parameters
presentationId The id of the form presentation
Response
Content
presentation
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

dataDefinition type

Represents the data definition for a form presentation

Field Name Data Type Expected Description
id String Yes The id of the data definition
name String Yes The name of the data definition
presentation type

Represents a form presentation

Field Name Data Type Expected Description
dataDefinition dataDefinition Yes The data definition for the form presentation
supportFiles List of supportFile [supportFile] Yes The collection of support files
supportFile type

Represents a support file for a form presentation

Field Name Data Type Expected Description
id String Yes The id of the support file
name String Yes The name of the support file

JSON Samples

Sample 1
Request URL
/v1/form/301YV7P_0006LW3XE000001/presentation/301YV7N_00066B09G000001
Response
{"dataDefinition":{"id":"301YV7N_0006CZJKQ000007","name":"exported.xml"},"supportFiles":[{"id":"301YV7N_0006CYJKP000001","name":"exported.xsl"},{"id":"301YV7N_0006DCJKQ000008","name":"Forms.css"}]}

XML Samples

Sample 1
Request URL
/v1/form/301YV7P_0006LW3XE000001/presentation/301YV7N_00066B09G000001
Response
<presentation>
    <dataDefinition>
        <id>301YV7N_0006CZJKQ000007</id>
        <name>exported.xml</name>
    </dataDefinition>
    <supportFiles>
        <supportFile>
            <id>301YV7N_0006CYJKP000001</id>
            <name>exported.xsl</name>
        </supportFile>
        <supportFile>
            <id>301YV7N_0006DCJKQ000008</id>
            <name>Forms.css</name>
        </supportFile>
    </supportFiles>
</presentation>

GET/v1/form/{id}/presentation/{presentationId}/file/{fileId} Gets one physical file for the given presentation of the given form in ImageNow Server.

Expand Operation / Collapse Operation

Gets one physical file for the given presentation of the given form in ImageNow Server.

Available from version: 1.0.0

Call Properties

Path Parameters
presentationId The id of the form presentation
fileId The id of the form presentation file
Response
Content
Binary
Content-Type
  • application/octet-stream
Additional Headers
X-IntegrationServer-Resource-ID The id of the presentation file
X-IntegrationServer-Resource-Name The filename of the presentation file

JSON Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/presentation/301YV7L_00093MJP900001G/file/301YV7L_00093MJP900001

XML Samples

Sample 1
Request URL
/v1/form/301YV3R_00053T1T900007S/presentation/301YV7L_00093MJP900001G/file/301YV7L_00093MJP900001

HostedDocument (Version 1)

GET/v1/hostedDocument/{clientDocumentId} Retrieves the ImageNow document ID for the document that matches the document properties within t...

Expand Operation / Collapse Operation

Retrieves the ImageNow document ID for the document that matches the document properties within the hosted business application.

Available from version: 1.0.0

Call Properties

Path Parameter
clientDocumentId The client's ID for the document.
Query Parameters
clientType clientType The client hosting the document. The value is a string representation of the clientType enumeration.
clientInstanceId The client's instance ID for the document. For SAP, this value is the content repository.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

clientType enumeration

The clientType enumeration specifies the host business application for the document.

Constant Name Description
SAP The client is SAP.
document type

The document type specifies the ImageNow ID for the document.

Field Name Data Type Expected Description
id String Yes The unique ID of the ImageNow document.

JSON Samples

Sample 1
Request URL
/v1/hostedDocument/88978654?clientType=SAP&clientInstanceId=99372
Response
{"id":"301YW1E_00077ZVD900003H"}

XML Samples

Sample 1
Request URL
/v1/hostedDocument/88978654?clientType=SAP&clientInstanceId=99372
Response
<document>
    <id>301YW1E_00077ZVD900003H</id>
</document>

GET/v1/hostedDocument/{clientDocumentId}/clientLogob/{clientLogobId} Retrieves the ImageNow document ID and page ID for the document that matches the document propert...

Expand Operation / Collapse Operation

Retrieves the ImageNow document ID and page ID for the document that matches the document properties within the hosted business application.

Available from version: 1.0.0

Call Properties

Path Parameters
clientDocumentId The client's ID for the document.
clientLogobId The client's logob ID. For SAP, the value is the component ID.
Query Parameters
clientType clientType The client hosting the document. The value is a string representation of the clientType enumeration.
clientInstanceId The client's instance ID for the document. For SAP, this value is the content repository.
Response
Content
document
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

clientType enumeration

The clientType enumeration specifies the host business application for the document.

Constant Name Description
SAP The client is SAP.
document type

The document type identifies the ImageNow ID for the document.

Field Name Data Type Expected Description
id String Yes The unique ID of the ImageNow document.
page page Yes Information about the requested page
page type

The page type identifies the ImageNow ID for the page.

Field Name Data Type Expected Description
id String Yes The unique ID of the ImageNow page.

JSON Samples

Sample 1
Request URL
/v1/hostedDocument/308234234/clientLogob/9273948?clientType=SAP&clientInstanceId=99372
Response
{"id":"301YW1E_00077ZVD900003H","page":{"id":"302RWN_00042BHE900002M"}}

XML Samples

Sample 1
Request URL
/v1/hostedDocument/308234234/clientLogob/9273948?clientType=SAP&clientInstanceId=99372
Response
<document>
    <id>301YW1E_00077ZVD900003H</id>
    <page>
        <id>302RWN_00042BHE900002M</id>
    </page>
</document>

License (Version 1)

PUT/v1/license/featureToken This API call acquires a token for a feature license. The Integration Server response includes th...

Expand Operation / Collapse Operation

This API call acquires a token for a feature license. The Integration Server response includes the requested token in plain text.

Available from version: 1.0.0

Call Properties

Query Parameters
featureType licenseFeatureType The type of feature license for which a token is being requested.
hardwareFingerprint (optional) A hash value that uniquely identifies a machine or piece of hardware. This parameter is required for hardware based feature licenses.
Response
Content
None
Content-Type
  • text/plain

Call Types and Enumerations

licenseFeatureType enumeration

The following table lists the possible values for the featureType enumeration, which indicates the ImageNow feature license.

Constant Name Description
PERCEPTIVE_WEB_SCANNER The license application type for Perceptive Web Scanner.

JSON Samples

Sample 1 - Acquire a token for Perceptive Web Scanner.
Request URL
/v1/license/featureToken?featureType=PERCEPTIVE_WEB_SCANNER

XML Samples

Sample 1 - Acquire a token for Perceptive Web Scanner.
Request URL
/v1/license/featureToken?featureType=PERCEPTIVE_WEB_SCANNER

LicenseGroup (Version 1)

GET/v1/licenseGroup Get the License Group of this ImageNow Server.

Expand Operation / Collapse Operation

Get the License Group of this ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
licenseGroup
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

licenseGroup type

The licenseGroup type provides the unique ID of the ImageNow Server license group.

Field Name Data Type Expected Description
id String Yes The unique ID of the ImageNow Server license group from which the transaction originated.

JSON Samples

Sample 1
Request URL
/v1/licenseGroup
Response
{"id":"1309111878_342008672023"}

XML Samples

Sample 1
Request URL
/v1/licenseGroup
Response
<licenseGroup>
    <id>1309111878_342008672023</id>
</licenseGroup>

OsmReferenceSet (Version 1)

GET/v1/osmReferenceSet Get all of the system's configured reference sets.

Expand Operation / Collapse Operation

Get all of the system's configured reference sets.

Available from version: 1.0.0

Call Properties

Response
Content
osmReferenceSetList
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

osmReferenceSet type

Represents a reference set.

Field Name Data Type Expected Description
description String No The set's description.
id String Yes The system id of the set.
locationType setLocationType No The osm set's location type.
name String Yes The name of the set.
subobSetName String No The name of the sub-object set.
osmReferenceSetList type

List of reference sets.

Field Name Data Type Expected Description
osmReferenceSetList List of osmReferenceSet [osmReferenceSet] Yes A list of signatures and their status.
setLocationType enumeration

OSM set's location type.

Constant Name Description
UNDEFINED No retention status set.
ONLINE Set content is currently online.
NEARLINE Set is currently in a transition state.
OFFLINE Set is currently in an offline state.

JSON Samples

Sample 1
Request URL
/v1/osmReferenceSet
Response
{"osmReferenceSetList":[{"id":"321YZ58_00004SD2S000004","name":"osm_extant","description":"Contains content reference objects from extant system.","locationType":"UNDEFINED","subobSetName":""},{"id":"321YZ4F_00001CL37000004","name":"osm_reference_acuostore","description":"Contains content reference objects from acuostore imports.","locationType":null,"subobSetName":"osm_reference_acuostore_subobset"}]}

XML Samples

Sample 1
Request URL
/v1/osmReferenceSet
Response
<osmReferenceSetList>
    <osmReferenceSetList>
        <osmReferenceSet>
            <id>321YZ58_00004SD2S000004</id>
            <name>osm_extant</name>
            <description>Contains content reference objects from extant system.</description>
            <locationType>UNDEFINED</locationType>
            <subobSetName/>
        </osmReferenceSet>
        <osmReferenceSet>
            <id>321YZ4F_00001CL37000004</id>
            <name>osm_reference_acuostore</name>
            <description>Contains content reference objects from acuostore imports.</description>
            <subobSetName>osm_reference_acuostore_subobset</subobSetName>
        </osmReferenceSet>
    </osmReferenceSetList>
</osmReferenceSetList>

OutOfOffice (Version 1)

GET/v1/outOfOffice Retrieves all out of office instances for the user.

Expand Operation / Collapse Operation

Retrieves all out of office instances for the user.

Available from version: 1.0.0

Call Properties

Query Parameters
startDate (optional) The start of the date range to include out of office instances.
endDate (optional) The end of the date range to include out of office instances.
Response
Content
List of outOfOffice [outOfOffice]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

outOfOffice type

An out of office instance.

Field Name Data Type Expected Description
endTime Long No The time when the out of office ends. This value is optional and may not be set.
id String Yes The out of office instance ID.
reasonId String Yes The ID of the reason for the out of office.
startTime Long Yes The time when the out of office begins.

JSON Samples

Sample 1
Request URL
/v1/outOfOffice
Response
{"outOfOfficeInstances":[{"id":"321YZB2_0002T65FX000001","startTime":1443712040000,"endTime":1443798440000,"reasonId":"321YZB2_0002SX5FX000009"},{"id":"321YZB2_0002T65FX00000D","startTime":1448982440000,"endTime":1449760040000,"reasonId":"321YZB2_0002T15FX000005"}]}

XML Samples

Sample 1
Request URL
/v1/outOfOffice
Response
<outOfOfficeInstances>
    <outOfOffice>
        <id>321YZB2_0002T65FX000001</id>
        <startTime>1443712040000</startTime>
        <endTime>1443798440000</endTime>
        <reasonId>321YZB2_0002SX5FX000009</reasonId>
    </outOfOffice>
    <outOfOffice>
        <id>321YZB2_0002T65FX00000D</id>
        <startTime>1448982440000</startTime>
        <endTime>1449760040000</endTime>
        <reasonId>321YZB2_0002T15FX000005</reasonId>
    </outOfOffice>
</outOfOfficeInstances>

POST/v1/outOfOffice Creates an out of office instance for the user.

Expand Operation / Collapse Operation

Creates an out of office instance for the user.

Available from version: 1.0.0

Call Properties

Request
Content outOfOffice
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

outOfOffice type

The information used to create an out of office instance.

Field Name Data Type Expected Description
comment String No The comment associated with the out of office.
delegateUserId String No The delegate user's ID.
endTime Long No The time when the out of office ends.
reasonId String Yes The ID of the reason for the out of office.
startTime Long Yes The time when the out of office begins.

JSON Samples

Sample 1
Request URL
/v1/outOfOffice
Request
{"startTime":1443712040000,"endTime":1443798440000,"reasonId":"321YZB2_0002T75FX00000H","comment":"Going to the Bahamas!","delegateUserId":"321YZB2_0002T85FX00000X"}

XML Samples

Sample 1
Request URL
/v1/outOfOffice
Request
<outOfOffice>
    <startTime>1443712040000</startTime>
    <endTime>1443798440000</endTime>
    <reasonId>321YZB2_0002T75FX00000H</reasonId>
    <comment>Going to the Bahamas!</comment>
    <delegateUserId>321YZB2_0002T85FX00000X</delegateUserId>
</outOfOffice>

GET/v1/outOfOffice/reason Retrieves all out of office reasons.

Expand Operation / Collapse Operation

Retrieves all out of office reasons.

Available from version: 1.0.0

Call Properties

Response
Content
List of outOfOfficeReason [outOfOfficeReason]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

outOfOfficeReason type

An out of office reason.

Field Name Data Type Expected Description
id String Yes The reason's ID.
text String Yes The reason's text.

JSON Samples

Sample 1
Request URL
/v1/outOfOffice/reason
Response
{"outOfOfficeReasons":[{"id":"321YZB2_0002T15FX000005","text":"Leave of Absense"},{"id":"321YZB2_0002SX5FX000009","text":"Vacation"}]}

XML Samples

Sample 1
Request URL
/v1/outOfOffice/reason
Response
<outOfOfficeReasons>
    <outOfOfficeReason>
        <id>321YZB2_0002T15FX000005</id>
        <text>Leave of Absense</text>
    </outOfOfficeReason>
    <outOfOfficeReason>
        <id>321YZB2_0002SX5FX000009</id>
        <text>Vacation</text>
    </outOfOfficeReason>
</outOfOfficeReasons>

DELETE/v1/outOfOffice/{outOfOfficeId} Disables an out of office instance for the user if it's current or already passed, otherwise dele...

Expand Operation / Collapse Operation

Disables an out of office instance for the user if it's current or already passed, otherwise deletes it.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001

XML Samples

Sample 1
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001

GET/v1/outOfOffice/{outOfOfficeId} Retrieves a single out of office instance for the user.

Expand Operation / Collapse Operation

Retrieves a single out of office instance for the user.

Available from version: 1.0.0

Call Properties

Response
Content
outOfOffice
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

delegate type

The out of office delegate user information.

Field Name Data Type Expected Description
userId String Yes The delegate user's ID.
userName String Yes The delegate user's name.
outOfOffice type

An out of office instance.

Field Name Data Type Expected Description
comment String Yes The comment for the out of office instance.
creationUserInfo userInfo Yes The information about the user who created the out of office.
delegateUser delegate Yes The delegate user assigned to the out of office.
disablingUserInfo userInfo Yes The information about the user who disabled the out of office.
endTime Long No The time when the out of office ends. This value is optional and may not be set.
modifyingUserInfo userInfo Yes The information about the user who updated the out of office.
reasonId String Yes The ID of the reason for the out of office.
reasonText String Yes The text of the reason for the out of office.
startTime Long Yes The time when the out of office begins.
userInfo type

Information for a user associated with an out of office instance.

Field Name Data Type Expected Description
time Long Yes The time associated with the user's action.
userId String Yes The user's ID.
userName String Yes The user's name.

JSON Samples

Sample 1 - With a disabling user
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001
Response
{"startTime":1443712040000,"endTime":1443798440000,"reasonId":"321YZB2_0002SX5FX000009","reasonText":"Vacation","comment":"Going to the Bahamas!","creationUserInfo":{"userId":"321YZB2_0002T55FX00000C","userName":"aolson","time":1418224040000},"modifyingUserInfo":{"userId":"321YZB2_0002T75FX00000C","userName":"jstamos","time":1418310440000},"disablingUserInfo":{"userId":"321YZB2_0002T35FX00000D","userName":"bsaget","time":1448982440000},"delegateUser":{"userId":"321YZB2_0002T95FX00000D","userName":"mkolson"}}
Sample 2 - Without a disabling user
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001
Response
{"startTime":1443712040000,"endTime":1443798440000,"reasonId":"321YZB2_0002SX5FX000009","reasonText":"Vacation","comment":"Going to the Bahamas!","creationUserInfo":{"userId":"321YZB2_0002T55FX00000C","userName":"aolson","time":1418224040000},"modifyingUserInfo":{"userId":"321YZB2_0002T75FX00000C","userName":"jstamos","time":1418310440000},"disablingUserInfo":null,"delegateUser":{"userId":"321YZB2_0002T95FX00000D","userName":"mkolson"}}

XML Samples

Sample 1 - With a disabling user
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001
Response
<outOfOffice>
    <startTime>1443712040000</startTime>
    <endTime>1443798440000</endTime>
    <reasonId>321YZB2_0002SX5FX000009</reasonId>
    <reasonText>Vacation</reasonText>
    <comment>Going to the Bahamas!</comment>
    <creationUserInfo>
        <userId>321YZB2_0002T55FX00000C</userId>
        <userName>aolson</userName>
        <time>1418224040000</time>
    </creationUserInfo>
    <modifyingUserInfo>
        <userId>321YZB2_0002T75FX00000C</userId>
        <userName>jstamos</userName>
        <time>1418310440000</time>
    </modifyingUserInfo>
    <disablingUserInfo>
        <userId>321YZB2_0002T35FX00000D</userId>
        <userName>bsaget</userName>
        <time>1448982440000</time>
    </disablingUserInfo>
    <delegateUser>
        <userId>321YZB2_0002T95FX00000D</userId>
        <userName>mkolson</userName>
    </delegateUser>
</outOfOffice>
Sample 2 - Without a disabling user
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001
Response
<outOfOffice>
    <startTime>1443712040000</startTime>
    <endTime>1443798440000</endTime>
    <reasonId>321YZB2_0002SX5FX000009</reasonId>
    <reasonText>Vacation</reasonText>
    <comment>Going to the Bahamas!</comment>
    <creationUserInfo>
        <userId>321YZB2_0002T55FX00000C</userId>
        <userName>aolson</userName>
        <time>1418224040000</time>
    </creationUserInfo>
    <modifyingUserInfo>
        <userId>321YZB2_0002T75FX00000C</userId>
        <userName>jstamos</userName>
        <time>1418310440000</time>
    </modifyingUserInfo>
    <delegateUser>
        <userId>321YZB2_0002T95FX00000D</userId>
        <userName>mkolson</userName>
    </delegateUser>
</outOfOffice>

PUT/v1/outOfOffice/{outOfOfficeId} Updates an out of office instance for the user.

Expand Operation / Collapse Operation

Updates an out of office instance for the user.

Available from version: 1.0.0

Call Properties

Request
Content outOfOffice
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

outOfOffice type

The information used to update an out of office instance.

Field Name Data Type Expected Description
comment String No The comment associated with the out of office.
delegateUserId String No The delegate user's ID.
endTime Long No The time when the out of office ends.
reasonId String Yes The ID of the reason associated with the out of office.
startTime Long Yes The time when the out of office starts.

JSON Samples

Sample 1
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001
Request
{"startTime":1443712040000,"endTime":1443798440000,"reasonId":"321YZB2_0002SX5FX000009","comment":"Going to the Bahamas!","delegateUserId":"321YZB2_0002T95FX00000D"}

XML Samples

Sample 1
Request URL
/v1/outOfOffice/321YZB2_0002T65FX000001
Request
<outOfOffice>
    <startTime>1443712040000</startTime>
    <endTime>1443798440000</endTime>
    <reasonId>321YZB2_0002SX5FX000009</reasonId>
    <comment>Going to the Bahamas!</comment>
    <delegateUserId>321YZB2_0002T95FX00000D</delegateUserId>
</outOfOffice>

Property (Version 1)

GET/v1/property Gets all properties stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets all properties stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Query Parameters
type type (optional) Limit the results to only those properties with the given type
listValuesLimit (optional) Limit the number of list property values returned. Can be set to ALL, NONE, or a non-negative integer
Response
Content
List of property [property]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
property type

Represents an ImageNow Property

Field Name Data Type Expected Description
children List of childProperty [child] No Children's list for composite and array type, it only has property id and isRequired field.
defaultValue String No The default value for this property
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of String [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes Property type, it's an enum type.
userGroupId String No User group id for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1 - Get all properties
Request URL
/v1/property
Response
{"properties":[{"id":"301YVDD_000053TV2000001","name":"Date Property","type":"DATE","userGroupId":null,"userGroupName":null,"defaultValue":"1328641832942","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.day","value":"true"},{"key":"show.month","value":"true"},{"key":"show.weekday","value":"false"},{"key":"show.year","value":"true"}]},{"id":"301YVDD_00005KTV2000002","name":"Flag Property","type":"FLAG","userGroupId":null,"userGroupName":null,"defaultValue":"false","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"true.value","value":"True"},{"key":"false.value","value":"False"}]},{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":["Item 1","Item 2","Item 3","Item 4"],"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YVDD_000053TV2000002","name":"Number Property","type":"NUMBER","userGroupId":null,"userGroupName":null,"defaultValue":"42.000000","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"format.name","value":"decimal"},{"key":"decimal.type","value":"fixed"},{"key":"decimal.places","value":"2"},{"key":"punctuate.at.thousands","value":"true"}]},{"id":"301YVDD_00005NTV2000002","name":"String Property","type":"STRING","userGroupId":null,"userGroupName":null,"defaultValue":"Hello World","listValueCandidates":null,"userList":null,"children":null,"formats":[]},{"id":"301YW26_0003JK3QB000008","name":"Array Property","type":"ARRAY","userGroupId":null,"userGroupName":null,"defaultValue":null,"listValueCandidates":null,"userList":null,"children":[{"id":"301YVDD_000053TV2000001","isRequired":false},{"id":"301YVDD_000053TV2000002","isRequired":false}],"formats":[]}]}
Sample 2 - Get all NUMBER properties
Request URL
/v1/property?type=NUMBER
Response
{"properties":[{"id":"301YVDD_000053TV2000002","name":"Number Property","type":"NUMBER","userGroupId":null,"userGroupName":null,"defaultValue":"42.000000","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"format.name","value":"decimal"},{"key":"decimal.type","value":"fixed"},{"key":"decimal.places","value":"2"},{"key":"punctuate.at.thousands","value":"true"}]}]}
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL
/v1/property?listValuesLimit=ALL
Response
{"properties":[{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":["Item 1","Item 2","Item 3","Item 4","Item 5","Item 6","Item 7"],"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user4","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user5","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user4","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user5","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]}]}
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL
/v1/property?listValuesLimit=NONE
Response
{"properties":[{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":null,"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]}]}
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL
/v1/property?listValuesLimit=3
Response
{"properties":[{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":["Item 1","Item 2","Item 3"],"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]}]}

XML Samples

Sample 1 - Get all properties
Request URL
/v1/property
Response
<properties>
    <property>
        <id>301YVDD_000053TV2000001</id>
        <name>Date Property</name>
        <type>DATE</type>
        <defaultValue>1328641832942</defaultValue>
        <formats>
            <format>
                <key>show.day</key>
                <value>true</value>
            </format>
            <format>
                <key>show.month</key>
                <value>true</value>
            </format>
            <format>
                <key>show.weekday</key>
                <value>false</value>
            </format>
            <format>
                <key>show.year</key>
                <value>true</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_00005KTV2000002</id>
        <name>Flag Property</name>
        <type>FLAG</type>
        <defaultValue>false</defaultValue>
        <formats>
            <format>
                <key>true.value</key>
                <value>True</value>
            </format>
            <format>
                <key>false.value</key>
                <value>False</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <listValueCandidates>
            <listValueCandidate>Item 1</listValueCandidate>
            <listValueCandidate>Item 2</listValueCandidate>
            <listValueCandidate>Item 3</listValueCandidate>
            <listValueCandidate>Item 4</listValueCandidate>
        </listValueCandidates>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_000053TV2000002</id>
        <name>Number Property</name>
        <type>NUMBER</type>
        <defaultValue>42.000000</defaultValue>
        <formats>
            <format>
                <key>format.name</key>
                <value>decimal</value>
            </format>
            <format>
                <key>decimal.type</key>
                <value>fixed</value>
            </format>
            <format>
                <key>decimal.places</key>
                <value>2</value>
            </format>
            <format>
                <key>punctuate.at.thousands</key>
                <value>true</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_00005NTV2000002</id>
        <name>String Property</name>
        <type>STRING</type>
        <defaultValue>Hello World</defaultValue>
        <formats/>
    </property>
    <property>
        <id>301YW26_0003JK3QB000008</id>
        <name>Array Property</name>
        <type>ARRAY</type>
        <children>
            <child>
                <id>301YVDD_000053TV2000001</id>
                <isRequired>false</isRequired>
            </child>
            <child>
                <id>301YVDD_000053TV2000002</id>
                <isRequired>false</isRequired>
            </child>
        </children>
        <formats/>
    </property>
</properties>
Sample 2 - Get all NUMBER properties
Request URL
/v1/property?type=NUMBER
Response
<properties>
    <property>
        <id>301YVDD_000053TV2000002</id>
        <name>Number Property</name>
        <type>NUMBER</type>
        <defaultValue>42.000000</defaultValue>
        <formats>
            <format>
                <key>format.name</key>
                <value>decimal</value>
            </format>
            <format>
                <key>decimal.type</key>
                <value>fixed</value>
            </format>
            <format>
                <key>decimal.places</key>
                <value>2</value>
            </format>
            <format>
                <key>punctuate.at.thousands</key>
                <value>true</value>
            </format>
        </formats>
    </property>
</properties>
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL
/v1/property?listValuesLimit=ALL
Response
<properties>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <listValueCandidates>
            <listValueCandidate>Item 1</listValueCandidate>
            <listValueCandidate>Item 2</listValueCandidate>
            <listValueCandidate>Item 3</listValueCandidate>
            <listValueCandidate>Item 4</listValueCandidate>
            <listValueCandidate>Item 5</listValueCandidate>
            <listValueCandidate>Item 6</listValueCandidate>
            <listValueCandidate>Item 7</listValueCandidate>
        </listValueCandidates>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
            <user>
                <userName>user4</userName>
            </user>
            <user>
                <userName>user5</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
            <user>
                <userName>user4</userName>
            </user>
            <user>
                <userName>user5</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
</properties>
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL
/v1/property?listValuesLimit=NONE
Response
<properties>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
</properties>
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL
/v1/property?listValuesLimit=3
Response
<properties>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <listValueCandidates>
            <listValueCandidate>Item 1</listValueCandidate>
            <listValueCandidate>Item 2</listValueCandidate>
            <listValueCandidate>Item 3</listValueCandidate>
        </listValueCandidates>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
</properties>

GET/v1/property/{id} Gets the property stored in ImageNow Server that matches the ID.

Expand Operation / Collapse Operation

Gets the property stored in ImageNow Server that matches the ID.

Available from version: 1.0.0

Call Properties

Response
Content
property
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value

The following table shows the possible key-value pairs for custom property formats.

Custom Property Format Type Key Description
Date format show.day If true, the date format includes the day of the month.
show.month If true, the date format includes the month.
show.weekday If true, the date format includes the weekday.
show.year If true, the date format includes the year.
Flag format false.value If the defaultValue element is false for a flag custom property, this is the string value of the label, such as "No" or "False".
true.value If the defaultValue element is true for a flag custom property, this is the string value of the label, such as "Yes" or "True".
Number format currency.type If the number is currency (as opposed to decimal), this indicates the currency type. Possible values are USD, GBP, and EUR.
decimal.places For the decimal type (as opposed to currency), this indicates the number of decimal places that the number can have, ranging from 0 to 5. Note that the currency number type fixes the decimal at two places.
decimal.type Indicates whether the decimal type is fixed or varying.
format.name The name of the number format in your ImageNow system.
punctuate.at.thousands Indicates how to handle numbers greater than 999. If true, numbers greater than 999 use the thousands separator (such as 10,000.00). If false, they do not (such as 10000.00). Integration Server indicates whether to use the thousands separator, and then the client determines which separator to use based on the locale (such as 10,000.00 or 10.000,00).
User format show.prefix For display formats other than user name, this indicates whether to display an honorific, such as Mr., when displaying this custom property. A value of true indicates to include an honorific, while value of false indicates to exclude an honorific.
show.suffix For display formats other than user name, this indicates whether to display a suffix, such as Jr., when displaying this custom property. A value of true indicates to include a suffix, while a value of false indicates to exclude a suffix.
username.format This indicates the display format for the user custom property. The propertyNameFormat enumeration contains the possible values for this data element.
property type

Represents an ImageNow Property

Field Name Data Type Expected Description
children List of childProperty [child] No Children's list for composite and array type, it only has property id and isRequired field.
defaultValue String No The default value for this property
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of String [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes Property type, it's an enum type.
userGroupId String No User group id for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v1/property/301YVDD_000053TV2000001
Response
{"id":"301YVDD_000053TV2000001","name":"Date Property","type":"DATE","userGroupId":null,"userGroupName":null,"defaultValue":"1328641832942","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.day","value":"true"},{"key":"show.month","value":"true"},{"key":"show.weekday","value":"false"},{"key":"show.year","value":"true"}]}

XML Samples

Sample 1
Request URL
/v1/property/301YVDD_000053TV2000001
Response
<property>
    <id>301YVDD_000053TV2000001</id>
    <name>Date Property</name>
    <type>DATE</type>
    <defaultValue>1328641832942</defaultValue>
    <formats>
        <format>
            <key>show.day</key>
            <value>true</value>
        </format>
        <format>
            <key>show.month</key>
            <value>true</value>
        </format>
        <format>
            <key>show.weekday</key>
            <value>false</value>
        </format>
        <format>
            <key>show.year</key>
            <value>true</value>
        </format>
    </formats>
</property>

Property (Version 2)

GET/v2/property Gets all properties stored in the server. Includes IDs of list candidates.

Expand Operation / Collapse Operation

Gets all properties stored in the server. Includes IDs of list candidates.

Available from version: 1.0.0

Call Properties

Query Parameters
type type (optional) Limit the results to only those properties with the given type.
listValuesLimit (optional) Limit the number of list property values returned. Can be set to ALL, NONE, or a non-negative integer.
Response
Content
List of property [property]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
property type

Represents a property.

Field Name Data Type Expected Description
children List of childProperty [child] No Children's list for composite and array type; contains property ID and isRequired field.
defaultValue String No The default value for this property.
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of keyValuePair [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes The type enumeration of the property.
userGroupId String No User group ID for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1 - Get all properties
Request URL
/v2/property
Response
{"properties":[{"id":"301YVDD_000053TV2000001","name":"Date Property","type":"DATE","userGroupId":null,"userGroupName":null,"defaultValue":"1328641832942","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.day","value":"true"},{"key":"show.month","value":"true"},{"key":"show.weekday","value":"false"},{"key":"show.year","value":"true"}]},{"id":"301YVDD_00005KTV2000002","name":"Flag Property","type":"FLAG","userGroupId":null,"userGroupName":null,"defaultValue":"false","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"true.value","value":"True"},{"key":"false.value","value":"False"}]},{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":[{"key":"301YVDD_00005KLM2000004","value":"Item 1"},{"key":"301YVDD_00005KLM2000005","value":"Item 2"},{"key":"301YVDD_00005KLM2000006","value":"Item 3"},{"key":"301YVDD_00005KLM2000007","value":"Item 4"}],"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YVDD_000053TV2000002","name":"Number Property","type":"NUMBER","userGroupId":null,"userGroupName":null,"defaultValue":"42.000000","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"format.name","value":"decimal"},{"key":"decimal.type","value":"fixed"},{"key":"decimal.places","value":"2"},{"key":"punctuate.at.thousands","value":"true"}]},{"id":"301YVDD_00005NTV2000002","name":"String Property","type":"STRING","userGroupId":null,"userGroupName":null,"defaultValue":"Hello World","listValueCandidates":null,"userList":null,"children":null,"formats":[]},{"id":"301YW26_0003JK3QB000008","name":"Array Property","type":"ARRAY","userGroupId":null,"userGroupName":null,"defaultValue":null,"listValueCandidates":null,"userList":null,"children":[{"id":"301YVDD_000053TV2000001","isRequired":false},{"id":"301YVDD_000053TV2000002","isRequired":false}],"formats":[]}]}
Sample 2 - Get all NUMBER properties
Request URL
/v2/property?type=NUMBER
Response
{"properties":[{"id":"301YVDD_000053TV2000002","name":"Number Property","type":"NUMBER","userGroupId":null,"userGroupName":null,"defaultValue":"42.000000","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"format.name","value":"decimal"},{"key":"decimal.type","value":"fixed"},{"key":"decimal.places","value":"2"},{"key":"punctuate.at.thousands","value":"true"}]}]}
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL
/v2/property?listValuesLimit=ALL
Response
{"properties":[{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":[{"key":"301YVDD_00005KLM2000004","value":"Item 1"},{"key":"301YVDD_00005KLM2000005","value":"Item 2"},{"key":"301YVDD_00005KLM2000006","value":"Item 3"},{"key":"301YVDD_00005KLM2000007","value":"Item 4"},{"key":"301YVDD_00005KLM2000008","value":"Item 5"},{"key":"301YVDD_00005KLM2000009","value":"Item 6"},{"key":"301YVDD_00005KLM2000010","value":"Item 7"}],"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user4","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user5","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user4","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user5","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]}]}
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL
/v2/property?listValuesLimit=NONE
Response
{"properties":[{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":null,"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]}]}
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL
/v2/property?listValuesLimit=3
Response
{"properties":[{"id":"301YVDD_00005MTV2000005","name":"List Property","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":"","listValueCandidates":[{"key":"301YVDD_00005KLM2000004","value":"Item 1"},{"key":"301YVDD_00005KLM2000005","value":"Item 2"},{"key":"301YVDD_00005KLM2000006","value":"Item 3"}],"userList":null,"children":null,"formats":[]},{"id":"301YW21_0003DVEZR00000M","name":"User Group Property","type":"USER_GROUP","userGroupId":"all","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]},{"id":"301YW21_0003DVEZR00000H","name":"User List Property","type":"USER_LIST","userGroupId":"","userGroupName":"","defaultValue":"user2","listValueCandidates":null,"userList":[{"userName":"user1","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user2","lastName":null,"firstName":null,"prefix":null,"suffix":null},{"userName":"user3","lastName":null,"firstName":null,"prefix":null,"suffix":null}],"children":null,"formats":[{"key":"show.prefix","value":"false"},{"key":"show.suffix","value":"false"},{"key":"username.format","value":"USER_NAME"}]}]}

XML Samples

Sample 1 - Get all properties
Request URL
/v2/property
Response
<properties>
    <property>
        <id>301YVDD_000053TV2000001</id>
        <name>Date Property</name>
        <type>DATE</type>
        <defaultValue>1328641832942</defaultValue>
        <formats>
            <format>
                <key>show.day</key>
                <value>true</value>
            </format>
            <format>
                <key>show.month</key>
                <value>true</value>
            </format>
            <format>
                <key>show.weekday</key>
                <value>false</value>
            </format>
            <format>
                <key>show.year</key>
                <value>true</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_00005KTV2000002</id>
        <name>Flag Property</name>
        <type>FLAG</type>
        <defaultValue>false</defaultValue>
        <formats>
            <format>
                <key>true.value</key>
                <value>True</value>
            </format>
            <format>
                <key>false.value</key>
                <value>False</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <listValueCandidates>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000004</key>
                <value>Item 1</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000005</key>
                <value>Item 2</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000006</key>
                <value>Item 3</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000007</key>
                <value>Item 4</value>
            </listValueCandidate>
        </listValueCandidates>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_000053TV2000002</id>
        <name>Number Property</name>
        <type>NUMBER</type>
        <defaultValue>42.000000</defaultValue>
        <formats>
            <format>
                <key>format.name</key>
                <value>decimal</value>
            </format>
            <format>
                <key>decimal.type</key>
                <value>fixed</value>
            </format>
            <format>
                <key>decimal.places</key>
                <value>2</value>
            </format>
            <format>
                <key>punctuate.at.thousands</key>
                <value>true</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YVDD_00005NTV2000002</id>
        <name>String Property</name>
        <type>STRING</type>
        <defaultValue>Hello World</defaultValue>
        <formats/>
    </property>
    <property>
        <id>301YW26_0003JK3QB000008</id>
        <name>Array Property</name>
        <type>ARRAY</type>
        <children>
            <child>
                <id>301YVDD_000053TV2000001</id>
                <isRequired>false</isRequired>
            </child>
            <child>
                <id>301YVDD_000053TV2000002</id>
                <isRequired>false</isRequired>
            </child>
        </children>
        <formats/>
    </property>
</properties>
Sample 2 - Get all NUMBER properties
Request URL
/v2/property?type=NUMBER
Response
<properties>
    <property>
        <id>301YVDD_000053TV2000002</id>
        <name>Number Property</name>
        <type>NUMBER</type>
        <defaultValue>42.000000</defaultValue>
        <formats>
            <format>
                <key>format.name</key>
                <value>decimal</value>
            </format>
            <format>
                <key>decimal.type</key>
                <value>fixed</value>
            </format>
            <format>
                <key>decimal.places</key>
                <value>2</value>
            </format>
            <format>
                <key>punctuate.at.thousands</key>
                <value>true</value>
            </format>
        </formats>
    </property>
</properties>
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL
/v2/property?listValuesLimit=ALL
Response
<properties>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <listValueCandidates>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000004</key>
                <value>Item 1</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000005</key>
                <value>Item 2</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000006</key>
                <value>Item 3</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000007</key>
                <value>Item 4</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000008</key>
                <value>Item 5</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000009</key>
                <value>Item 6</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000010</key>
                <value>Item 7</value>
            </listValueCandidate>
        </listValueCandidates>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
            <user>
                <userName>user4</userName>
            </user>
            <user>
                <userName>user5</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
            <user>
                <userName>user4</userName>
            </user>
            <user>
                <userName>user5</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
</properties>
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL
/v2/property?listValuesLimit=NONE
Response
<properties>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
</properties>
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL
/v2/property?listValuesLimit=3
Response
<properties>
    <property>
        <id>301YVDD_00005MTV2000005</id>
        <name>List Property</name>
        <type>LIST</type>
        <defaultValue/>
        <listValueCandidates>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000004</key>
                <value>Item 1</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000005</key>
                <value>Item 2</value>
            </listValueCandidate>
            <listValueCandidate>
                <key>301YVDD_00005KLM2000006</key>
                <value>Item 3</value>
            </listValueCandidate>
        </listValueCandidates>
        <formats/>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000M</id>
        <name>User Group Property</name>
        <type>USER_GROUP</type>
        <userGroupId>all</userGroupId>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
    <property>
        <id>301YW21_0003DVEZR00000H</id>
        <name>User List Property</name>
        <type>USER_LIST</type>
        <userGroupId/>
        <userGroupName/>
        <defaultValue>user2</defaultValue>
        <userList>
            <user>
                <userName>user1</userName>
            </user>
            <user>
                <userName>user2</userName>
            </user>
            <user>
                <userName>user3</userName>
            </user>
        </userList>
        <formats>
            <format>
                <key>show.prefix</key>
                <value>false</value>
            </format>
            <format>
                <key>show.suffix</key>
                <value>false</value>
            </format>
            <format>
                <key>username.format</key>
                <value>USER_NAME</value>
            </format>
        </formats>
    </property>
</properties>

GET/v2/property/{id} Gets the property stored in the server that matches the ID. Includes IDs of list candidates.

Expand Operation / Collapse Operation

Gets the property stored in the server that matches the ID. Includes IDs of list candidates.

Available from version: 1.0.0

Call Properties

Response
Content
property
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
property type

Represents a property.

Field Name Data Type Expected Description
children List of childProperty [child] No Children's list for composite and array type; contains property ID and isRequired field.
defaultValue String No The default value for this property.
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of keyValuePair [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes The type enumeration of the property.
userGroupId String No User group ID for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v2/property/301YVDD_000053TV2000001
Response
{"id":"301YVDD_000053TV2000001","name":"Date Property","type":"DATE","userGroupId":null,"userGroupName":null,"defaultValue":"1328641832942","listValueCandidates":null,"userList":null,"children":null,"formats":[{"key":"show.day","value":"true"},{"key":"show.month","value":"true"},{"key":"show.weekday","value":"false"},{"key":"show.year","value":"true"}]}

XML Samples

Sample 1
Request URL
/v2/property/301YVDD_000053TV2000001
Response
<property>
    <id>301YVDD_000053TV2000001</id>
    <name>Date Property</name>
    <type>DATE</type>
    <defaultValue>1328641832942</defaultValue>
    <formats>
        <format>
            <key>show.day</key>
            <value>true</value>
        </format>
        <format>
            <key>show.month</key>
            <value>true</value>
        </format>
        <format>
            <key>show.weekday</key>
            <value>false</value>
        </format>
        <format>
            <key>show.year</key>
            <value>true</value>
        </format>
    </formats>
</property>

ReasonList (Version 1)

GET/v1/reasonList/{id}/reason Gets the reason list stored in the ImageNow server.

Expand Operation / Collapse Operation

Gets the reason list stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Response
Content
List of reason [reason]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

reason type

Field Name Data Type Expected Description
id String Yes
text String Yes

JSON Samples

Sample 1
Request URL
/v1/reasonList/301YW2H_000004J3M000004/reason
Response
{"reasons":[{"id":"301YW2H_000004J3M000005","text":"I have reviewed this document."},{"id":"301YW2H_000004J3M000006","text":"I am the author of this document."}]}

XML Samples

Sample 1
Request URL
/v1/reasonList/301YW2H_000004J3M000004/reason
Response
<reasons>
    <reason>
        <id>301YW2H_000004J3M000005</id>
        <text>I have reviewed this document.</text>
    </reason>
    <reason>
        <id>301YW2H_000004J3M000006</id>
        <text>I am the author of this document.</text>
    </reason>
</reasons>

Record (Version 1)

POST/v1/record Declares a document as a record with user provided metadata or by using a capture profile.

Expand Operation / Collapse Operation

Declares a document as a record with user provided metadata or by using a capture profile.

Available from version: 1.0.0

Call Properties

Request
Content declareRecordInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
captureProfile type

References an external capture profile used to declare a document as a record.

Field Name Data Type Expected Description
captureProfileId String Yes The ID of the capture profile to be used in the record declaration process.
dictionaryValues List of keyValuePair [dictionaryValue] Yes Values of the dictionary fields specified in the application plan referenced by the given capture profile.
conflictItem type

An instance that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
declareRecordInfo type

Contains metadata used to declare a document as a record. To declare using a capture profile use the captureProfile type, otherwise use the recordInfo type.

Field Name Data Type Expected Description
captureProfileInfo captureProfile Yes The external capture profile used to declare a document as a record.
documentId String Yes The ID of the document that will be declared as a record.
recordInfo recordInfo Yes The metadata used to declare a document as a record.
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
RECORD_FOLDER A record folder.
RECORD A record.
FILE_PLAN A file plan.
RECORD_CATEGORY A record category.
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
recordInfo type

Contains metadata used to declare a document as a record.

Field Name Data Type Expected Description
action actionType Yes The action to take when a conflict occurs during record declaration.
keys recordKeys Yes The record keys.
metadata recordMetadata Yes The record specific metadata.
path path Yes The path to an existing record category or record folder in which the record will be declared. Each element in the array must contain the name of a container. The first item in the array must be the name of the file plan, the second element in the array must be the name of the record category. Any (optional) item after that must be the name of an existing record folder.
properties List of propertyInstance [property] Yes Custom properties assigned to the record type specified in the record keys.
recordName String Yes The name to assign to the newly declared record.
recordKeys type

Full set of record keys

Field Name Data Type Expected Description
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
filePlanName String Yes The name of the file plan.
recordTypeName String Yes The name of the record type.
recordMetadata type

Contains record specific metadata.

Field Name Data Type Expected Description
addressees String No The name of the organizations or individuals to whom a record is addressed.
author String Yes The person, office, or designated position responsible for creation or issuance of a record.
format String No The computer file format of the record.
mediaType String No The material or environment on which the record information is inscribed.
originatingOrganization String Yes The originating organization of the record.
otherAddressees String No Additional addressees.
publicationDate Long Yes The date and time the record was published.
receivedDate Long No The date the addressees received the record.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1 - Declare a document as a record with user provided metadata with a response indicating a naming conflict.
Request URL
/v1/record
Request
{"documentId":"321YY2M_00050YC7V000009","recordInfo":{"recordName":"Record Name","keys":{"recordTypeName":"Record Type Name","filePlanName":"File Plan Name","field1":"Field1","field2":"Field2","field3":"Field3","field4":"Field4","field5":"Field5"},"path":{"pathSegments":["File Plan Name","Record Category Name","Record Folder Name"]},"metadata":{"author":"Administrator","originatingOrganization":"Research and Development","publicationDate":1330062170020,"receivedDate":1330062170020,"addressees":"HR","otherAddressees":"Sales","mediaType":"Digital","format":"tif"},"action":"RETURN_CONFLICTS","properties":[{"id":"301YVDX_0003RW4Y1000001","type":"DATE","value":"476064000000","childProperties":null},{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null},{"id":"309JRTG_0003RI2I1000001","type":"USER_GROUP","value":"Group1","childProperties":null}]},"captureProfileInfo":null}
Response
{"instanceType":"RECORD","id":"321YYB6_000RNC3MV000001"}
Sample 2 - Declare a document as a record using a capture profile.
Request URL
/v1/record
Request
{"documentId":"321YY2M_00050YC7V000009","recordInfo":null,"captureProfileInfo":{"captureProfileId":"321YXDB_00009H3B1000005","dictionaryValues":[{"key":"Color","value":"Red"},{"key":"Size","value":"Large"}]}}

XML Samples

Sample 1 - Declare a document as a record with user provided metadata with a response indicating a naming conflict.
Request URL
/v1/record
Request
<declareRecordInfo>
    <documentId>321YY2M_00050YC7V000009</documentId>
    <recordInfo>
        <recordName>Record Name</recordName>
        <keys>
            <recordTypeName>Record Type Name</recordTypeName>
            <filePlanName>File Plan Name</filePlanName>
            <field1>Field1</field1>
            <field2>Field2</field2>
            <field3>Field3</field3>
            <field4>Field4</field4>
            <field5>Field5</field5>
        </keys>
        <path>
            <pathSegments>
                <pathSegment>File Plan Name</pathSegment>
                <pathSegment>Record Category Name</pathSegment>
                <pathSegment>Record Folder Name</pathSegment>
            </pathSegments>
        </path>
        <metadata>
            <author>Administrator</author>
            <originatingOrganization>Research and Development</originatingOrganization>
            <publicationDate>1330062170020</publicationDate>
            <receivedDate>1330062170020</receivedDate>
            <addressees>HR</addressees>
            <otherAddressees>Sales</otherAddressees>
            <mediaType>Digital</mediaType>
            <format>tif</format>
        </metadata>
        <properties>
            <property>
                <id>301YVDX_0003RW4Y1000001</id>
                <type>DATE</type>
                <value>476064000000</value>
            </property>
            <property>
                <id>309EZHR_0003RM5H1000001</id>
                <type>FLAG</type>
                <value>0</value>
            </property>
            <property>
                <id>309JRTG_0003RI2I1000001</id>
                <type>USER_GROUP</type>
                <value>Group1</value>
            </property>
        </properties>
        <action>RETURN_CONFLICTS</action>
    </recordInfo>
</declareRecordInfo>
Response
<conflictItem>
    <instanceType>RECORD</instanceType>
    <id>321YYB6_000RNC3MV000001</id>
</conflictItem>
Sample 2 - Declare a document as a record using a capture profile.
Request URL
/v1/record
Request
<declareRecordInfo>
    <documentId>321YY2M_00050YC7V000009</documentId>
    <captureProfileInfo>
        <captureProfileId>321YXDB_00009H3B1000005</captureProfileId>
        <dictionaryValues>
            <dictionaryValue>
                <key>Color</key>
                <value>Red</value>
            </dictionaryValue>
            <dictionaryValue>
                <key>Size</key>
                <value>Large</value>
            </dictionaryValue>
        </dictionaryValues>
    </captureProfileInfo>
</declareRecordInfo>

POST/v1/record/searchResult Searches for folders that satisfy the given criteria.

Expand Operation / Collapse Operation

Searches for folders that satisfy the given criteria.

Available from version: 1.0.0

Call Properties

Request
Content recordSearchCriteria
Content-Types
  • application/xml
  • application/json
Response
Content
recordSearchResult
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

containerSearch type

Contains the text to search for and whether it should be a contains with or starts with search

Field Name Data Type Expected Description
searchText String Yes The text to use when searching.
startsWith Boolean Yes The flag for whether or not to use a contains with or starts with search.
path type

The path to the record

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes The list of path segments that make up the path
record type

The returned record

Field Name Data Type Expected Description
id String Yes The id of the returned record.
name String Yes The name of the returned record.
path path Yes The path of the returned record.
recordSearchCriteria type

Contains the search criteria for the container and the record

Field Name Data Type Expected Description
containerSearch containerSearch No The search criteria for record containers.
recordSearch containerSearch No The search criteria for records.
recordSearchResult type

Search result containing the records and whether there are more records matching the search than returned

Field Name Data Type Expected Description
hasMore Boolean Yes A flag that indicates whether or not there are more search results.
records List of record [record] Yes A list of records returned using the search criteria.

JSON Samples

Sample 1
Request URL
/v1/record/searchResult
Request
{"containerSearch":{"searchText":"Reports","startsWith":true},"recordSearch":{"searchText":"Expense","startsWith":false}}
Response
{"records":[{"id":"001YVD8_000233WSQ000002","name":"Expense Report YTD","path":{"pathSegments":["Company Expense Reports","Reports Assesment"]}},{"id":"991YVD8_000233WSQ000002","name":"Expense Report - May","path":{"pathSegments":["Company Expense Reports","Reports Due"]}},{"id":"001YVD8_023455SQ000002","name":"Expense Audit","path":{"pathSegments":["Company Expense Reports","Reports Review"]}}],"hasMore":false}
Sample 2
Request URL
/v1/record/searchResult
Request
{"containerSearch":{"searchText":"Budget analysis","startsWith":true},"recordSearch":null}
Response
{"records":[{"id":"004YVD8_00e04455Q000002","name":"Contractor budget review","path":{"pathSegments":["Company Expense Reports","Budget analysis internal"]}},{"id":"221YVD8_000233WSQ003302","name":"Consultants budget review","path":{"pathSegments":["Company Expense Reports","Budget analysis public"]}},{"id":"111YVD8_023455SQ000002","name":"Planned expense budget","path":{"pathSegments":["Company Expense Reports","Budget analysis internal review"]}}],"hasMore":false}
Sample 3
Request URL
/v1/record/searchResult
Request
{"containerSearch":null,"recordSearch":{"searchText":"Equipment Orders","startsWith":false}}
Response
{"records":[{"id":"001YVD8_000233WSQ000002","name":"Equipment Orders YTD","path":{"pathSegments":["Company Revenue Reports","Reports Assesment"]}},{"id":"991YVD8_000233WSQ000002","name":"Equipment Orders - May","path":{"pathSegments":["Company Revenue Reports","Reports Due"]}},{"id":"001YVD8_023455SQ000002","name":"Equipment Orders","path":{"pathSegments":["Company Revenue Reports","Reports Review"]}}],"hasMore":false}

XML Samples

Sample 1
Request URL
/v1/record/searchResult
Request
<recordSearchCriteria>
    <containerSearch>
        <searchText>Reports</searchText>
        <startsWith>true</startsWith>
    </containerSearch>
    <recordSearch>
        <searchText>Expense</searchText>
        <startsWith>false</startsWith>
    </recordSearch>
</recordSearchCriteria>
Response
<recordSearchResult>
    <records>
        <record>
            <id>001YVD8_000233WSQ000002</id>
            <name>Expense Report YTD</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Expense Reports</pathSegment>
                    <pathSegment>Reports Assesment</pathSegment>
                </pathSegments>
            </path>
        </record>
        <record>
            <id>991YVD8_000233WSQ000002</id>
            <name>Expense Report - May</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Expense Reports</pathSegment>
                    <pathSegment>Reports Due</pathSegment>
                </pathSegments>
            </path>
        </record>
        <record>
            <id>001YVD8_023455SQ000002</id>
            <name>Expense Audit</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Expense Reports</pathSegment>
                    <pathSegment>Reports Review</pathSegment>
                </pathSegments>
            </path>
        </record>
    </records>
    <hasMore>false</hasMore>
</recordSearchResult>
Sample 2
Request URL
/v1/record/searchResult
Request
<recordSearchCriteria>
    <containerSearch>
        <searchText>Budget analysis</searchText>
        <startsWith>true</startsWith>
    </containerSearch>
</recordSearchCriteria>
Response
<recordSearchResult>
    <records>
        <record>
            <id>004YVD8_00e04455Q000002</id>
            <name>Contractor budget review</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Expense Reports</pathSegment>
                    <pathSegment>Budget analysis internal</pathSegment>
                </pathSegments>
            </path>
        </record>
        <record>
            <id>221YVD8_000233WSQ003302</id>
            <name>Consultants budget review</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Expense Reports</pathSegment>
                    <pathSegment>Budget analysis public</pathSegment>
                </pathSegments>
            </path>
        </record>
        <record>
            <id>111YVD8_023455SQ000002</id>
            <name>Planned expense budget</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Expense Reports</pathSegment>
                    <pathSegment>Budget analysis internal review</pathSegment>
                </pathSegments>
            </path>
        </record>
    </records>
    <hasMore>false</hasMore>
</recordSearchResult>
Sample 3
Request URL
/v1/record/searchResult
Request
<recordSearchCriteria>
    <recordSearch>
        <searchText>Equipment Orders</searchText>
        <startsWith>false</startsWith>
    </recordSearch>
</recordSearchCriteria>
Response
<recordSearchResult>
    <records>
        <record>
            <id>001YVD8_000233WSQ000002</id>
            <name>Equipment Orders YTD</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Revenue Reports</pathSegment>
                    <pathSegment>Reports Assesment</pathSegment>
                </pathSegments>
            </path>
        </record>
        <record>
            <id>991YVD8_000233WSQ000002</id>
            <name>Equipment Orders - May</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Revenue Reports</pathSegment>
                    <pathSegment>Reports Due</pathSegment>
                </pathSegments>
            </path>
        </record>
        <record>
            <id>001YVD8_023455SQ000002</id>
            <name>Equipment Orders</name>
            <path>
                <pathSegments>
                    <pathSegment>Company Revenue Reports</pathSegment>
                    <pathSegment>Reports Review</pathSegment>
                </pathSegments>
            </path>
        </record>
    </records>
    <hasMore>false</hasMore>
</recordSearchResult>

DELETE/v1/record/{id} Delete a record from the server.

Expand Operation / Collapse Operation

Delete a record from the server.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/record/301YW1E_00077ZVD900003H

XML Samples

Sample 1
Request URL
/v1/record/301YW1E_00077ZVD900003H

GET/v1/record/{id} Get record properties.

Expand Operation / Collapse Operation

Get record properties.

Available from version: 1.0.0

Call Properties

Response
Content
recordInfo
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
recordInfo type

Represents the data contained inside of a record.

Field Name Data Type Expected Description
keys recordKeys Yes The record's keys.
metadata recordMetadata Yes Record related metadata fields.
name String Yes Name of the record.
path path Yes The path to the record.
properties List of propertyInstance [property] Yes Custom property information about the record.
recordKeys type

Full set of record keys

Field Name Data Type Expected Description
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
filePlanName String Yes The name of the file plan.
recordTypeName String Yes The name of the record type.
recordMetadata type

Contains record specific metadata.

Field Name Data Type Expected Description
addressees String No The name of the organizations or individuals to whom a record is addressed.
author String Yes The person, office, or designated position responsible for creation or issuance of a record.
format String No The computer file format of the record.
mediaType String No The material or environment on which the record information is inscribed.
originatingOrganization String Yes The originating organization of the record.
otherAddressees String No Additional addressees.
publicationDate Long Yes The date and time the record was published.
receivedDate Long No The date the addressees received the record.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v1/record/321YYD1_00017S9HB00000V
Response
{"name":"RecordName","path":null,"keys":{"recordTypeName":"RecordTypeName","filePlanName":"Fileplan 1","field1":"field1","field2":"field2","field3":"field3","field4":"field4","field5":"field5"},"metadata":{"author":"bob smith","originatingOrganization":"Lexmark","publicationDate":1330035361033,"receivedDate":1330035361033,"addressees":"Addreesses","otherAddressees":"otherAddreeses","mediaType":"file","format":".png"},"properties":[{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}

XML Samples

Sample 1
Request URL
/v1/record/321YYD1_00017S9HB00000V
Response
<recordInfo>
    <name>RecordName</name>
    <keys>
        <recordTypeName>RecordTypeName</recordTypeName>
        <filePlanName>Fileplan 1</filePlanName>
        <field1>field1</field1>
        <field2>field2</field2>
        <field3>field3</field3>
        <field4>field4</field4>
        <field5>field5</field5>
    </keys>
    <metadata>
        <author>bob smith</author>
        <originatingOrganization>Lexmark</originatingOrganization>
        <publicationDate>1330035361033</publicationDate>
        <receivedDate>1330035361033</receivedDate>
        <addressees>Addreesses</addressees>
        <otherAddressees>otherAddreeses</otherAddressees>
        <mediaType>file</mediaType>
        <format>.png</format>
    </metadata>
    <properties>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
</recordInfo>

PUT/v1/record/{id} Update record properties. Missing information will clear out that portion of the record.

Expand Operation / Collapse Operation

Update record properties. Missing information will clear out that portion of the record.

Available from version: 1.0.0

Call Properties

Request
Content recordInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
conflictItem (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

actionType enumeration

The action to preform during the move. APPEND, REPLACE, or RETURN_CONFLICTS (default)

Constant Name Description
RETURN_CONFLICTS Return conflicts on failure.
APPEND Append if there is a conflict.
REPLACE Replace if there is a conflict
conflictItem type

An instance that is causing conflict with an operation

Field Name Data Type Expected Description
id String Yes The unique ID of the conflicting item.
instanceType instanceType Yes The type of the conflicting item.
instanceType enumeration

Constant Name Description
DOCUMENT A document.
FOLDER A folder.
DOCUMENT_SHORTCUT A shortcut to a document.
FOLDER_SHORTCUT A shortcut to a folder.
ROOT_TYPE A drawer.
RECORD_FOLDER A record folder.
RECORD A record.
FILE_PLAN A file plan.
RECORD_CATEGORY A record category.
path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
recordInfo type

Represents the data contained inside of a record.

Field Name Data Type Expected Description
action actionType Yes The action to take when a conflict occurs during record declaration.
keys recordKeys Yes The records keys.
metadata recordMetadata Yes Record related metadata fields
name String Yes Name of the record.
path path Yes The path to an existing record category or record folder in which the record will be declared. Each element in the array must contain the name of a container. The first item in the array must be the name of the file plan, the second element in the array must be the name of the record category. Any (optional) item after that must be the name of an existing record folder.
properties List of propertyInstance [property] No Custom property information about the record
recordKeys type

Full set of record keys

Field Name Data Type Expected Description
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
filePlanName String Yes The name of the file plan.
recordTypeName String Yes The name of the record type.
recordMetadata type

Contains record specific metadata.

Field Name Data Type Expected Description
addressees String No The name of the organizations or individuals to whom a record is addressed.
author String Yes The person, office, or designated position responsible for creation or issuance of a record.
format String No The computer file format of the record.
mediaType String No The material or environment on which the record information is inscribed.
originatingOrganization String Yes The originating organization of the record.
otherAddressees String No Additional addressees.
publicationDate Long Yes The date and time the record was published.
receivedDate Long No The date the addressees received the record.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v1/record/321YYD1_00017S9HB00000V
Request
{"name":"RecordName","path":{"pathSegments":["Fileplan 1","Record Category Level 1","Record Folder Level 2","Record Folder Level 3"]},"keys":{"recordTypeName":"RecordTypeName","filePlanName":"Fileplan 1","field1":"field1","field2":"field2","field3":"field3","field4":"field4","field5":"field5"},"metadata":{"author":"bob smith","originatingOrganization":"Lexmark","publicationDate":1330035361033,"receivedDate":1330035361033,"addressees":"Addreesses","otherAddressees":"otherAddreeses","mediaType":"file","format":".png"},"action":"RETURN_CONFLICTS","properties":[{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]}
Response
{"instanceType":"RECORD","id":"321YYB6_000RNC3MV000001"}

XML Samples

Sample 1
Request URL
/v1/record/321YYD1_00017S9HB00000V
Request
<recordInfo>
    <name>RecordName</name>
    <path>
        <pathSegments>
            <pathSegment>Fileplan 1</pathSegment>
            <pathSegment>Record Category Level 1</pathSegment>
            <pathSegment>Record Folder Level 2</pathSegment>
            <pathSegment>Record Folder Level 3</pathSegment>
        </pathSegments>
    </path>
    <keys>
        <recordTypeName>RecordTypeName</recordTypeName>
        <filePlanName>Fileplan 1</filePlanName>
        <field1>field1</field1>
        <field2>field2</field2>
        <field3>field3</field3>
        <field4>field4</field4>
        <field5>field5</field5>
    </keys>
    <metadata>
        <author>bob smith</author>
        <originatingOrganization>Lexmark</originatingOrganization>
        <publicationDate>1330035361033</publicationDate>
        <receivedDate>1330035361033</receivedDate>
        <addressees>Addreesses</addressees>
        <otherAddressees>otherAddreeses</otherAddressees>
        <mediaType>file</mediaType>
        <format>.png</format>
    </metadata>
    <properties>
        <property>
            <id>309EZHR_0003RM5H1000001</id>
            <type>FLAG</type>
            <value>0</value>
        </property>
    </properties>
    <action>RETURN_CONFLICTS</action>
</recordInfo>
Response
<conflictItem>
    <instanceType>RECORD</instanceType>
    <id>321YYB6_000RNC3MV000001</id>
</conflictItem>

DELETE/v1/record/{id}/page/{pageId} Deletes a page from a record.

Expand Operation / Collapse Operation

Deletes a page from a record.

Available from version: 1.0.0

Call Properties

Path Parameters
id The ID of the record you want to remove a page from.
pageId The ID of the page within the record that you want to delete.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/record/301YW1E_00077ZVD900003H/page/301YW1E_000745ZVD906006G

XML Samples

Sample 1
Request URL
/v1/record/301YW1E_00077ZVD900003H/page/301YW1E_000745ZVD906006G

GET/v1/record/{id}/page/{pageId}/file Gets the file associated with a page of a record stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets the file associated with a page of a record stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Path Parameters
id The record containing the page you want to render
pageId The page within the record you want to render
Response
Content
None
Content-Type
  • */*
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.

JSON Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/file

XML Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/file

GET/v1/record/{id}/page/{pageId}/preview Gets the preview file associated with a page of a record.

Expand Operation / Collapse Operation

Gets the preview file associated with a page of a record.

Available from version: 1.0.0

Call Properties

Path Parameters
id The ID of the record that you want to preview.
pageId The page within the record that you want to preview.
Query Parameters
maxHeight (optional) The maximum height for the preview image.
maxWidth (optional) The maximum width for the preview image.
pageNumber (optional) The sub-page number to preview.
Response
Content
None
Content-Type
  • */*
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.
X-IntegrationServer-Available-Pages The total number of sub-pages that exist for the given page.
X-IntegrationServer-Content-Is-Preview True if the response body contains a preview, false if the body contains the original image.

JSON Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1

XML Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/preview?maxWidth=600&maxHeight=400&pageNumber=1

GET/v1/record/{id}/page/{pageId}/rendition Retrieves a .png rendition of the page specified by pageId from the record specified by id. To us...

Expand Operation / Collapse Operation

Retrieves a .png rendition of the page specified by pageId from the record specified by id. To use this call, File Conversion Service is required.

Available from version: 1.0.0

Call Properties

Path Parameters
id The ID of the record you want to render
pageId The page within the record you want to render
Query Parameters
maxWidth (optional) The maximum width (in pixels) of the rendered page
maxHeight (optional) The maximum height (in pixels) of the rendered page
pageNumber (optional) Page number to retrieve from within a multi-page TIFF
Response
Content
None
Content-Type
  • */*
Additional Headers
X-IntegrationServer-Available-Pages Number of available pages for a mulitple page rendition
X-IntegrationServer-Original-Orientation Orientation of the page source
X-IntegrationServer-Original-Height Height of the page source
X-IntegrationServer-Original-Width Width of the page source
X-IntegrationServer-Original-X-DPI X DPI of the page source
X-IntegrationServer-Original-Y-DPI Y DPI of the page source
X-IntegrationServer-Rendition-Height Height of the page rendition
X-IntegrationServer-Rendition-Width Width of the page rendition
X-IntegrationServer-Content-Is-Rendition Page was successfully rendered
X-IntegrationServer-Original-File-Type File type of the page source
X-IntegrationServer-Original-File-Size File size of the page source

JSON Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?maxWidth=600&maxHeight=600&pageNumber=1

XML Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/rendition?maxWidth=600&maxHeight=600&pageNumber=1

GET/v1/record/{id}/page/{pageId}/thumbnail Gets the thumbnail file associated with a page stored in the server.

Expand Operation / Collapse Operation

Gets the thumbnail file associated with a page stored in the server.

Available from version: 1.0.0

Call Properties

Path Parameters
id The record that contains the page you want to preview.
pageId The page within the record that you want to preview.
Response
Content
None
Content-Type
  • */*
Additional Headers
X-IntegrationServer-Resource-ID The unique ID of the page.
X-IntegrationServer-Resource-Name The name of the page.

JSON Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail

XML Samples

Sample 1
Request URL
/v1/record/301YW1J_000782VD90000B8/page/301YW1J_000782VD90000BC/thumbnail

Record (Version 2)

GET/v2/record/{id} Get record properties with page info.

Expand Operation / Collapse Operation

Get record properties with page info.

Available from version: 1.0.0

Call Properties

Response
Content
recordInfo
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

page type

Represents information about a page.

Field Name Data Type Expected Description
extension String Yes The page's file extension.
id String Yes The page's ID.
label String Yes The page's label.
name String Yes The page's name.
pageNumber Integer Yes The page's sequence number.
path type

Represents the path of a given instance in the folder hieracrchy.

Field Name Data Type Expected Description
pathSegments List of String [pathSegment] Yes A list of path segments identifying the location of the instance in the folder hierarchy.
propertyChildInstance type

Represents a server property child instance

Field Name Data Type Expected Description
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
propertyInstance type

Represents a server property instance

Field Name Data Type Expected Description
childProperties List of propertyChildInstance [childProperty] Yes If type is array or composite, the values of the sub-properties
id String Yes The property's id
type type Yes The property's type
value String Yes The property's value
recordInfo type

Represents the data contained inside of a record.

Field Name Data Type Expected Description
keys recordKeys Yes The record's keys.
metadata recordMetadata Yes Record related metadata fields.
name String Yes Name of the record.
path path Yes The path to the record.
properties List of propertyInstance [property] Yes Custom property information about the record.
recordInfo type

Represents the data contained inside of a record including the information about its pages.

Field Name Data Type Expected Description
pages List of page [page] Yes Information about the pages in the record.
recordInfo recordInfo Yes Information about the record.
recordKeys type

Full set of record keys

Field Name Data Type Expected Description
field1 String No The value of field1.
field2 String No The value of field2.
field3 String No The value of field3.
field4 String No The value of field4.
field5 String No The value of field5.
filePlanName String Yes The name of the file plan.
recordTypeName String Yes The name of the record type.
recordMetadata type

Contains record specific metadata.

Field Name Data Type Expected Description
addressees String No The name of the organizations or individuals to whom a record is addressed.
author String Yes The person, office, or designated position responsible for creation or issuance of a record.
format String No The computer file format of the record.
mediaType String No The material or environment on which the record information is inscribed.
originatingOrganization String Yes The originating organization of the record.
otherAddressees String No Additional addressees.
publicationDate Long Yes The date and time the record was published.
receivedDate Long No The date the addressees received the record.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type

JSON Samples

Sample 1
Request URL
/v2/record/321YYD1_00017S9HB00000V
Response
{"recordInfo":{"name":"RecordName","path":{"pathSegments":["Fileplan 1","Record Category Level 1","Record Folder Level 2","Record Folder Level 3"]},"keys":{"recordTypeName":"RecordTypeName","filePlanName":"Fileplan 1","field1":"field1","field2":"field2","field3":"field3","field4":"field4","field5":"field5"},"metadata":{"author":"Bob Smith","originatingOrganization":"Lexmark","publicationDate":1330035361033,"receivedDate":1330035361033,"addressees":"Addressees","otherAddressees":"otherAddressees","mediaType":"file","format":".png"},"properties":[{"id":"309EZHR_0003RM5H1000001","type":"FLAG","value":"0","childProperties":null}]},"pages":[{"id":"309EZHR_0003RM5H1000002","name":"PageName","label":"Label","extension":"png","pageNumber":1}]}

XML Samples

Sample 1
Request URL
/v2/record/321YYD1_00017S9HB00000V
Response
<recordInfo>
    <recordInfo>
        <name>RecordName</name>
        <path>
            <pathSegments>
                <pathSegment>Fileplan 1</pathSegment>
                <pathSegment>Record Category Level 1</pathSegment>
                <pathSegment>Record Folder Level 2</pathSegment>
                <pathSegment>Record Folder Level 3</pathSegment>
            </pathSegments>
        </path>
        <keys>
            <recordTypeName>RecordTypeName</recordTypeName>
            <filePlanName>Fileplan 1</filePlanName>
            <field1>field1</field1>
            <field2>field2</field2>
            <field3>field3</field3>
            <field4>field4</field4>
            <field5>field5</field5>
        </keys>
        <metadata>
            <author>Bob Smith</author>
            <originatingOrganization>Lexmark</originatingOrganization>
            <publicationDate>1330035361033</publicationDate>
            <receivedDate>1330035361033</receivedDate>
            <addressees>Addressees</addressees>
            <otherAddressees>otherAddressees</otherAddressees>
            <mediaType>file</mediaType>
            <format>.png</format>
        </metadata>
        <properties>
            <property>
                <id>309EZHR_0003RM5H1000001</id>
                <type>FLAG</type>
                <value>0</value>
            </property>
        </properties>
    </recordInfo>
    <pages>
        <page>
            <id>309EZHR_0003RM5H1000002</id>
            <name>PageName</name>
            <label>Label</label>
            <extension>png</extension>
            <pageNumber>1</pageNumber>
        </page>
    </pages>
</recordInfo>

RecordCaptureGroup (Version 1)

POST/v1/recordCaptureGroup/ Creates a capture group that can be used to capture a group of pages into one or more records

Expand Operation / Collapse Operation

Creates a capture group that can be used to capture a group of pages into one or more records

Available from version: 1.0.0

Call Properties

Request
Content recordCaptureGroupInfo
Content-Types
  • application/xml
  • application/json
Response
Content
recordCaptureGroup
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

context type

Field Name Data Type Expected Description
filePlan String Yes
folderContexts List of folderContext [folderContext] Yes
recordCategory folderContext Yes
recordContext recordContext No
folderContext type

Field Name Data Type Expected Description
folderTypeName String Yes
location String Yes
name String Yes
propertyValues List of propertyValue [propertyValue] Yes
folderContext type

Field Name Data Type Expected Description
name String Yes
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
propertyValue type

Field Name Data Type Expected Description
id String Yes
value String Yes
recordCaptureGroup type

Field Name Data Type Expected Description
context context Yes
id String Yes
recordCaptureGroupInfo type

Field Name Data Type Expected Description
captureProfileId String Yes
sourceMetadataPairs List of keyValuePair [sourceMetadataPair] No
recordContext type

Field Name Data Type Expected Description
addressees String Yes
author String Yes
datePublished Long Yes
dateReceived Long Yes
field1 String Yes
field2 String Yes
field3 String Yes
field4 String Yes
field5 String Yes
format String Yes
mediaType String Yes
originatingOrg String Yes
otherAddressees String Yes
propertyValues List of propertyValue [propertyValue] Yes
recordName String Yes
recordType String Yes

JSON Samples

Sample 1
Request URL
/v1/recordCaptureGroup
Request
{"captureProfileId":"301YW2V_0000CFHJ6000003","sourceMetadataPairs":[{"key":"interact.outlook.property.to","value":"admin@domain.com"},{"key":"interact.outlook.property.from","value":"user@domain.com"}]}
Response
{"id":"","context":{"filePlan":"Default","recordCategory":{"name":"Budgets"},"folderContexts":[{"name":"2013 Budgets","folderTypeName":"Default","propertyValues":[],"location":""}],"recordContext":{"field1":"Field 1","field2":"Field 2","field3":"Field 3","field4":"Field 4","field5":"Field 5","recordType":"Default","recordName":"September Budget","propertyValues":[],"datePublished":1378762321,"author":"John Smith","originatingOrg":"Smith Enterprises","dateReceived":1378762321,"addressees":"","otherAddressees":"","mediaType":"XLS","format":""}}}

XML Samples

Sample 1
Request URL
/v1/recordCaptureGroup
Request
<recordCaptureGroupInfo>
    <captureProfileId>301YW2V_0000CFHJ6000003</captureProfileId>
    <sourceMetadataPairs>
        <sourceMetadataPair>
            <key>interact.outlook.property.to</key>
            <value>admin@domain.com</value>
        </sourceMetadataPair>
        <sourceMetadataPair>
            <key>interact.outlook.property.from</key>
            <value>user@domain.com</value>
        </sourceMetadataPair>
    </sourceMetadataPairs>
</recordCaptureGroupInfo>
Response
<recordCaptureGroup>
    <id/>
    <context>
        <filePlan>Default</filePlan>
        <recordCategory>
            <name>Budgets</name>
        </recordCategory>
        <folderContexts>
            <folderContext>
                <name>2013 Budgets</name>
                <folderTypeName>Default</folderTypeName>
                <propertyValues/>
                <location/>
            </folderContext>
        </folderContexts>
        <recordContext>
            <field1>Field 1</field1>
            <field2>Field 2</field2>
            <field3>Field 3</field3>
            <field4>Field 4</field4>
            <field5>Field 5</field5>
            <recordType>Default</recordType>
            <recordName>September Budget</recordName>
            <propertyValues/>
            <datePublished>1378762321</datePublished>
            <author>John Smith</author>
            <originatingOrg>Smith Enterprises</originatingOrg>
            <dateReceived>1378762321</dateReceived>
            <addressees/>
            <otherAddressees/>
            <mediaType>XLS</mediaType>
            <format/>
        </recordContext>
    </context>
</recordCaptureGroup>

PUT/v1/recordCaptureGroup/{id} Completes the capture process for a captured record group.

Expand Operation / Collapse Operation

Completes the capture process for a captured record group.

Available from version: 1.0.0

Call Properties

Query Parameter
captureProfileId The capture profile associated with the capture group to be committed.
Request
Content recordCaptureGroupCommitInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

accessControlMarkingApplication type

An access control marking that will be applied when declaring.

Field Name Data Type Expected Description
accessControlMarkingIds List of String [accessControlMarkingId] No A list of access control marking ids to apply to the given record.
recordId String Yes The id of the record to apply the access control marking.
connection type

A connection that will be made when declaring.

Field Name Data Type Expected Description
connectionTypeId String Yes The id of the connection type to apply.
sourceRecordId String Yes The id of the record that will be the source of the connection.
targetRecordId String Yes The id of the record that will be the target of the connection.
recordCaptureGroupCommitInfo type

Lists of items to apply to the record when committing.

Field Name Data Type Expected Description
accessControlMarkingApplications List of accessControlMarkingApplication [accessControlMarkingApplication] No The list of access control marking applications.
connections List of connection [connection] No A list of connections to apply.

JSON Samples

Sample 1
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H?captureProfileId=301YT3D_003ESEWKF000017
Request
{"accessControlMarkingApplications":[{"recordId":"301YW1E_000V22VD9FF90DZ","accessControlMarkingIds":["301YW1E_010X32VD9FF9D0Z","301YW1E_01DV22VD9FFZZDE","301YW1E_000V222391290DX","301YW1E_033V22ZF2FF90DQ"]}],"connections":[{"connectionTypeId":"301YW1E_00077ZVD900903Z","sourceRecordId":"301YW1E_010VD2V00FFX02Z","targetRecordId":"301YW1E_00427ZDD90DX112"},{"connectionTypeId":"301YW1E_00077ZVD900903Z","sourceRecordId":"301YW1E_000V22VD9FF90DZ","targetRecordId":"301YW1E_00DV7ZZDCCD911Z"}]}

XML Samples

Sample 1
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H?captureProfileId=301YT3D_003ESEWKF000017
Request
<recordCaptureGroupCommitInfo>
    <accessControlMarkingApplications>
        <accessControlMarkingApplication>
            <recordId>301YW1E_000V22VD9FF90DZ</recordId>
            <accessControlMarkingIds>
                <accessControlMarkingId>301YW1E_010X32VD9FF9D0Z</accessControlMarkingId>
                <accessControlMarkingId>301YW1E_01DV22VD9FFZZDE</accessControlMarkingId>
                <accessControlMarkingId>301YW1E_000V222391290DX</accessControlMarkingId>
                <accessControlMarkingId>301YW1E_033V22ZF2FF90DQ</accessControlMarkingId>
            </accessControlMarkingIds>
        </accessControlMarkingApplication>
    </accessControlMarkingApplications>
    <connections>
        <connection>
            <connectionTypeId>301YW1E_00077ZVD900903Z</connectionTypeId>
            <sourceRecordId>301YW1E_010VD2V00FFX02Z</sourceRecordId>
            <targetRecordId>301YW1E_00427ZDD90DX112</targetRecordId>
        </connection>
        <connection>
            <connectionTypeId>301YW1E_00077ZVD900903Z</connectionTypeId>
            <sourceRecordId>301YW1E_000V22VD9FF90DZ</sourceRecordId>
            <targetRecordId>301YW1E_00DV7ZZDCCD911Z</targetRecordId>
        </connection>
    </connections>
</recordCaptureGroupCommitInfo>

POST/v1/recordCaptureGroup/{id}/page Captures a page to a capture group

Expand Operation / Collapse Operation

Captures a page to a capture group

Available from version: 1.0.0

Call Properties

Request
Content Multipart
Content-Type
  • multipart/form-data
Additional Header
X-IntegrationServer-File-Size The size of the page being added to the capture group.
Multipart Parameters
recordCaptureGroupPageInfo recordCaptureGroupPageInfo The location, keys, and custom properties of the record to which the page will be captured.
pageData Binary The page (binary data) to be captured.
Response
Content
recordCaptureGroupPage
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

captureGroupPageEmailMetadata type

Represents the email metadata that we capture.

Field Name Data Type Expected Description
bccAddresses List of String [bccAddress] No The email address of the recipient blind copied on the email.
ccAddresses List of String [ccAddress] No The email address of the recipient copied on the email.
fromAddress String Yes The address of the sender.
receivedTime Long No The time the email was received.
replyToAddresses List of String [replyToAddress] No The email address of the recipient who received a reply to the original email.
sentTime Long Yes The time the email was sent.
subject String Yes The subject of the email.
toAddresses List of String [toAddress] Yes The list of recipients who received the email.
captureGroupPagePdfMetadata type

Represents the pdf metadata that we capture.

Field Name Data Type Expected Description
pdfCreatingApplication String No The application used to create initial record content.
pdfProducingApplication String Yes The application used to render content to PDF.
pdfProducingApplicationVersion String Yes The version of the application used to render content to PDF.
pdfSecuritySettings String No The security settings used for the PDF.
pdfVersion pdfVersion Yes The version of the PDF record. The pdfVersion enumeration provides the possible values for this element.
captureGroupPagePhotoMetadata type

Represents the photo metadata that we capture.

Field Name Data Type Expected Description
photoBitDepth Integer Yes The bit depth of the transferred file.
photoCaption String Yes A short description of the image.
photoCompressionFormat photoCompression No The file compression method used, if applicable, for the image. The photoCompression enumeration provides the possible values for this element.
photoCompressionLevel String No The compression level selected for the image.
photoCopyright String No A restriction on the use of the image due to a copyright or other intellectual property right. If applicable, agencies must provide the owner of the copyright and any conditions on the use of the photograph, such as starting and ending dates of the restriction.
photoExifInfo String No Exchangeable Image File Format (EXIF). The information embedded in the header of the image files (as TIFF tags or JPEG markers) by certain digital cameras. For example, the digital camera's make and model.
photoIccIcmProfile String No International Color Consortium/Image Color Management (ICC/ICM). The custom or generic color profiles, if available, for the digital camera or scanner used to capture the photograph. For example, standard Red Green Blue (sRGB).
photoImageHeight Integer No The image height in pixels
photoImageSource String No The original medium used to capture the image.
photoImageWidth Integer No The image width in pixels
photoPhotographer String No The full name (and rank, if military) and organization (agency, if federal) of the photographer credited with the photograph.
captureGroupPageScannedMetadata type

Represents the scanned metadata that we capture.

Field Name Data Type Expected Description
scannedBitDepth Integer No The bit depth relative to the image encoding standard. Some image formats only support certain bit depths.
scannedFormatAndVersion scannedFormatAndVersion Yes The format and version of the scanned image. The scannedFormatAndVersion enumeration provides the possible values for this element.
scannedResolution Integer Yes The image resolution relative to the image encoding standard.
captureGroupPageWebMetadata type

Represents the web metadata that we capture.

Field Name Data Type Expected Description
webCaptureDate Long Yes The date the author or originator completed the developmental of the record.
webCaptureMethod String Yes The name and description of the harvester used to capture the file. If PDF, include the software and version used to capture the PDF. If more than one record is captured, identify the capture method used for each.
webContact String Yes The point of contact information for the person responsible for capturing the web record.
webContentManagementSystem String No The application used to manage files on the web.
webFilename String Yes The name of the web file. The name cannot exceed 99 ASCII characters. The file name with the file path cannot exceed 254 ASCII characters.
webPlatform String Yes The software applications and, if available, intended browser applications and versions.
webUrl String Yes The URL of the transferred content's landing page.
websiteName String Yes The title of the website from the landing page.
folderContext type

Field Name Data Type Expected Description
folderTypeName String Yes
name String Yes
propertyValues List of propertyValue [propertyValue] Yes
pageContext type

Field Name Data Type Expected Description
filePlan String Yes Container for records.
folderContexts List of folderContext [folderContext] No The folderContext subtype contains the name of the folder. There is one instance of folderContext for each folder in the folder hierarchy.
recordCategory recordCategory Yes The category for the record.
recordContext recordContext Yes The recordContext type is a subtype to provide the record name, record type, record properties, and property values.
pageData type

Field Name Data Type Expected Description
fileType String Yes The file extension.
scanTime Long Yes The time at which the page is scanned into the system.
scanUserId String Yes The unique ID assigned to the individual who scans the information.
scanUserName String Yes The user name of the person who scans the page.
sourcePageNumber Integer Yes The page number assigned to a page when it is captured in a batch before it becomes a record or is appended to an existing document. For example, if you capture a batch that contains four source pages, the source page numbers would be 1 through 4. The Source page value displays these original page number values even after you append the pages to an existing record that already has two pages. So the source page numbers are 1 through 4, but the same pages might be pages 3 through 6 in the record.
sourceType phsobSourceType Yes The type of source for the physical object. The phsobSourceType enumeration provides the possible values for this element.
workingName String Yes The record name and file extension.
pageMetadata type

Represents the metadata that we capture.

Field Name Data Type Expected Description
emailMetadata captureGroupPageEmailMetadata No Represents the email metadata that is captured.
pdfMetadata captureGroupPagePdfMetadata No Represents the PDF metadata that is captured.
photoMetadata captureGroupPagePhotoMetadata No Represents the photographic metadata that is captured.
scannedMetadata captureGroupPageScannedMetadata No Represents the scanned metadata that is captured.
type type Yes Represents the type of page level metadata that is captured.
webMetadata captureGroupPageWebMetadata No Represents the type of web metadata that is captured.
pdfVersion enumeration

Constant Name Description
PDF_VERSION_1_0 The PDF file is version 1.0.
PDF_VERSION_1_1 The PDF file is version 1.1.
PDF_VERSION_1_2 The PDF file is version 1.2.
PDF_VERSION_1_3 The PDF file is version 1.3.
PDF_VERSION_1_4 The PDF file is version 1.4.
photoCompression enumeration

Constant Name Description
FORMAT_NONE The image compression type is none.
FORMAT_CCITT_G3 The image compression type is CCITT Group 3.
FORMAT_CCITT_G3_2D The image compression type is CCITT Group 3 2D.
FORMAT_CCITT_G4 The image compression type is CCITT Group 4.
FORMAT_DEFLATE The image compression type is deflate.
FORMAT_HUFFMAN The image compression type is Huffman.
FORMAT_IBM_MMR The image compression type is IBM MMR.
FORMAT_JBIG The image compression type is JBIG.
FORMAT_JPEG The image compression type is JPEG.
FORMAT_LZW The image compression type is LZW.
FORMAT_PACKED_BITS The image compression type is PackBits.
FORMAT_PROGRESSIVE The image compression type is progressive.
FORMAT_RAW The image compression type is raw.
FORMAT_RLE The image compression type is RLE.
phsobSourceType enumeration

Represents the type of the source for the phsob

Constant Name Description
NONE
BATCH_SCAN
BATCH_IMPORT
BATCH_INPRINT
SINGLE_SCAN
SINGLE_IMPORT
SINGLE_INPRINT
PACKAGE
VIEWER_ADD_SCAN
VIEWER_ADD_IMPORT
COPY_PAGE
FAX_AGENT
IMP_AGENT
MSG_AGENT
MAIL_AGENT
EOB_AGENT
ISIR_AGENT
ISCRIPT
EH_AGENT
REDACTION
propertyValue type

Field Name Data Type Expected Description
id String Yes
value String Yes
recordCaptureGroupPage type

Field Name Data Type Expected Description
id String Yes
logobId String Yes
pageNumber Integer Yes
recordCaptureGroupPageInfo type

Field Name Data Type Expected Description
captureProfileId String Yes The unique ID of the capture profile to use for the capture.
pageContext pageContext Yes The pageContext type provides the page capture values, and may include folderContext and recordContext.
pageData pageData No For scans, pageDatarovides scan information, such as the user name and ID of the user that scanned the record.
pageMetadata pageMetadata Yes Provides the metadata type, such as email, JPG, or PDF.
recordCategory type

Field Name Data Type Expected Description
name String Yes The name of the record category.
recordContext type

Field Name Data Type Expected Description
addressees String Yes The date on which the record is captured.
author String Yes The name of the organization or individual who creates the record.
datePublished Long Yes The publication date of the record.
dateReceived Long Yes The date on which the record is captured.
field1 String Yes The value for Field1.
field2 String Yes The value for Field2.
field3 String Yes The value for Field3.
field4 String Yes The value for Field4.
field5 String Yes The value for Field5.
format String Yes The format type of the record.
mediaType String Yes The file type of the record.
originatingOrg String Yes The official name or code that identifies the office that is responsible for the creation of a record.
otherAddressees String Yes The additional names of the organizations or individuals to whom a record is addressed.
propertyValues List of propertyValue [propertyValue] Yes A list of property values associated with the record.
recordName String Yes The name of the record.
recordType String Yes The format type of the record.
scannedFormatAndVersion enumeration

Constant Name Description
FORMAT_AND_VERSION_TIFF_4 The TIFF file is version 4.
FORMAT_AND_VERSION_TIFF_5 The TIFF file is version 5.
FORMAT_AND_VERSION_TIFF_6 The TIFF file is version 6.
FORMAT_AND_VERSION_JPEG The JPEG version of the file.
FORMAT_AND_VERSION_GIF_87A The GIF 87A version of the file.
FORMAT_AND_VERSION_GIF_89A The GIF89A version of the file.
FORMAT_AND_VERSION_BIIF The BIIF version of the file.
FORMAT_AND_VERSION_PNG_1 The PNG 1 version of the file.
type enumeration

Represents the type of metadata that will be used

Constant Name Description
NONE There is no source type associated with this file.
EMAIL The original item was an email.
SCANNED The original item was a scanned item.
PDF The original item was in PDF format.
PHOTO The original item was a photograph.
WEB The original item was a web document.

JSON Samples

Sample 1 - With Email Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

{"captureProfileId":"321YX7Z_0000WCWD6000044","pageContext":{"filePlan":"HR","recordCategory":{"name":"New Hires"},"folderContexts":[{"name":"Employees","folderTypeName":null,"propertyValues":null}],"recordContext":{"field1":"Field 1","field2":"Field 2","field3":"Field 3","field4":"Field 4","field5":"Field 5","recordType":"Default","recordName":"September Budget","propertyValues":[],"datePublished":1378762321,"author":"John Smith","originatingOrg":"Smith Enterprises","dateReceived":1378762321,"addressees":"","otherAddressees":"","mediaType":"XLS","format":""}},"pageData":{"fileType":"XLS","workingName":"September Budget.xls","scanUserName":null,"scanUserId":null,"scanTime":null,"sourceType":null,"sourcePageNumber":null},"pageMetadata":{"type":"EMAIL","emailMetadata":{"toAddresses":["Admin1@test9.com","Admin2@test9.com"],"ccAddresses":["Admin3@test9.com","Admin4@test9.com"],"bccAddresses":["Admin5@test9.com","Admin6@test9.com"],"replyToAddresses":null,"fromAddress":"Admin7@test9.com","subject":"September Budget","sentTime":1375283926317,"receivedTime":1375283926317},"pdfMetadata":null,"photoMetadata":null,"scannedMetadata":null,"webMetadata":null}}
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}
Sample 2 - With PDF Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

{"captureProfileId":"321YX7Z_0000WCWD6000044","pageContext":{"filePlan":"HR","recordCategory":{"name":"New Hires"},"folderContexts":[{"name":"Employees","folderTypeName":null,"propertyValues":null}],"recordContext":{"field1":"Field 1","field2":"Field 2","field3":"Field 3","field4":"Field 4","field5":"Field 5","recordType":"Default","recordName":"September Budget","propertyValues":[],"datePublished":1378762321,"author":"John Smith","originatingOrg":"Smith Enterprises","dateReceived":1378762321,"addressees":"","otherAddressees":"","mediaType":"XLS","format":""}},"pageData":{"fileType":"XLS","workingName":"September Budget.xls","scanUserName":null,"scanUserId":null,"scanTime":null,"sourceType":null,"sourcePageNumber":null},"pageMetadata":{"type":"PDF","emailMetadata":null,"pdfMetadata":{"pdfProducingApplication":"MS Word","pdfProducingApplicationVersion":"2003","pdfVersion":"PDF_VERSION_1_4","pdfCreatingApplication":"MS Word","pdfSecuritySettings":""},"photoMetadata":null,"scannedMetadata":null,"webMetadata":null}}
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}
Sample 3 - With Photo Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

{"captureProfileId":"321YX7Z_0000WCWD6000044","pageContext":{"filePlan":"HR","recordCategory":{"name":"New Hires"},"folderContexts":[{"name":"Employees","folderTypeName":null,"propertyValues":null}],"recordContext":{"field1":"Field 1","field2":"Field 2","field3":"Field 3","field4":"Field 4","field5":"Field 5","recordType":"Default","recordName":"September Budget","propertyValues":[],"datePublished":1378762321,"author":"John Smith","originatingOrg":"Smith Enterprises","dateReceived":1378762321,"addressees":"","otherAddressees":"","mediaType":"XLS","format":""}},"pageData":{"fileType":"XLS","workingName":"September Budget.xls","scanUserName":null,"scanUserId":null,"scanTime":null,"sourceType":null,"sourcePageNumber":null},"pageMetadata":{"type":"PHOTO","emailMetadata":null,"pdfMetadata":null,"photoMetadata":{"photoCaption":"Color picture","photoPhotographer":"Bob","photoCopyright":"Bob 2013","photoBitDepth":8,"photoImageHeight":400,"photoImageWidth":600,"photoImageSource":"Camera","photoCompressionFormat":"FORMAT_JPEG","photoCompressionLevel":"None","photoIccIcmProfile":"Profile2","photoExifInfo":""},"scannedMetadata":null,"webMetadata":null}}
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}
Sample 4 - With Scanned Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

{"captureProfileId":"321YX7Z_0000WCWD6000044","pageContext":{"filePlan":"HR","recordCategory":{"name":"New Hires"},"folderContexts":[{"name":"Employees","folderTypeName":null,"propertyValues":null}],"recordContext":{"field1":"Field 1","field2":"Field 2","field3":"Field 3","field4":"Field 4","field5":"Field 5","recordType":"Default","recordName":"September Budget","propertyValues":[],"datePublished":1378762321,"author":"John Smith","originatingOrg":"Smith Enterprises","dateReceived":1378762321,"addressees":"","otherAddressees":"","mediaType":"XLS","format":""}},"pageData":{"fileType":"XLS","workingName":"September Budget.xls","scanUserName":null,"scanUserId":null,"scanTime":null,"sourceType":null,"sourcePageNumber":null},"pageMetadata":{"type":"SCANNED","emailMetadata":null,"pdfMetadata":null,"photoMetadata":null,"scannedMetadata":{"scannedFormatAndVersion":"FORMAT_AND_VERSION_JPEG","scannedResolution":1,"scannedBitDepth":8},"webMetadata":null}}
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}
Sample 5 - With Web Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

{"captureProfileId":"321YX7Z_0000WCWD6000044","pageContext":{"filePlan":"HR","recordCategory":{"name":"New Hires"},"folderContexts":[{"name":"Employees","folderTypeName":null,"propertyValues":null}],"recordContext":{"field1":"Field 1","field2":"Field 2","field3":"Field 3","field4":"Field 4","field5":"Field 5","recordType":"Default","recordName":"September Budget","propertyValues":[],"datePublished":1378762321,"author":"John Smith","originatingOrg":"Smith Enterprises","dateReceived":1378762321,"addressees":"","otherAddressees":"","mediaType":"XLS","format":""}},"pageData":{"fileType":"XLS","workingName":"September Budget.xls","scanUserName":null,"scanUserId":null,"scanTime":null,"sourceType":null,"sourcePageNumber":null},"pageMetadata":{"type":"WEB","emailMetadata":null,"pdfMetadata":null,"photoMetadata":null,"scannedMetadata":null,"webMetadata":{"webFilename":"index.html","webPlatform":"Firefox","websiteName":"www.perceptivesoftware.com","webUrl":"http://www.perceptivesoftware.com","webCaptureMethod":"Save","webCaptureDate":1375286141552,"webContact":"Bob","webContentManagementSystem":"CMS"}}}
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}
Sample 6 - With No Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

{"captureProfileId":"321YX7Z_0000WCWD6000044","pageContext":{"filePlan":"HR","recordCategory":{"name":"New Hires"},"folderContexts":[{"name":"Employees","folderTypeName":null,"propertyValues":null}],"recordContext":{"field1":"Field 1","field2":"Field 2","field3":"Field 3","field4":"Field 4","field5":"Field 5","recordType":"Default","recordName":"September Budget","propertyValues":[],"datePublished":1378762321,"author":"John Smith","originatingOrg":"Smith Enterprises","dateReceived":1378762321,"addressees":"","otherAddressees":"","mediaType":"XLS","format":""}},"pageData":{"fileType":"XLS","workingName":"September Budget.xls","scanUserName":null,"scanUserId":null,"scanTime":null,"sourceType":null,"sourcePageNumber":null},"pageMetadata":{"type":"NONE","emailMetadata":null,"pdfMetadata":null,"photoMetadata":null,"scannedMetadata":null,"webMetadata":null}}
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}
Sample 7
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}
Sample 8
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
{"id":"301YW37_0001DPCBH0000K2","logobId":"301YW37_0001DPCBH0000K5","pageNumber":1}

XML Samples

Sample 1 - With Email Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

<recordCaptureGroupPageInfo>
    <captureProfileId>321YX7Z_0000WCWD6000044</captureProfileId>
    <pageContext>
        <filePlan>HR</filePlan>
        <recordCategory>
            <name>New Hires</name>
        </recordCategory>
        <folderContexts>
            <folderContext>
                <name>Employees</name>
            </folderContext>
        </folderContexts>
        <recordContext>
            <field1>Field 1</field1>
            <field2>Field 2</field2>
            <field3>Field 3</field3>
            <field4>Field 4</field4>
            <field5>Field 5</field5>
            <recordType>Default</recordType>
            <recordName>September Budget</recordName>
            <propertyValues/>
            <datePublished>1378762321</datePublished>
            <author>John Smith</author>
            <originatingOrg>Smith Enterprises</originatingOrg>
            <dateReceived>1378762321</dateReceived>
            <addressees/>
            <otherAddressees/>
            <mediaType>XLS</mediaType>
            <format/>
        </recordContext>
    </pageContext>
    <pageData>
        <fileType>XLS</fileType>
        <workingName>September Budget.xls</workingName>
    </pageData>
    <pageMetadata>
        <type>EMAIL</type>
        <emailMetadata>
            <toAddresses>
                <toAddress>Admin1@test9.com</toAddress>
                <toAddress>Admin2@test9.com</toAddress>
            </toAddresses>
            <ccAddresses>
                <ccAddress>Admin3@test9.com</ccAddress>
                <ccAddress>Admin4@test9.com</ccAddress>
            </ccAddresses>
            <bccAddresses>
                <bccAddress>Admin5@test9.com</bccAddress>
                <bccAddress>Admin6@test9.com</bccAddress>
            </bccAddresses>
            <fromAddress>Admin7@test9.com</fromAddress>
            <subject>September Budget</subject>
            <sentTime>1375283926317</sentTime>
            <receivedTime>1375283926317</receivedTime>
        </emailMetadata>
    </pageMetadata>
</recordCaptureGroupPageInfo>
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>
Sample 2 - With PDF Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

<recordCaptureGroupPageInfo>
    <captureProfileId>321YX7Z_0000WCWD6000044</captureProfileId>
    <pageContext>
        <filePlan>HR</filePlan>
        <recordCategory>
            <name>New Hires</name>
        </recordCategory>
        <folderContexts>
            <folderContext>
                <name>Employees</name>
            </folderContext>
        </folderContexts>
        <recordContext>
            <field1>Field 1</field1>
            <field2>Field 2</field2>
            <field3>Field 3</field3>
            <field4>Field 4</field4>
            <field5>Field 5</field5>
            <recordType>Default</recordType>
            <recordName>September Budget</recordName>
            <propertyValues/>
            <datePublished>1378762321</datePublished>
            <author>John Smith</author>
            <originatingOrg>Smith Enterprises</originatingOrg>
            <dateReceived>1378762321</dateReceived>
            <addressees/>
            <otherAddressees/>
            <mediaType>XLS</mediaType>
            <format/>
        </recordContext>
    </pageContext>
    <pageData>
        <fileType>XLS</fileType>
        <workingName>September Budget.xls</workingName>
    </pageData>
    <pageMetadata>
        <type>PDF</type>
        <pdfMetadata>
            <pdfProducingApplication>MS Word</pdfProducingApplication>
            <pdfProducingApplicationVersion>2003</pdfProducingApplicationVersion>
            <pdfVersion>PDF_VERSION_1_4</pdfVersion>
            <pdfCreatingApplication>MS Word</pdfCreatingApplication>
            <pdfSecuritySettings/>
        </pdfMetadata>
    </pageMetadata>
</recordCaptureGroupPageInfo>
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>
Sample 3 - With Photo Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

<recordCaptureGroupPageInfo>
    <captureProfileId>321YX7Z_0000WCWD6000044</captureProfileId>
    <pageContext>
        <filePlan>HR</filePlan>
        <recordCategory>
            <name>New Hires</name>
        </recordCategory>
        <folderContexts>
            <folderContext>
                <name>Employees</name>
            </folderContext>
        </folderContexts>
        <recordContext>
            <field1>Field 1</field1>
            <field2>Field 2</field2>
            <field3>Field 3</field3>
            <field4>Field 4</field4>
            <field5>Field 5</field5>
            <recordType>Default</recordType>
            <recordName>September Budget</recordName>
            <propertyValues/>
            <datePublished>1378762321</datePublished>
            <author>John Smith</author>
            <originatingOrg>Smith Enterprises</originatingOrg>
            <dateReceived>1378762321</dateReceived>
            <addressees/>
            <otherAddressees/>
            <mediaType>XLS</mediaType>
            <format/>
        </recordContext>
    </pageContext>
    <pageData>
        <fileType>XLS</fileType>
        <workingName>September Budget.xls</workingName>
    </pageData>
    <pageMetadata>
        <type>PHOTO</type>
        <photoMetadata>
            <photoCaption>Color picture</photoCaption>
            <photoPhotographer>Bob</photoPhotographer>
            <photoCopyright>Bob 2013</photoCopyright>
            <photoBitDepth>8</photoBitDepth>
            <photoImageHeight>400</photoImageHeight>
            <photoImageWidth>600</photoImageWidth>
            <photoImageSource>Camera</photoImageSource>
            <photoCompressionFormat>FORMAT_JPEG</photoCompressionFormat>
            <photoCompressionLevel>None</photoCompressionLevel>
            <photoIccIcmProfile>Profile2</photoIccIcmProfile>
            <photoExifInfo/>
        </photoMetadata>
    </pageMetadata>
</recordCaptureGroupPageInfo>
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>
Sample 4 - With Scanned Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

<recordCaptureGroupPageInfo>
    <captureProfileId>321YX7Z_0000WCWD6000044</captureProfileId>
    <pageContext>
        <filePlan>HR</filePlan>
        <recordCategory>
            <name>New Hires</name>
        </recordCategory>
        <folderContexts>
            <folderContext>
                <name>Employees</name>
            </folderContext>
        </folderContexts>
        <recordContext>
            <field1>Field 1</field1>
            <field2>Field 2</field2>
            <field3>Field 3</field3>
            <field4>Field 4</field4>
            <field5>Field 5</field5>
            <recordType>Default</recordType>
            <recordName>September Budget</recordName>
            <propertyValues/>
            <datePublished>1378762321</datePublished>
            <author>John Smith</author>
            <originatingOrg>Smith Enterprises</originatingOrg>
            <dateReceived>1378762321</dateReceived>
            <addressees/>
            <otherAddressees/>
            <mediaType>XLS</mediaType>
            <format/>
        </recordContext>
    </pageContext>
    <pageData>
        <fileType>XLS</fileType>
        <workingName>September Budget.xls</workingName>
    </pageData>
    <pageMetadata>
        <type>SCANNED</type>
        <scannedMetadata>
            <scannedFormatAndVersion>FORMAT_AND_VERSION_JPEG</scannedFormatAndVersion>
            <scannedResolution>1</scannedResolution>
            <scannedBitDepth>8</scannedBitDepth>
        </scannedMetadata>
    </pageMetadata>
</recordCaptureGroupPageInfo>
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>
Sample 5 - With Web Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

<recordCaptureGroupPageInfo>
    <captureProfileId>321YX7Z_0000WCWD6000044</captureProfileId>
    <pageContext>
        <filePlan>HR</filePlan>
        <recordCategory>
            <name>New Hires</name>
        </recordCategory>
        <folderContexts>
            <folderContext>
                <name>Employees</name>
            </folderContext>
        </folderContexts>
        <recordContext>
            <field1>Field 1</field1>
            <field2>Field 2</field2>
            <field3>Field 3</field3>
            <field4>Field 4</field4>
            <field5>Field 5</field5>
            <recordType>Default</recordType>
            <recordName>September Budget</recordName>
            <propertyValues/>
            <datePublished>1378762321</datePublished>
            <author>John Smith</author>
            <originatingOrg>Smith Enterprises</originatingOrg>
            <dateReceived>1378762321</dateReceived>
            <addressees/>
            <otherAddressees/>
            <mediaType>XLS</mediaType>
            <format/>
        </recordContext>
    </pageContext>
    <pageData>
        <fileType>XLS</fileType>
        <workingName>September Budget.xls</workingName>
    </pageData>
    <pageMetadata>
        <type>WEB</type>
        <webMetadata>
            <webFilename>index.html</webFilename>
            <webPlatform>Firefox</webPlatform>
            <websiteName>www.perceptivesoftware.com</websiteName>
            <webUrl>http://www.perceptivesoftware.com</webUrl>
            <webCaptureMethod>Save</webCaptureMethod>
            <webCaptureDate>1375286141552</webCaptureDate>
            <webContact>Bob</webContact>
            <webContentManagementSystem>CMS</webContentManagementSystem>
        </webMetadata>
    </pageMetadata>
</recordCaptureGroupPageInfo>
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>
Sample 6 - With No Metadata
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="recordCaptureGroupPageInfo"
Content-Transfer-Encoding: binary

<recordCaptureGroupPageInfo>
    <captureProfileId>321YX7Z_0000WCWD6000044</captureProfileId>
    <pageContext>
        <filePlan>HR</filePlan>
        <recordCategory>
            <name>New Hires</name>
        </recordCategory>
        <folderContexts>
            <folderContext>
                <name>Employees</name>
            </folderContext>
        </folderContexts>
        <recordContext>
            <field1>Field 1</field1>
            <field2>Field 2</field2>
            <field3>Field 3</field3>
            <field4>Field 4</field4>
            <field5>Field 5</field5>
            <recordType>Default</recordType>
            <recordName>September Budget</recordName>
            <propertyValues/>
            <datePublished>1378762321</datePublished>
            <author>John Smith</author>
            <originatingOrg>Smith Enterprises</originatingOrg>
            <dateReceived>1378762321</dateReceived>
            <addressees/>
            <otherAddressees/>
            <mediaType>XLS</mediaType>
            <format/>
        </recordContext>
    </pageContext>
    <pageData>
        <fileType>XLS</fileType>
        <workingName>September Budget.xls</workingName>
    </pageData>
    <pageMetadata>
        <type>NONE</type>
    </pageMetadata>
</recordCaptureGroupPageInfo>
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>
Sample 7
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>
Sample 8
Request URL
/v1/recordCaptureGroup/301YW1E_00077ZVD900003H/page
Multipart Request
Content-Disposition: form-data; name="pageData"
Content-Transfer-Encoding: binary

3F 7E 10 65 16 40 08 06-5B 06 03 36 40 ...
Response
<recordCaptureGroupPage>
    <id>301YW37_0001DPCBH0000K2</id>
    <logobId>301YW37_0001DPCBH0000K5</logobId>
    <pageNumber>1</pageNumber>
</recordCaptureGroupPage>

RecordType (Version 1)

GET/v1/recordType Gets all record types stored in ImageNow Server.

Expand Operation / Collapse Operation

Gets all record types stored in ImageNow Server.

Available from version: 1.0.0

Call Properties

Response
Content
List of recordType [recordType]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

recordType type

Represents a record type.

Field Name Data Type Expected Description
description String Yes A description of the record type.
id String Yes The unique id of the record type.
name String Yes The name of the record type.

JSON Samples

Sample 1
Request URL
/v1/recordType
Response
{"recordTypes":[{"name":"Default","id":"1000184816_1738021400","description":"Default Record Type"},{"name":"Record Type","id":"301YW2J_00003B4TG000004","description":"System Test Record Type"},{"name":"Expense Report Record Type","id":"301YW2J_00000JJ4700002R","description":"2012 Expense Report Record Type"}]}

XML Samples

Sample 1
Request URL
/v1/recordType
Response
<recordTypes>
    <recordType>
        <name>Default</name>
        <id>1000184816_1738021400</id>
        <description>Default Record Type</description>
    </recordType>
    <recordType>
        <name>Record Type</name>
        <id>301YW2J_00003B4TG000004</id>
        <description>System Test Record Type</description>
    </recordType>
    <recordType>
        <name>Expense Report Record Type</name>
        <id>301YW2J_00000JJ4700002R</id>
        <description>2012 Expense Report Record Type</description>
    </recordType>
</recordTypes>

GET/v1/recordType/{id} Gets the record type stored in ImageNow Server that matches the ID.

Expand Operation / Collapse Operation

Gets the record type stored in ImageNow Server that matches the ID.

Available from version: 1.0.0

Call Properties

Response
Content
recordType
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

childProperty type

Represents a child property of an ImageNow Property

Field Name Data Type Expected Description
id String Yes The ID of the child property
isRequired boolean Yes Indicates if this child property is required
keyValuePair type

A generic keyed value

Field Name Data Type Expected Description
key String Yes The key
value String Yes The value
propertyUserInfo type

Represents a user within an ImageNow Property

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user's name
suffix String No The suffix of the user's name
userName String Yes The username of the user
recordType type

Represents a record type

Field Name Data Type Expected Description
description String Yes A description of the record type.
formId String No The unique form id for an associated form.
id String Yes The unique id of the record type.
name String Yes The name of the record type.
properties List of typeProperty [property] Yes The custom properties associated with the record type.
type enumeration

Represents the type of a custom property

Constant Name Description
STRING Custom property that represents a string value
NUMBER Custom property that represents a number value
DATE Custom property that represents a date value
FLAG Custom property that represents a flag with two possible values
LIST Custom property that represents a list of possible vlaues
USER_GROUP Custom property that represents a list of possible user groups
USER_LIST Custom property that represents a list of possible users
COMPOSITE Custom property that represents a composite property which contains children properties
ARRAY Custom property that represents an array of children properties with the same type
typeProperty type

Represents an ImageNow Property

Field Name Data Type Expected Description
required boolean Yes Is this property required or not.
children List of childProperty [child] No Children's list for composite and array type, it only has property id and isRequired field.
defaultValue String No The default value for this property
formats List of keyValuePair [format] No How to display this property.
id String Yes The ID of the property.
listValueCandidates List of String [listValueCandidate] No Candidates list for the list type.
name String Yes The name of the property.
type type Yes Property type, it's an enum type.
userGroupId String No User group id for user group type.
userGroupName String No User group name for user group type.
userList List of propertyUserInfo [user] No User list for user types.

JSON Samples

Sample 1
Request URL
/v1/recordType/301YW2J_00000JJ4700002R
Response
{"name":"Expense Report Record Type","id":"301YW2J_00000JJ4700002R","description":"2012 Expense Report Record Type","formId":null,"properties":[{"id":"301YW2J_00000HJ47000012","name":"List","type":"LIST","userGroupId":null,"userGroupName":null,"defaultValue":null,"required":false,"listValueCandidates":["List Item 1","List Item 2","List Item 3"],"userList":null,"children":null,"formats":[]}]}

XML Samples

Sample 1
Request URL
/v1/recordType/301YW2J_00000JJ4700002R
Response
<recordType>
    <name>Expense Report Record Type</name>
    <id>301YW2J_00000JJ4700002R</id>
    <description>2012 Expense Report Record Type</description>
    <properties>
        <property>
            <id>301YW2J_00000HJ47000012</id>
            <name>List</name>
            <type>LIST</type>
            <listValueCandidates>
                <listValueCandidate>List Item 1</listValueCandidate>
                <listValueCandidate>List Item 2</listValueCandidate>
                <listValueCandidate>List Item 3</listValueCandidate>
            </listValueCandidates>
            <formats/>
            <required>false</required>
        </property>
    </properties>
</recordType>

GET/v1/recordType/{id}/picklist Gets the list of picklists available for the record type.

Expand Operation / Collapse Operation

Gets the list of picklists available for the record type.

Available from version: 1.0.0

Call Properties

Response
Content
List of picklist [picklist]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

accessControlMarking type

Field Name Data Type Expected Description
canApply Boolean Yes Whether or not the user can access an access control marking.
id String Yes The id of the access control marking.
name String Yes The name of the access control marking.
picklist type

Field Name Data Type Expected Description
accessControlMarkings List of accessControlMarking [accessControlMarking] No The list of markings on the picklist.
description String No The description of the picklist.
id String Yes The id of the picklist.
name String Yes The name of the picklist.

JSON Samples

Sample 1
Request URL
/v1/recordType/301YW2J_00000JJ4700002R/picklist
Response
{"picklists":[{"id":"301YW2J_000Y2JJ4WT0002C","name":"Clearance Level 1","description":"Available to all users","accessControlMarkings":[{"id":"301YW2J_000Y2JD4WX2002Y","name":"Confidential","canApply":true},{"id":"301YW2J_000Y2WD4SX1103Z","name":"Top Level Security","canApply":false}]}]}

XML Samples

Sample 1
Request URL
/v1/recordType/301YW2J_00000JJ4700002R/picklist
Response
<picklists>
    <picklist>
        <id>301YW2J_000Y2JJ4WT0002C</id>
        <name>Clearance Level 1</name>
        <description>Available to all users</description>
        <accessControlMarkings>
            <accessControlMarking>
                <id>301YW2J_000Y2JD4WX2002Y</id>
                <name>Confidential</name>
                <canApply>true</canApply>
            </accessControlMarking>
            <accessControlMarking>
                <id>301YW2J_000Y2WD4SX1103Z</id>
                <name>Top Level Security</name>
                <canApply>false</canApply>
            </accessControlMarking>
        </accessControlMarkings>
    </picklist>
</picklists>

RelationshipView (Version 1)

GET/v1/relationshipView Gets all relationship views in the server that are available to the user.

Expand Operation / Collapse Operation

Gets all relationship views in the server that are available to the user.

Available from version: 1.0.0

Call Properties

Response
Content
List of view [view]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
view type

Represents a view.

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto run enabled
category viewCategory Yes The category of the view
classifier classifier Yes The classifier of the view
description String Yes A description of the view
hasFilters boolean Yes Flag representing if the view has filters
id String Yes The ID of the view
name String Yes The name of the view
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.

JSON Samples

Sample 1
Request URL
/v1/relationshipView
Response
{"views":[{"id":"301US2G_0005CT5AS000025","name":"RelatedDocumentsView","description":"Related documents available to the user account","category":"DOCUMENT","classifier":null,"autoRun":false,"hasFilters":false},{"id":"301YW1Y_0006CY7ZX000013","name":"RelatedFoldersView","description":"Related folders available to the user account","category":"FOLDER","classifier":null,"autoRun":false,"hasFilters":false}]}

XML Samples

Sample 1
Request URL
/v1/relationshipView
Response
<views>
    <view>
        <id>301US2G_0005CT5AS000025</id>
        <name>RelatedDocumentsView</name>
        <description>Related documents available to the user account</description>
        <category>DOCUMENT</category>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
    <view>
        <id>301YW1Y_0006CY7ZX000013</id>
        <name>RelatedFoldersView</name>
        <description>Related folders available to the user account</description>
        <category>FOLDER</category>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
</views>

GET/v1/relationshipView/document Gets all document relationship views in the server that are available to the user.

Expand Operation / Collapse Operation

Gets all document relationship views in the server that are available to the user.

Available from version: 1.0.0

Call Properties

Response
Content
List of view [view]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
view type

Represents a view.

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto run enabled
category viewCategory Yes The category of the view
classifier classifier Yes The classifier of the view
description String Yes A description of the view
hasFilters boolean Yes Flag representing if the view has filters
id String Yes The ID of the view
name String Yes The name of the view
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.

JSON Samples

Sample 1
Request URL
/v1/relationshipView/document
Response
{"views":[{"id":"301US2G_0005CT5AS000025","name":"RelatedDocumentsView","description":"Related documents available to the user account","category":"DOCUMENT","classifier":null,"autoRun":false,"hasFilters":false},{"id":"321YY9B_000ZEXTB3000001","name":"AnotherRelatedDocumentsView","description":"More related documents available to the user account","category":"DOCUMENT","classifier":null,"autoRun":false,"hasFilters":false}]}

XML Samples

Sample 1
Request URL
/v1/relationshipView/document
Response
<views>
    <view>
        <id>301US2G_0005CT5AS000025</id>
        <name>RelatedDocumentsView</name>
        <description>Related documents available to the user account</description>
        <category>DOCUMENT</category>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
    <view>
        <id>321YY9B_000ZEXTB3000001</id>
        <name>AnotherRelatedDocumentsView</name>
        <description>More related documents available to the user account</description>
        <category>DOCUMENT</category>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
</views>

GET/v1/relationshipView/folder Gets all folder relationship views in the server that are available to the user.

Expand Operation / Collapse Operation

Gets all folder relationship views in the server that are available to the user.

Available from version: 1.0.0

Call Properties

Response
Content
List of view [view]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
view type

Represents a view.

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto run enabled
category viewCategory Yes The category of the view
classifier classifier Yes The classifier of the view
description String Yes A description of the view
hasFilters boolean Yes Flag representing if the view has filters
id String Yes The ID of the view
name String Yes The name of the view
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.

JSON Samples

Sample 1
Request URL
/v1/relationshipView/folder
Response
{"views":[{"id":"301YW1Y_0006CY7ZX000013","name":"RelatedFoldersView","description":"Related folders available to the user account","category":"FOLDER","classifier":null,"autoRun":false,"hasFilters":false},{"id":"321YY9H_001094ZNK00000Y","name":"AnotherRelatedFoldersView","description":"More related folders available to the user account","category":"FOLDER","classifier":null,"autoRun":false,"hasFilters":false}]}

XML Samples

Sample 1
Request URL
/v1/relationshipView/folder
Response
<views>
    <view>
        <id>301YW1Y_0006CY7ZX000013</id>
        <name>RelatedFoldersView</name>
        <description>Related folders available to the user account</description>
        <category>FOLDER</category>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
    <view>
        <id>321YY9H_001094ZNK00000Y</id>
        <name>AnotherRelatedFoldersView</name>
        <description>More related folders available to the user account</description>
        <category>FOLDER</category>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
</views>

GET/v1/relationshipView/{id} Gets the relationship view in the server that matches the ID.

Expand Operation / Collapse Operation

Gets the relationship view in the server that matches the ID.

Available from version: 1.0.0

Call Properties

Response
Content
relationshipView
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

contextRuntimeVariable type

Field Name Data Type Expected Description
comparisonFieldCustomPropertyID String Yes If the left-hand side of this constraint refers to a custom property, this is its ID.
comparisonFieldID Integer Yes The specific type of condition; which enumeration this refers to is dependent upon the VSL category of the rule.
constraintId String Yes The ID of the constraint.
contextFieldCustomPropertyID String Yes If the right-hand side of this constraint refers to a search condition enumeration, this is its ID.
contextFieldID Integer Yes The specific type of condition; which enumeration this refers to is dependent upon the VSL category of the rule.
operator vslRelationshipOperator Yes The VSL operator type to be used in the comparison.
dataType enumeration

Data type for the column.

Constant Name Description
STRING
INTEGER
BOOLEAN
DATE
CUSTOM_PROPERTY
PRIV_STRING
DOUBLE
workflowItemState
taskStatus
taskType
taskCompletionType
folderStatus
folderContentType
digitalSignatureStatus
displayType enumeration

Visibility for the column.

Constant Name Description
HIDDEN
VISIBLE
relationshipView type

Field Name Data Type Expected Description
autoRun boolean Yes Flag representing whether the view should be run automatically.
category viewCategory Yes The category of the view.
columns List of viewColumn [column] Yes Information about the columns included in the view.
contextRuntimeVariables List of contextRuntimeVariable [contextRuntimeVariable] Yes Information about the context required to run the relationship view.
description String Yes A description of the view.
id String Yes The ID of the view.
name String Yes The name of the view.
sortDirection enumeration

Sort direction for the column.

Constant Name Description
ASCENDING
DESCENDING
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumn type

Field Name Data Type Expected Description
columnId String Yes
dataType dataType Yes
displayType displayType Yes
groupOrder Integer Yes
name String Yes
sortDirection sortDirection Yes
sortOrder Integer Yes
width Double Yes
vslRelationshipOperator enumeration

Type of operator for VSL comparison

Constant Name Description
NONE
EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
CONTAINS
STARTS_WITH
ENDS_WITH
NOT_EQUALS
IS_NULL
IS_NOT_NULL
DOES_NOT_CONTAIN
IN
NOT_IN
BETWEEN
NOT_BETWEEN
DOES_NOT_START_WITH
DOES_NOT_END_WITH

JSON Samples

Sample 1
Request URL
/v1/relationshipView/301YW1Y_0006CY7ZX000013
Response
{"id":"301YW1Y_0006CY7ZX000013","name":"Test Document View","description":"","category":"DOCUMENT","autoRun":true,"contextRuntimeVariables":[{"constraintId":"321Z0BL_0020GN5PV00003J","comparisonFieldID":30,"comparisonFieldCustomPropertyID":"","contextFieldID":30,"contextFieldCustomPropertyID":"","operator":"EQUAL_TO"},{"constraintId":"321Z0BL_0020GG5PV00001X","comparisonFieldID":28,"comparisonFieldCustomPropertyID":"","contextFieldID":0,"contextFieldCustomPropertyID":"321YXCN_0000CL5B500001V","operator":"STARTS_WITH"}],"columns":[{"columnId":"39","dataType":"STRING","displayType":"HIDDEN","name":"Details","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"columnId":"301YW1T_000693JRD00000L","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Coin Toss","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}]}

XML Samples

Sample 1
Request URL
/v1/relationshipView/301YW1Y_0006CY7ZX000013
Response
<relationshipView>
    <id>301YW1Y_0006CY7ZX000013</id>
    <name>Test Document View</name>
    <description/>
    <category>DOCUMENT</category>
    <autoRun>true</autoRun>
    <contextRuntimeVariables>
        <contextRuntimeVariable>
            <constraintId>321Z0BL_0020GN5PV00003J</constraintId>
            <comparisonFieldID>30</comparisonFieldID>
            <comparisonFieldCustomPropertyID/>
            <contextFieldID>30</contextFieldID>
            <contextFieldCustomPropertyID/>
            <operator>EQUAL_TO</operator>
        </contextRuntimeVariable>
        <contextRuntimeVariable>
            <constraintId>321Z0BL_0020GG5PV00001X</constraintId>
            <comparisonFieldID>28</comparisonFieldID>
            <comparisonFieldCustomPropertyID/>
            <contextFieldID>0</contextFieldID>
            <contextFieldCustomPropertyID>321YXCN_0000CL5B500001V</contextFieldCustomPropertyID>
            <operator>STARTS_WITH</operator>
        </contextRuntimeVariable>
    </contextRuntimeVariables>
    <columns>
        <column>
            <columnId>39</columnId>
            <dataType>STRING</dataType>
            <displayType>HIDDEN</displayType>
            <name>Details</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
        <column>
            <columnId>301YW1T_000693JRD00000L</columnId>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Coin Toss</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
    </columns>
</relationshipView>

POST/v1/relationshipView/{viewId}/document/{documentId}/result Run the relationship view with viewId against the document with documentId on the server.

Expand Operation / Collapse Operation

Run the relationship view with viewId against the document with documentId on the server.

Available from version: 1.0.0

Call Properties

Path Parameters
viewId The ID of the relationship view to run.
documentId The ID of the document.
Request
Content relationshipViewParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
relationshipViewParameters type

The relationshipViewParameters type provides the optional column selectors and the list of search constraint IDs and values for a search.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document relationship views.
contextRuntimeVariables List of viewRuntimeVariable [contextRuntimeVariable] No The list of constraint IDs and values for the prompted searches associated with the given filter.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.
viewRuntimeVariable type

The viewRuntimeVariable type provides the search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
constraintId String Yes The unique ID of the search constraint for a prompted search associated with the filter.
value String Yes For the prompted search, this is the value to search by. If this value is a date and time, the time must be in UTC. The clientTimeZoneOffset will not be applied.

JSON Samples

Sample 1 - Request to run a document relationship view. Note that if a custom property is being compared against another custom property, the server expects a raw value for the context runtime variable. If a custom property is being compared against a document key, the server expects a formatted value.
Request URL
/v1/relationshipView/321Z09W_001Y1FDV0000045/document/321YY7X_000TCJ98R000001/result
Request
{"clientTimeZoneOffset":"-06:00","columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}],"contextRuntimeVariables":[{"constraintId":"321Z0BV_0020Y5XXH000021","value":"2011-10-28 08:30:00.000000"},{"constraintId":"321Z0BV_0020Y5XXH000023","value":"My Document Type"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}

XML Samples

Sample 1 - Request to run a document relationship view. Note that if a custom property is being compared against another custom property, the server expects a raw value for the context runtime variable. If a custom property is being compared against a document key, the server expects a formatted value.
Request URL
/v1/relationshipView/321Z09W_001Y1FDV0000045/document/321YY7X_000TCJ98R000001/result
Request
<relationshipViewParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <contextRuntimeVariables>
        <contextRuntimeVariable>
            <constraintId>321Z0BV_0020Y5XXH000021</constraintId>
            <value>2011-10-28 08:30:00.000000</value>
        </contextRuntimeVariable>
        <contextRuntimeVariable>
            <constraintId>321Z0BV_0020Y5XXH000023</constraintId>
            <value>My Document Type</value>
        </contextRuntimeVariable>
    </contextRuntimeVariables>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</relationshipViewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

POST/v1/relationshipView/{viewId}/folder/{folderId}/result Run the relationship view with viewId against the folder with folderId on the server.

Expand Operation / Collapse Operation

Run the relationship view with viewId against the folder with folderId on the server.

Available from version: 1.0.0

Call Properties

Path Parameters
viewId The ID of the relationship view to run.
folderId The ID of the folder.
Request
Content relationshipViewParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
relationshipViewParameters type

The relationshipViewParameters type provides the optional column selectors and the list of search constraint IDs and values for a search.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document relationship views.
contextRuntimeVariables List of viewRuntimeVariable [contextRuntimeVariable] No The list of constraint IDs and values for the prompted searches associated with the given filter.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.
viewRuntimeVariable type

The viewRuntimeVariable type provides the search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
constraintId String Yes The unique ID of the search constraint for a prompted search associated with the filter.
value String Yes For the prompted search, this is the value to search by. If this value is a date and time, the time must be in UTC. The clientTimeZoneOffset will not be applied.

JSON Samples

Sample 1 - Request to run a folder relationship view. Note that if a custom property is being compared against another custom property, the server expects a raw value for the context runtime variable. If a custom property is being compared against a folder property, the server expects a formatted value.
Request URL
/v1/relationshipView/321Z0BS_0020J1F2500001R/folder/301YW1Y_0006CH7ZW00002G/result
Request
{"clientTimeZoneOffset":"-06:00","columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}],"contextRuntimeVariables":[{"constraintId":"321Z0BS_0020J8F25000040","value":"2012-09-21 00:00:00.000000"},{"constraintId":"321Z0BS_0020J8F25000042","value":"Default"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"5","dataType":"STRING","displayType":"VISIBLE","name":"Folder ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"5","value":"321Z0BC_001Z7NLP3000009"}]},{"fields":[{"columnId":"5","value":"321Z0B6_001YD12FK00009P"}]}]}

XML Samples

Sample 1 - Request to run a folder relationship view. Note that if a custom property is being compared against another custom property, the server expects a raw value for the context runtime variable. If a custom property is being compared against a folder property, the server expects a formatted value.
Request URL
/v1/relationshipView/321Z0BS_0020J1F2500001R/folder/301YW1Y_0006CH7ZW00002G/result
Request
<relationshipViewParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <contextRuntimeVariables>
        <contextRuntimeVariable>
            <constraintId>321Z0BS_0020J8F25000040</constraintId>
            <value>2012-09-21 00:00:00.000000</value>
        </contextRuntimeVariable>
        <contextRuntimeVariable>
            <constraintId>321Z0BS_0020J8F25000042</constraintId>
            <value>Default</value>
        </contextRuntimeVariable>
    </contextRuntimeVariables>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</relationshipViewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>5</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Folder ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>5</columnId>
                    <value>321Z0BC_001Z7NLP3000009</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>5</columnId>
                    <value>321Z0B6_001YD12FK00009P</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

RetentionHold (Version 1)

GET/v1/retentionhold Gets all retention holds.

Expand Operation / Collapse Operation

Gets all retention holds.

Available from version: 1.0.0

Call Properties

Query Parameter
includeInactive (optional) Determines whether to include inactive holds in the result. Default is false.
Response
Content
List of hold [hold]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

hold type

Represents a retention hold.

Field Name Data Type Expected Description
description String Yes The description of the hold.
expirationDate Long Yes The hold expiration date. If the hold is indefinite this value will not be set.
holdType holdType Yes The type of the hold.
id String Yes The unique id of the hold.
isActive boolean Yes Indicates whether the hold is active.
name String Yes The name of the hold.
holdType enumeration

The type of the retention hold.

Constant Name Description
PROTECT_ALL Prevents all modifications to the applied objects.
ALLOW_PROPERTY_CHANGES Allows document keys, custom properties, and forms to be modified.

JSON Samples

Sample 1 - Request without the includeInactive parameter (inactive holds not returned)
Request URL
/v1/retentionhold
Response
{"holds":[{"id":"3000184816_1738021400","name":"Strong Hold","description":"","isActive":true,"expirationDate":1468511919,"holdType":"PROTECT_ALL"},{"id":"301YW2J_00003B4TG000004","name":"Indefinite Hold","description":"This hold never expires","isActive":true,"expirationDate":null,"holdType":"ALLOW_PROPERTY_CHANGES"}]}
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL
/v1/retentionhold?includeInactive=true
Response
{"holds":[{"id":"3000184816_1738021400","name":"Strong Hold","description":"","isActive":true,"expirationDate":1468511919,"holdType":"PROTECT_ALL"},{"id":"301YW2J_00003B4TG000004","name":"Indefinite Hold","description":"This hold never expires","isActive":true,"expirationDate":null,"holdType":"ALLOW_PROPERTY_CHANGES"},{"id":"301YW2J_00003B4TG000004","name":"Indefinite Hold","description":"This hold never expires","isActive":true,"expirationDate":null,"holdType":"ALLOW_PROPERTY_CHANGES"}]}

XML Samples

Sample 1 - Request without the includeInactive parameter (inactive holds not returned)
Request URL
/v1/retentionhold
Response
<holds>
    <hold>
        <id>3000184816_1738021400</id>
        <name>Strong Hold</name>
        <description/>
        <isActive>true</isActive>
        <expirationDate>1468511919</expirationDate>
        <holdType>PROTECT_ALL</holdType>
    </hold>
    <hold>
        <id>301YW2J_00003B4TG000004</id>
        <name>Indefinite Hold</name>
        <description>This hold never expires</description>
        <isActive>true</isActive>
        <holdType>ALLOW_PROPERTY_CHANGES</holdType>
    </hold>
</holds>
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL
/v1/retentionhold?includeInactive=true
Response
<holds>
    <hold>
        <id>3000184816_1738021400</id>
        <name>Strong Hold</name>
        <description/>
        <isActive>true</isActive>
        <expirationDate>1468511919</expirationDate>
        <holdType>PROTECT_ALL</holdType>
    </hold>
    <hold>
        <id>301YW2J_00003B4TG000004</id>
        <name>Indefinite Hold</name>
        <description>This hold never expires</description>
        <isActive>true</isActive>
        <holdType>ALLOW_PROPERTY_CHANGES</holdType>
    </hold>
    <hold>
        <id>301YW2J_00003B4TG000004</id>
        <name>Indefinite Hold</name>
        <description>This hold never expires</description>
        <isActive>true</isActive>
        <holdType>ALLOW_PROPERTY_CHANGES</holdType>
    </hold>
</holds>

GET/v1/retentionhold/assignment Gets all direct and inherited retention hold assignments for the given object.

Expand Operation / Collapse Operation

Gets all direct and inherited retention hold assignments for the given object.

Available from version: 1.0.0

Call Properties

Query Parameters
objectId ID of the document, document type, record, or record folder whose assignments will be returned.
objectType holdObjectType The type of the object represented by the objectId parameter.
Response
Content
List of holdAssignment [holdAssignment]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

holdAssignment type

Represents the retention hold assignment for an object.

Field Name Data Type Expected Description
canRemove Boolean Yes A flag that indicates whether the current user has the priviliges to remove the hold assignment.
expirationTime Long Yes The time the hold expires.
holdDescription String Yes The description of the hold.
holdId String Yes The ID of the hold.
holdName String Yes The name of the hold.
holdObjectRelation holdAssignmentRelation Yes The relation of object causing the hold.
id String Yes The ID of the assignment.
objectId String Yes The ID of the object assigned to the hold.
objectType holdObjectType Yes The type of the object assigned to the hold.
holdAssignmentRelation enumeration

The type of retention hold relation.

Constant Name Description
DIRECT A direct hold.
INHERITANCE_TYPE An inherited hold by type.
INHERITANCE_ANCESTOR An inherited hold by ancestor.
holdObjectType enumeration

The object type represented by the retention hold assignment.

Constant Name Description
DOCUMENT_TYPE Document type assignment type.
DOCUMENT Document assignment type.
RECORD Record assignment type.
RECORD_FOLDER Record Folder assignment type.

JSON Samples

Sample 1 - Get hold assignments.
Request URL
/v1/retentionhold/assignment?objectId=301YW1J_000782VD90000C0&objectType=DOCUMENT
Response
{"holdAssignments":[{"id":"321YY36_0005ZC9M2000005","holdId":"301YW1J_000782VD90000B0","holdName":"hold 1 name","holdDescription":"hold 1 description","expirationTime":1468511919,"canRemove":true,"objectId":"301YW1J_000782VD90000C0","objectType":"DOCUMENT","holdObjectRelation":"DIRECT"},{"id":"321Z076_001Z16W9E00002N","holdId":"301YW1J_000782VD90000B1","holdName":"hold 2 name","holdDescription":"hold 2 description","expirationTime":null,"canRemove":false,"objectId":"301YW1J_000782VD90000C1","objectType":"DOCUMENT_TYPE","holdObjectRelation":"INHERITANCE_TYPE"}]}
Sample 2 - Get hold assignments.
Request URL
/v1/retentionhold/assignment?objectId=321Z07N_001ZLMNXS000002&objectType=RECORD
Response
{"holdAssignments":[{"id":"321YY36_0005ZC9M2000005","holdId":"301YW1J_000782VD90000B0","holdName":"hold 1 name","holdDescription":"hold 1 description","expirationTime":1468511919,"canRemove":false,"objectId":"321Z07N_001ZLMNXS000002","objectType":"RECORD","holdObjectRelation":"DIRECT"},{"id":"321Z076_001Z16W9E00002N","holdId":"301YW1J_000782VD90000B1","holdName":"hold 2 name","holdDescription":"hold 2 description","expirationTime":null,"canRemove":true,"objectId":"321YY2M_00050ZC7V000002","objectType":"RECORD_FOLDER","holdObjectRelation":"INHERITANCE_ANCESTOR"}]}

XML Samples

Sample 1 - Get hold assignments.
Request URL
/v1/retentionhold/assignment?objectId=301YW1J_000782VD90000C0&objectType=DOCUMENT
Response
<holdAssignments>
    <holdAssignment>
        <id>321YY36_0005ZC9M2000005</id>
        <holdId>301YW1J_000782VD90000B0</holdId>
        <holdName>hold 1 name</holdName>
        <holdDescription>hold 1 description</holdDescription>
        <expirationTime>1468511919</expirationTime>
        <canRemove>true</canRemove>
        <objectId>301YW1J_000782VD90000C0</objectId>
        <objectType>DOCUMENT</objectType>
        <holdObjectRelation>DIRECT</holdObjectRelation>
    </holdAssignment>
    <holdAssignment>
        <id>321Z076_001Z16W9E00002N</id>
        <holdId>301YW1J_000782VD90000B1</holdId>
        <holdName>hold 2 name</holdName>
        <holdDescription>hold 2 description</holdDescription>
        <canRemove>false</canRemove>
        <objectId>301YW1J_000782VD90000C1</objectId>
        <objectType>DOCUMENT_TYPE</objectType>
        <holdObjectRelation>INHERITANCE_TYPE</holdObjectRelation>
    </holdAssignment>
</holdAssignments>
Sample 2 - Get hold assignments.
Request URL
/v1/retentionhold/assignment?objectId=321Z07N_001ZLMNXS000002&objectType=RECORD
Response
<holdAssignments>
    <holdAssignment>
        <id>321YY36_0005ZC9M2000005</id>
        <holdId>301YW1J_000782VD90000B0</holdId>
        <holdName>hold 1 name</holdName>
        <holdDescription>hold 1 description</holdDescription>
        <expirationTime>1468511919</expirationTime>
        <canRemove>false</canRemove>
        <objectId>321Z07N_001ZLMNXS000002</objectId>
        <objectType>RECORD</objectType>
        <holdObjectRelation>DIRECT</holdObjectRelation>
    </holdAssignment>
    <holdAssignment>
        <id>321Z076_001Z16W9E00002N</id>
        <holdId>301YW1J_000782VD90000B1</holdId>
        <holdName>hold 2 name</holdName>
        <holdDescription>hold 2 description</holdDescription>
        <canRemove>true</canRemove>
        <objectId>321YY2M_00050ZC7V000002</objectId>
        <objectType>RECORD_FOLDER</objectType>
        <holdObjectRelation>INHERITANCE_ANCESTOR</holdObjectRelation>
    </holdAssignment>
</holdAssignments>

POST/v1/retentionhold/{id}/assignment Assigns a document, document type, record, or record folder to the given retention hold.

Expand Operation / Collapse Operation

Assigns a document, document type, record, or record folder to the given retention hold.

Available from version: 1.0.0

Call Properties

Request
Content holdAssignment
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the newly created assignment.

Call Types and Enumerations

holdAssignment type

Object to be assigned to a retention hold.

Field Name Data Type Expected Description
comments String No Optional comments about the hold assignment displayed in the hold history.
objectId String Yes ID of a document, document type, record, or record folder.
objectType holdObjectType Yes The type of the object being assigned to the hold.
holdObjectType enumeration

The object type represented by the retention hold assignment.

Constant Name Description
DOCUMENT_TYPE Document type assignment type.
DOCUMENT Document assignment type.
RECORD Record assignment type.
RECORD_FOLDER Record Folder assignment type.

JSON Samples

Sample 1 - Assign a document to a retention hold.
Request URL
/v1/retentionhold/301YW1J_000782VD90000B8/assignment
Request
{"objectId":"321YY2M_00050YC7V000009","objectType":"DOCUMENT","comments":null}
Sample 2 - Assign a record folder to a retention hold.
Request URL
/v1/retentionhold/301YW1J_000782VD90000B8/assignment
Request
{"objectId":"301YVDX_0003RW4Y1000001","objectType":"RECORD_FOLDER","comments":"This is a comment"}

XML Samples

Sample 1 - Assign a document to a retention hold.
Request URL
/v1/retentionhold/301YW1J_000782VD90000B8/assignment
Request
<holdAssignment>
    <objectId>321YY2M_00050YC7V000009</objectId>
    <objectType>DOCUMENT</objectType>
</holdAssignment>
Sample 2 - Assign a record folder to a retention hold.
Request URL
/v1/retentionhold/301YW1J_000782VD90000B8/assignment
Request
<holdAssignment>
    <objectId>301YVDX_0003RW4Y1000001</objectId>
    <objectType>RECORD_FOLDER</objectType>
    <comments>This is a comment</comments>
</holdAssignment>

DELETE/v1/retentionhold/{id}/assignment/{assignmentId} Unassigns an object from a retention hold.

Expand Operation / Collapse Operation

Unassigns an object from a retention hold.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1 - Request to remove a retention hold assignment.
Request URL
/v1/retentionhold/301YW1J_000782VD90000B8/assignment/301YVDD_00005MTV200000A

XML Samples

Sample 1 - Request to remove a retention hold assignment.
Request URL
/v1/retentionhold/301YW1J_000782VD90000B8/assignment/301YVDD_00005MTV200000A

RetentionHold (Version 2)

GET/v2/retentionhold Gets all retention holds.

Expand Operation / Collapse Operation

Gets all retention holds.

Available from version: 1.0.0

Call Properties

Query Parameter
includeInactive (optional) Determines whether to include inactive holds in the result. Default is false.
Response
Content
List of hold [hold]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

hold type

Represents a retention hold.

Field Name Data Type Expected Description
description String Yes The description of the hold.
expirationDate Long Yes The hold expiration date. If the hold is indefinite this value will not be set.
holdType holdType Yes The type of the hold.
id String Yes The unique id of the hold.
isActive boolean Yes Indicates whether the hold is active.
name String Yes The name of the hold.
privileges retentionPrivileges Yes The requesting user's privileges for the hold.
holdType enumeration

The type of the retention hold.

Constant Name Description
PROTECT_ALL Prevents all modifications to the applied objects.
ALLOW_PROPERTY_CHANGES Allows document keys, custom properties, and forms to be modified.
retentionPrivileges type

Full set of retention hold privileges

Field Name Data Type Expected Description
apply Boolean Yes Indicates the user can apply this hold to a document.
remove Boolean Yes Indicates the user can remove this hold from a document.
search Boolean Yes Indicates the user can search for documents having this hold applied.

JSON Samples

Sample 1 - Request without the includeInactive parameter (inactive holds not returned)
Request URL
/v2/retentionhold
Response
{"holds":[{"id":"3000184816_1738021400","name":"Strong Hold","description":"","isActive":true,"expirationDate":1468511919,"holdType":"PROTECT_ALL","privileges":{"apply":true,"remove":true,"search":true}},{"id":"301YW2J_00003B4TG000004","name":"Indefinite Hold","description":"This hold never expires","isActive":true,"expirationDate":null,"holdType":"ALLOW_PROPERTY_CHANGES","privileges":{"apply":false,"remove":false,"search":true}}]}
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL
/v2/retentionhold?includeInactive=true
Response
{"holds":[{"id":"3000184816_1738021400","name":"Strong Hold","description":"","isActive":true,"expirationDate":1468511919,"holdType":"PROTECT_ALL","privileges":{"apply":true,"remove":true,"search":true}},{"id":"301YW2J_00003B4TG000004","name":"Indefinite Hold","description":"This hold never expires","isActive":true,"expirationDate":null,"holdType":"ALLOW_PROPERTY_CHANGES","privileges":{"apply":false,"remove":false,"search":true}},{"id":"301YW2J_00003B4TG000004","name":"Indefinite Hold","description":"This hold never expires","isActive":true,"expirationDate":null,"holdType":"ALLOW_PROPERTY_CHANGES","privileges":{"apply":false,"remove":false,"search":true}}]}

XML Samples

Sample 1 - Request without the includeInactive parameter (inactive holds not returned)
Request URL
/v2/retentionhold
Response
<holds>
    <hold>
        <id>3000184816_1738021400</id>
        <name>Strong Hold</name>
        <description/>
        <isActive>true</isActive>
        <expirationDate>1468511919</expirationDate>
        <holdType>PROTECT_ALL</holdType>
        <privileges>
            <apply>true</apply>
            <remove>true</remove>
            <search>true</search>
        </privileges>
    </hold>
    <hold>
        <id>301YW2J_00003B4TG000004</id>
        <name>Indefinite Hold</name>
        <description>This hold never expires</description>
        <isActive>true</isActive>
        <holdType>ALLOW_PROPERTY_CHANGES</holdType>
        <privileges>
            <apply>false</apply>
            <remove>false</remove>
            <search>true</search>
        </privileges>
    </hold>
</holds>
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL
/v2/retentionhold?includeInactive=true
Response
<holds>
    <hold>
        <id>3000184816_1738021400</id>
        <name>Strong Hold</name>
        <description/>
        <isActive>true</isActive>
        <expirationDate>1468511919</expirationDate>
        <holdType>PROTECT_ALL</holdType>
        <privileges>
            <apply>true</apply>
            <remove>true</remove>
            <search>true</search>
        </privileges>
    </hold>
    <hold>
        <id>301YW2J_00003B4TG000004</id>
        <name>Indefinite Hold</name>
        <description>This hold never expires</description>
        <isActive>true</isActive>
        <holdType>ALLOW_PROPERTY_CHANGES</holdType>
        <privileges>
            <apply>false</apply>
            <remove>false</remove>
            <search>true</search>
        </privileges>
    </hold>
    <hold>
        <id>301YW2J_00003B4TG000004</id>
        <name>Indefinite Hold</name>
        <description>This hold never expires</description>
        <isActive>true</isActive>
        <holdType>ALLOW_PROPERTY_CHANGES</holdType>
        <privileges>
            <apply>false</apply>
            <remove>false</remove>
            <search>true</search>
        </privileges>
    </hold>
</holds>

ServerAction (Version 1)

POST/v1/serverAction Runs an iScript on the server

Expand Operation / Collapse Operation

Runs an iScript on the server

Available from version: 1.0.0

Call Properties

Request
Content serverActionRequest
Content-Types
  • application/xml
  • application/json
Response
Content
serverActionResponse
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

serverActionRequest type

The request for a serverAction call.

Field Name Data Type Expected Description
filePath String Yes The name of the script to be executed.
inputParams List of String [inputParam] No A list of params to be passed to the script. These can be accessed using getInputParams() from your script, which returns the params as an array of strings.
mode String Yes The mode for the action. Currently only supports 'SCRIPT'.
serverActionResponse type

The response of a serverAction call.

Field Name Data Type Expected Description
outputParams List of String [outputParam] No The output parameters from the script. These are set using setOutputParams() from the script. setOutputParams() takes an array as its arguments.

JSON Samples

Sample 1
Request URL
/v1/serverAction
Request
{"mode":"SCRIPT","filePath":"returnInputParams.js","inputParams":["Param1","Param2"]}
Response
{"outputParams":["Param1","Param2"]}

XML Samples

Sample 1
Request URL
/v1/serverAction
Request
<serverActionRequest>
    <mode>SCRIPT</mode>
    <filePath>returnInputParams.js</filePath>
    <inputParams>
        <inputParam>Param1</inputParam>
        <inputParam>Param2</inputParam>
    </inputParams>
</serverActionRequest>
Response
<serverActionResponse>
    <outputParams>
        <outputParam>Param1</outputParam>
        <outputParam>Param2</outputParam>
    </outputParams>
</serverActionResponse>

ServerInfo (Version 1)

GET/v1/serverInfo Gets all server information.

Expand Operation / Collapse Operation

Gets all server information.

Available from version: 1.0.0

Call Properties

Response
Content
serverInfo
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

serverInfo type

Contains server information.

Field Name Data Type Expected Description
version String Yes Current version of Integration Server

JSON Samples

Sample 1
Request URL
/v1/serverInfo
Response
{"version":"1.2.3.4"}

XML Samples

Sample 1
Request URL
/v1/serverInfo
Response
<serverInfo>
    <version>1.2.3.4</version>
</serverInfo>

ServerInfo (Version 2)

GET/v2/serverInfo Gets version information.

Expand Operation / Collapse Operation

Gets version information.

Available from version: 1.0.0

Call Properties

Response
Content
serverInfo
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

serverInfo type

Contains version information for Integration Server.

Field Name Data Type Expected Description
buildVersion String Yes Current build version of Integration Server
interfaceVersion String Yes Current interface version of Integration Server

JSON Samples

Sample 1
Request URL
/v2/serverInfo
Response
{"buildVersion":"7.1.0.5","interfaceVersion":"7.1-1.3.2"}

XML Samples

Sample 1
Request URL
/v2/serverInfo
Response
<serverInfo>
    <buildVersion>7.1.0.5</buildVersion>
    <interfaceVersion>7.1-1.3.2</interfaceVersion>
</serverInfo>

ServiceStatus (Version 1)

GET/v1/status Retrieve state of integration server and its dependent services.

Expand Operation / Collapse Operation

Retrieve state of integration server and its dependent services.

Available from version: 1.0.0

Call Properties

Response
Content
serviceStatus
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

perceptiveContentState enumeration

State of Perceptive Content service.

Constant Name Description
INSERVER_UP Perceptive Content is up and accepting requests.
INSERVER_DOWN_DB_ERROR Perceptive Content is experiencing database connection issues and is unable to process requests successfully.
INSERVER_DOWN_UNREACHABLE Perceptive Content is unreachable.
serviceStatus type

Contains service's health status.

Field Name Data Type Expected Description
perceptiveContentStatus perceptiveContentState Yes Listening state of Perceptive Content service.

JSON Samples

Sample 1
Request URL
/v1/status
Response
{"perceptiveContentStatus":"INSERVER_UP"}
Sample 2
Request URL
/v1/status
Response
{"perceptiveContentStatus":"INSERVER_DOWN_DB_ERROR"}
Sample 3
Request URL
/v1/status
Response
{"perceptiveContentStatus":"INSERVER_DOWN_UNREACHABLE"}

XML Samples

Sample 1
Request URL
/v1/status
Response
<serviceStatus>
    <perceptiveContentStatus>INSERVER_UP</perceptiveContentStatus>
</serviceStatus>
Sample 2
Request URL
/v1/status
Response
<serviceStatus>
    <perceptiveContentStatus>INSERVER_DOWN_DB_ERROR</perceptiveContentStatus>
</serviceStatus>
Sample 3
Request URL
/v1/status
Response
<serviceStatus>
    <perceptiveContentStatus>INSERVER_DOWN_UNREACHABLE</perceptiveContentStatus>
</serviceStatus>

Sso (Version 1)

GET/v1/sso/callback/{profileName} A redirection endpoint for the OpenID Connect Authorization Code Flow.

Expand Operation / Collapse Operation

A redirection endpoint for the OpenID Connect Authorization Code Flow.

Available from version: 6.0.0

Call Properties

Path Parameter
profileName The name of the login profile associated with the original login request.
Query Parameters
code The authorization code from an OpenID provider.
state The state information from the authorization request.
error (optional) An error response code from the Authorization Server.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1 - OpenID Connect callback for the query response mode.
Request URL
/v1/sso/callback/default?code=1234567890abcdef&state=abcD3fGh

XML Samples

Sample 1 - OpenID Connect callback for the query response mode.
Request URL
/v1/sso/callback/default?code=1234567890abcdef&state=abcD3fGh

POST/v1/sso/callback/{profileName} A redirection endpoint for the OpenID Connect Authorization Code Flow.

Expand Operation / Collapse Operation

A redirection endpoint for the OpenID Connect Authorization Code Flow.

Available from version: 6.0.0

Call Properties

Path Parameter
profileName The name of the login profile associated with the original login request.
Request
Content Form
Content-Type
  • application/x-www-form-urlencoded
Response
Content
None
Content-Type Not Applicable

Form Samples

GET/v1/sso/login Initiates a single sign-on (SSO) flow based on the SSO configuration using the default login prof...

Expand Operation / Collapse Operation

Initiates a single sign-on (SSO) flow based on the SSO configuration using the default login profile.

Available from version: 6.0.0

Call Properties

Query Parameter
state (optional) The opaque value that is used to maintain state during the login flow. Allowed characters for state values include alphanumeric, underscores, hyphens, equals and spaces. State is returned via a header value on the callback response. If a redirect is configured the state is returned via a query parameter.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1 - Login endpoint for the default login profile.
Request URL
/v1/sso/login
Sample 2 - Login endpoint with state.
Request URL
/v1/sso/login?state=7496d5bb-b9d6-48ff-8f40-ae51564a33bf

XML Samples

Sample 1 - Login endpoint for the default login profile.
Request URL
/v1/sso/login
Sample 2 - Login endpoint with state.
Request URL
/v1/sso/login?state=7496d5bb-b9d6-48ff-8f40-ae51564a33bf

GET/v1/sso/login/{profileName} Initiates a single sign-on (SSO) flow based on the SSO configuration using the specified login pr...

Expand Operation / Collapse Operation

Initiates a single sign-on (SSO) flow based on the SSO configuration using the specified login profile.

Available from version: 6.0.0

Call Properties

Path Parameter
profileName The name of the login profile to use.
Query Parameter
state (optional) The opaque value that is used to maintain state during the login flow. Allowed characters for state values include alphanumeric, underscores, hyphens, equals and spaces. State is returned via a header value on the callback response. If a redirect is configured the state is returned via a query parameter.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1 - Login endpoint for a login profile named customapp.
Request URL
/v1/sso/login/customapp
Sample 2 - Login endpoint with state for a login profile named customapp.
Request URL
/v1/sso/login/customapp?state=5505cd5e-a945-4038-86b3-ddcf349d7415

XML Samples

Sample 1 - Login endpoint for a login profile named customapp.
Request URL
/v1/sso/login/customapp
Sample 2 - Login endpoint with state for a login profile named customapp.
Request URL
/v1/sso/login/customapp?state=5505cd5e-a945-4038-86b3-ddcf349d7415

Task (Version 1)

POST/v1/task Creates a new task on the specified document or folder.

Expand Operation / Collapse Operation

Creates a new task on the specified document or folder.

Available from version: 1.0.0

Call Properties

Request
Content createTask
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

createTask type

Creates a task on the specified document or folder.

Field Name Data Type Expected Description
annotationPageNumber Integer Yes The page number that the task visual representation is created on, or -1 if no visual representation.
assignedUsersOrGroup List of String [assignedUserOrGroup] Yes The list of user IDs or group ID assigned to the task.
comment String Yes The comments for the task.
documentId String Yes The ID of the document that the task is created on.
dueDate Long Yes The due date for the completion of the task.
expedite Boolean Yes If true, the task is expedited.
folderId String Yes The ID of the folder that the task is created on.
instructions String Yes The instructions for the task.
oneTaskPerUser Boolean Yes If true, then a separate task is created for each assigned user.
pageId String Yes The ID of the page that the task is created on.
queueId String Yes The queue ID of the workflow queue that the document or folder is added to.
sendFolderToWorkflow Boolean Yes If true, the folder that contains the task's document is sent to workflow.
startDate Long Yes The start date of the task.
taskTemplateId String Yes The unique ID of the task template.
taskType taskType Yes The type of the task. The taskType enumeration provides the possible values for this data element. Creation of approval tasks is not supported.
taskType enumeration

This table lists the possible values for the taskType enumeration, which indicates the ImageNow task type.

Constant Name Description
SIGNATURE_REQUIRED ImageNow provides the signature required task type for when a document requires a digital signature.
DOCUMENT_DEFICIENCY ImageNow provides the document deficiency task type for when a document or folder is missing or incomplete.
POINTER ImageNow provides the pointer task type for when there is a need to draw attention to a specific document or folder for further action.
APPROVAL An approval task is a task type that Retention Policy Designer automatically generates for all approvers assigned within a retention policy.

JSON Samples

Sample 1
Request URL
/v1/task
Request
{"taskTemplateId":"301YV8B_000005HLH001564","taskType":"DOCUMENT_DEFICIENCY","folderId":"","documentId":"301YV8B_000005HLH028B9D","pageId":"301YV8B_000005HLH0DCABB","startDate":1330035331817,"dueDate":1496035339568,"instructions":"Instructions for completing the task.","comment":"Task comments","expedite":true,"queueId":"301YV8B_000005HLH00000B","sendFolderToWorkflow":false,"annotationPageNumber":1,"oneTaskPerUser":false,"assignedUsersOrGroup":["301YV8B_000005HLH0FED3B","301YV8B_000005HLH0908D3"]}

XML Samples

Sample 1
Request URL
/v1/task
Request
<createTask>
    <taskTemplateId>301YV8B_000005HLH001564</taskTemplateId>
    <taskType>DOCUMENT_DEFICIENCY</taskType>
    <folderId/>
    <documentId>301YV8B_000005HLH028B9D</documentId>
    <pageId>301YV8B_000005HLH0DCABB</pageId>
    <startDate>1330035331817</startDate>
    <dueDate>1496035339568</dueDate>
    <instructions>Instructions for completing the task.</instructions>
    <comment>Task comments</comment>
    <expedite>true</expedite>
    <queueId>301YV8B_000005HLH00000B</queueId>
    <sendFolderToWorkflow>false</sendFolderToWorkflow>
    <annotationPageNumber>1</annotationPageNumber>
    <oneTaskPerUser>false</oneTaskPerUser>
    <assignedUsersOrGroup>
        <assignedUserOrGroup>301YV8B_000005HLH0FED3B</assignedUserOrGroup>
        <assignedUserOrGroup>301YV8B_000005HLH0908D3</assignedUserOrGroup>
    </assignedUsersOrGroup>
</createTask>

DELETE/v1/task/{id} Deletes a task.

Expand Operation / Collapse Operation

Deletes a task.

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/task/301YVDD_00005MTV200000H

XML Samples

Sample 1
Request URL
/v1/task/301YVDD_00005MTV200000H

GET/v1/task/{id}

Expand Operation / Collapse Operation

Available from version: 1.0.0

Call Properties

Response
Content
task
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

task type

This table describes the elements of the task type.

Field Name Data Type Expected Description
actionReasonListId String Yes The unique ID for the action reason list. For more information on reason lists, refer to GET: /reasonList/{id}/reason.
assignedGroups List of String [assignedGroup] Yes The list of ImageNow user groups assigned to the task. There is one instance of assignedGroup for each user group.
assignedUsers List of String [assignedUser] Yes The list of ImageNow users assigned to the task. There is one instance of assignedUser for each user.
assigningUser String Yes The ImageNow user who assigned the task.
assignmentDate Long Yes The date/time the task was assigned.
completionDate Long No The date/time that the user completed the task.
completionType taskCompletionType Yes The method of completion for the task. The taskCompletionType enumeration provides the possible values for this data element.
completionUser String No The ImageNow user who completed the task.
creationDate Long Yes The date/time that the user created the task.
creationUser String Yes The ImageNow user who created the task.
deleteCompletedTask Boolean Yes If true, ImageNow Server deletes the task upon completion. If false, ImageNow Server does not delete the task upon completion.
dueDate Long Yes The due date/time for the completion of the task.
expedite Boolean Yes If true, the task is marked as expedited in ImageNow and should be presented to the assignee first when starting automatic task processing. If false, the task is not marked as expedited in ImageNow and should receive no special ordering.
id String Yes The unique ID of the task.
location taskLocation Yes Indicates whether a task is associated with a document, a document page, or a folder. The taskLocation enumeration provides the possible values for this data element.
modificationDate Long Yes The date/time that the user last modified the task.
modificationUser String Yes The ImageNow user who last modified the task.
returnReasonListId String Yes The unique ID for the return reason list. For more information on reason lists, refer to GET: /reasonList/{id}/reason.
reviewDate Long No The date/time that the user reviewed the task.
reviewUser String No The ImageNow user who reviewed the task.
startDate Long Yes The start date/time of the task.
status taskStatus Yes The status of the task. The taskStatus enumeration provides the possible values for this data element.
templateId String Yes The unique ID of the task template associated with the task.
templateName String Yes The name in your ImageNow system of the task template associated with the task.
type taskType Yes The type of the task. The taskType enumeration provides the possible values for this data element.
taskCompletionType enumeration

This table lists the possible values for the taskCompletionType enumeration, which indicates the method for completing a task.

Constant Name Description
AUTO_COMPLETE_WITH_DIGITAL_SIGNATURE ImageNow automatically completes the task after the user digitally signs the associated document.
COMPLETE_PENDING_REVIEW After the task assignee completes the task, a specified ImageNow user is required to review the task.
MANUAL_COMPLETE The task is complete after the assignee marks it as complete.
taskLocation enumeration

This table lists the possible values for the taskLocation enumeration, which indicates the type of ImageNow object associated with the task.

Constant Name Description
DOCUMENT The task is associated with an entire document.
DOCUMENT_PAGE The task is associated with a page in a document. Note that in ImageNow, a document might be comprised of multiple files, and each file is considered a page.
FOLDER The task is associated with a folder.
taskStatus enumeration

This table lists the possible values for the taskStatus enumeration, which indicates the current status of the task.

Constant Name Description
ASSIGNED The task is assigned to a user and is awaiting the user's completion.
RETURNED The task was returned to the assigning user because it cannot be completed in its current form.
COMPLETE_PENDING_REVIEW The task was marked as complete by the assigned user and is awaiting review by a review user.
COMPLETE The task was completed.
CANCELLED The task was cancelled and is not awaiting completion.
INVALID The task is invalid because either the associated document, document page, or folder was deleted.
taskType enumeration

This table lists the possible values for the taskType enumeration, which indicates the ImageNow task type.

Constant Name Description
SIGNATURE_REQUIRED ImageNow provides the signature required task type for when a document requires a digital signature.
DOCUMENT_DEFICIENCY ImageNow provides the document deficiency task type for when a document or folder is missing or incomplete.
POINTER ImageNow provides the pointer task type for when there is a need to draw attention to a specific document or folder for further action.
APPROVAL An approval task is a task type that Retention Policy Designer automatically generates for all approvers assigned within a retention policy.

JSON Samples

Sample 1
Request URL
/v1/task/301YW2Q_0004HFZ1900009G
Response
{"id":"301YW2Q_0004HFZ1900009G","templateId":"301YW2P_0004HGZ190000X2","templateName":"Accounting Task Template","type":"DOCUMENT_DEFICIENCY","assignmentDate":1330035331817,"assigningUser":"JohnDoe","startDate":1330035300000,"dueDate":1330063140000,"status":"ASSIGNED","location":"DOCUMENT","completionType":"MANUAL_COMPLETE","deleteCompletedTask":false,"expedite":true,"creationUser":"JohnDoe","creationDate":1330035331817,"modificationUser":"JohnDoe","modificationDate":1330035361033,"completionUser":"JaneDoe","completionDate":1330062170020,"reviewUser":"JohnSmith","reviewDate":1330062180230,"returnReasonListId":"301YVD9_000005LB4000009","actionReasonListId":"301YVD9_000005LB4000004","assignedUsers":["JaneDoe"],"assignedGroups":[]}

XML Samples

Sample 1
Request URL
/v1/task/301YW2Q_0004HFZ1900009G
Response
<task>
    <id>301YW2Q_0004HFZ1900009G</id>
    <templateId>301YW2P_0004HGZ190000X2</templateId>
    <templateName>Accounting Task Template</templateName>
    <type>DOCUMENT_DEFICIENCY</type>
    <assignmentDate>1330035331817</assignmentDate>
    <assigningUser>JohnDoe</assigningUser>
    <assignedUsers>
        <assignedUser>JaneDoe</assignedUser>
    </assignedUsers>
    <assignedGroups/>
    <startDate>1330035300000</startDate>
    <dueDate>1330063140000</dueDate>
    <status>ASSIGNED</status>
    <location>DOCUMENT</location>
    <completionType>MANUAL_COMPLETE</completionType>
    <deleteCompletedTask>false</deleteCompletedTask>
    <expedite>true</expedite>
    <creationUser>JohnDoe</creationUser>
    <creationDate>1330035331817</creationDate>
    <modificationUser>JohnDoe</modificationUser>
    <modificationDate>1330035361033</modificationDate>
    <completionUser>JaneDoe</completionUser>
    <completionDate>1330062170020</completionDate>
    <reviewUser>JohnSmith</reviewUser>
    <reviewDate>1330062180230</reviewDate>
    <returnReasonListId>301YVD9_000005LB4000009</returnReasonListId>
    <actionReasonListId>301YVD9_000005LB4000004</actionReasonListId>
</task>

GET/v1/task/{id}/comment

Expand Operation / Collapse Operation

Available from version: 1.0.0

Call Properties

Response
Content
List of comment [comment]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

comment type

The comment type provides information about an ImageNow task comment.

Field Name Data Type Expected Description
creationTime Long Yes The date/time the comment was created.
id String Yes The unique ID associated with the comment.
text String Yes The comment associated with the task in ImageNow Server presented as a text string.
userName String Yes The ImageNow user name of the person who made the comment.

JSON Samples

Sample 1
Request URL
/v1/task/301YW1L_000BYT6SB000009/comment
Response
{"comments":[{"id":"301YW1L_000BYT6SB000009","text":"Also send to Marketing for review.","userName":"JohnDoe","creationTime":1326991948777}]}

XML Samples

Sample 1
Request URL
/v1/task/301YW1L_000BYT6SB000009/comment
Response
<comments>
    <comment>
        <id>301YW1L_000BYT6SB000009</id>
        <text>Also send to Marketing for review.</text>
        <userName>JohnDoe</userName>
        <creationTime>1326991948777</creationTime>
    </comment>
</comments>

POST/v1/task/{id}/comment

Expand Operation / Collapse Operation

Available from version: 1.0.0

Call Properties

Request
Content comment
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

comment type

The comment type provides the text string for an ImageNow task comment.

Field Name Data Type Expected Description
text String Yes This is the comment text to associate with the task.

JSON Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/comment
Request
{"text":"Also send to Marketing for review."}

XML Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/comment
Request
<comment>
    <text>Also send to Marketing for review.</text>
</comment>

POST/v1/task/{id}/completeAction

Expand Operation / Collapse Operation

Available from version: 1.0.0

Call Properties

Request
Content taskCompleteAction
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

taskCompleteAction type

The taskCompleteAction type provides ImageNow Server with the necessary information to complete a task.

Field Name Data Type Expected Description
reasonId String No The unique ID of the reason the user selected to indicate why the task is complete.
signaturePassword String No The current password of the digital signature.
versionNumber Integer No The version number of the document associated with the task. Integration Server returns an exception if the versionNumber value does not match latest version number in your ImageNow system.

JSON Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/completeAction
Request
{"versionNumber":2,"reasonId":"301YV96_00002X62H000007","signaturePassword":"oldpassword123"}

XML Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/completeAction
Request
<taskCompleteAction>
    <versionNumber>2</versionNumber>
    <reasonId>301YV96_00002X62H000007</reasonId>
    <signaturePassword>oldpassword123</signaturePassword>
</taskCompleteAction>

POST/v1/task/{id}/returnAction

Expand Operation / Collapse Operation

Available from version: 1.0.0

Call Properties

Request
Content taskReturnAction
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

taskReturnAction type

The following table describes the elements of the taskReturnAction type.

Field Name Data Type Expected Description
comment String No A comment provided by the user.
reasonId String No The unique ID of the reason the user selected to indicate why the task is being returned. This parameter is required only if the task template requires a reason.

JSON Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/returnAction
Request
{"reasonId":"301YV8B_000005HLH00000B","comment":"My review of this document is not required."}

XML Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/returnAction
Request
<taskReturnAction>
    <reasonId>301YV8B_000005HLH00000B</reasonId>
    <comment>My review of this document is not required.</comment>
</taskReturnAction>

POST/v1/task/{id}/skipAction

Expand Operation / Collapse Operation

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/skipAction

XML Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/skipAction

GET/v1/task/{id}/visualRepresentation Gets the metadata associated with the visual representation of a task.

Expand Operation / Collapse Operation

Gets the metadata associated with the visual representation of a task.

Available from version: 1.0.0

Call Properties

Response
Content
taskVisualRepresentation
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

accessInfo type

The user and time information describing how a task visual representation was accessed

Field Name Data Type Expected Description
time Long Yes The time the task visual representation was accessed
userId String Yes The user ID
userName String Yes The user name
point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
privileges type

Represents privilege information about a task visual representation

Field Name Data Type Expected Description
canDelete boolean Yes This flag determines if the task visual representation can be deleted.
canHide boolean Yes This flag determines if the task visual representation can be hidden.
canModify boolean Yes This flag determines if the task visual representation can be modified.
startLocation type

The file page location of a task visual representation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
taskType enumeration

This table lists the possible values for the taskType enumeration, which indicates the ImageNow task type.

Constant Name Description
SIGNATURE_REQUIRED ImageNow provides the signature required task type for when a document requires a digital signature.
DOCUMENT_DEFICIENCY ImageNow provides the document deficiency task type for when a document or folder is missing or incomplete.
POINTER ImageNow provides the pointer task type for when there is a need to draw attention to a specific document or folder for further action.
APPROVAL An approval task is a task type that Retention Policy Designer automatically generates for all approvers assigned within a retention policy.
taskVisualRepresentation type

The metadata elements defined for the taskVisualRepresentation type.

Field Name Data Type Expected Description
creationInfo accessInfo Yes The creation information for the task visual representation
filePageNumber Integer Yes The multi-page TIFF file page number for the task visual representation
id String Yes The ID of the task visual representation
location startLocation Yes The location on the file page of the task visual representation
modificationInfo accessInfo Yes The modification information for the task visual representation
pageId String Yes The file page id for the task visual representation
privileges privileges Yes The privilege information for this task visual representation
taskType taskType Yes The type of the associated task. The taskType enumeration provides the possible values for this data element.

JSON Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/visualRepresentation
Response
{"id":"301YW2Q_0004HFZ1900009G","taskType":"DOCUMENT_DEFICIENCY","pageId":"321YZ19_000J6YKL4000023","filePageNumber":2,"location":{"startPoint":{"x":2217,"y":451}},"creationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396534818487},"modificationInfo":{"userId":"321YX18_0000CCVZL000001","userName":"jdoe","time":1396534818487},"privileges":{"canHide":false,"canModify":false,"canDelete":false}}

XML Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/visualRepresentation
Response
<taskVisualRepresentation>
    <id>301YW2Q_0004HFZ1900009G</id>
    <taskType>DOCUMENT_DEFICIENCY</taskType>
    <pageId>321YZ19_000J6YKL4000023</pageId>
    <filePageNumber>2</filePageNumber>
    <location>
        <startPoint>
            <x>2217</x>
            <y>451</y>
        </startPoint>
    </location>
    <creationInfo>
        <userId>321YX18_0000CCVZL000001</userId>
        <userName>jdoe</userName>
        <time>1396534818487</time>
    </creationInfo>
    <modificationInfo>
        <userId>321YX18_0000CCVZL000001</userId>
        <userName>jdoe</userName>
        <time>1396534818487</time>
    </modificationInfo>
    <privileges>
        <canHide>false</canHide>
        <canModify>false</canModify>
        <canDelete>false</canDelete>
    </privileges>
</taskVisualRepresentation>

PUT/v1/task/{id}/visualRepresentation Updates a task visual representation on a page

Expand Operation / Collapse Operation

Updates a task visual representation on a page

Available from version: 1.0.0

Call Properties

Request
Content taskVisualRepresentation
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

point type

Represents a point

Field Name Data Type Expected Description
x Integer Yes X coordinate
y Integer Yes Y coordinate
startLocation type

The file page location of a task visual representation

Field Name Data Type Expected Description
startPoint point Yes The starting point of the annotation
taskVisualRepresentation type

The metadata elements defined for the taskVisualRepresentation type.

Field Name Data Type Expected Description
location startLocation Yes The location on the file page of the task visual representation

JSON Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/visualRepresentation
Request
{"location":{"startPoint":{"x":1234,"y":4321}}}

XML Samples

Sample 1
Request URL
/v1/task/301YP7L_000BY149B00006E/visualRepresentation
Request
<taskVisualRepresentation>
    <location>
        <startPoint>
            <x>1234</x>
            <y>4321</y>
        </startPoint>
    </location>
</taskVisualRepresentation>

Task (Version 2)

GET/v2/task/{id} This API call requests detailed information about the task in ImageNow Server that matches the gi...

Expand Operation / Collapse Operation

This API call requests detailed information about the task in ImageNow Server that matches the given ID. Integration Server structures the response using the task type.

Available from version: 1.0.0

Call Properties

Response
Content
task
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

task type

This table describes the elements of the task type.

Field Name Data Type Expected Description
actionReasonListId String Yes The unique ID for the action reason list. For more information on reason lists, refer to GET: /reasonList/{id}/reason.
actionReasonRequired Boolean Yes If true, the user must specify a reason when completing the task. If false, the user may complete the task without specifying a reason.
assignedGroups List of String [assignedGroup] Yes The list of ImageNow user groups assigned to the task. There is one instance of assignedGroup for each user group.
assignedUsers List of String [assignedUser] Yes The list of ImageNow users assigned to the task. There is one instance of assignedUser for each user.
assigningUser String Yes The ImageNow user who assigned the task.
assignmentDate Long Yes The date/time the task was assigned.
completionDate Long No The date/time that the user completed the task.
completionType taskCompletionType Yes The method of completion for the task. The taskCompletionType enumeration provides the possible values for this data element.
completionUser String No The ImageNow user who completed the task.
creationDate Long Yes The date/time that the user created the task.
creationUser String Yes The ImageNow user who created the task.
deleteCompletedTask Boolean Yes If true, ImageNow Server deletes the task upon completion. If false, ImageNow Server does not delete the task upon completion.
dueDate Long Yes The due date/time for the completion of the task.
expedite Boolean Yes If true, the task is marked as expedited in ImageNow and should be presented to the assignee first when starting automatic task processing. If false, the task is not marked as expedited in ImageNow and should receive no special ordering.
id String Yes The unique ID of the task.
location taskLocation Yes Indicates whether a task is associated with a document, a document page, or a folder. The taskLocation enumeration provides the possible values for this data element.
modificationDate Long Yes The date/time that the user last modified the task.
modificationUser String Yes The ImageNow user who last modified the task.
pageId String Yes The page ID of the task.
returnReasonListId String Yes The unique ID for the return reason list. For more information on reason lists, refer to GET: /reasonList/{id}/reason.
returnReasonRequired Boolean Yes If true, the user must specify a reason when returning the task. If false, the user may return the task without specifying a reason.
reviewDate Long No The date/time that the user reviewed the task.
reviewUser String No The ImageNow user who reviewed the task.
startDate Long Yes The start date/time of the task.
status taskStatus Yes The status of the task. The taskStatus enumeration provides the possible values for this data element.
templateId String Yes The unique ID of the task template associated with the task.
templateName String Yes The name in your ImageNow system of the task template associated with the task.
type taskType Yes The type of the task. The taskType enumeration provides the possible values for this data element.
taskCompletionType enumeration

This table lists the possible values for the taskCompletionType enumeration, which indicates the method for completing a task.

Constant Name Description
AUTO_COMPLETE_WITH_DIGITAL_SIGNATURE ImageNow automatically completes the task after the user digitally signs the associated document.
COMPLETE_PENDING_REVIEW After the task assignee completes the task, a specified ImageNow user is required to review the task.
MANUAL_COMPLETE The task is complete after the assignee marks it as complete.
taskLocation enumeration

This table lists the possible values for the taskLocation enumeration, which indicates the type of ImageNow object associated with the task.

Constant Name Description
DOCUMENT The task is associated with an entire document.
DOCUMENT_PAGE The task is associated with a page in a document. Note that in ImageNow, a document might be comprised of multiple files, and each file is considered a page.
FOLDER The task is associated with a folder.
taskStatus enumeration

This table lists the possible values for the taskStatus enumeration, which indicates the current status of the task.

Constant Name Description
ASSIGNED The task is assigned to a user and is awaiting the user's completion.
RETURNED The task was returned to the assigning user because it cannot be completed in its current form.
COMPLETE_PENDING_REVIEW The task was marked as complete by the assigned user and is awaiting review by a review user.
COMPLETE The task was completed.
CANCELLED The task was cancelled and is not awaiting completion.
INVALID The task is invalid because either the associated document, document page, or folder was deleted.
taskType enumeration

This table lists the possible values for the taskType enumeration, which indicates the ImageNow task type.

Constant Name Description
SIGNATURE_REQUIRED ImageNow provides the signature required task type for when a document requires a digital signature.
DOCUMENT_DEFICIENCY ImageNow provides the document deficiency task type for when a document or folder is missing or incomplete.
POINTER ImageNow provides the pointer task type for when there is a need to draw attention to a specific document or folder for further action.
APPROVAL An approval task is a task type that Retention Policy Designer automatically generates for all approvers assigned within a retention policy.

JSON Samples

Sample 1
Request URL
/v2/task/301YW2Q_0004HFZ1900009G
Response
{"id":"301YW2Q_0004HFZ1900009G","templateId":"301YW2P_0004HGZ190000X2","templateName":"Accounting Task Template","type":"DOCUMENT_DEFICIENCY","assignmentDate":1330035331817,"assigningUser":"JohnDoe","startDate":1330035300000,"dueDate":1330063140000,"status":"ASSIGNED","location":"DOCUMENT","completionType":"MANUAL_COMPLETE","deleteCompletedTask":false,"expedite":true,"creationUser":"JohnDoe","creationDate":1330035331817,"modificationUser":"JohnDoe","modificationDate":1330035361033,"completionUser":"JaneDoe","completionDate":1330062170020,"reviewUser":"JohnSmith","reviewDate":1330062180230,"returnReasonListId":"301YVD9_000005LB4000009","actionReasonListId":"301YVD9_000005LB4000004","returnReasonRequired":true,"actionReasonRequired":false,"pageId":"301YVD9_000005LB4000001","assignedUsers":["JaneDoe"],"assignedGroups":[]}

XML Samples

Sample 1
Request URL
/v2/task/301YW2Q_0004HFZ1900009G
Response
<task>
    <id>301YW2Q_0004HFZ1900009G</id>
    <templateId>301YW2P_0004HGZ190000X2</templateId>
    <templateName>Accounting Task Template</templateName>
    <type>DOCUMENT_DEFICIENCY</type>
    <assignmentDate>1330035331817</assignmentDate>
    <assigningUser>JohnDoe</assigningUser>
    <assignedUsers>
        <assignedUser>JaneDoe</assignedUser>
    </assignedUsers>
    <assignedGroups/>
    <startDate>1330035300000</startDate>
    <dueDate>1330063140000</dueDate>
    <status>ASSIGNED</status>
    <location>DOCUMENT</location>
    <completionType>MANUAL_COMPLETE</completionType>
    <deleteCompletedTask>false</deleteCompletedTask>
    <expedite>true</expedite>
    <creationUser>JohnDoe</creationUser>
    <creationDate>1330035331817</creationDate>
    <modificationUser>JohnDoe</modificationUser>
    <modificationDate>1330035361033</modificationDate>
    <completionUser>JaneDoe</completionUser>
    <completionDate>1330062170020</completionDate>
    <reviewUser>JohnSmith</reviewUser>
    <reviewDate>1330062180230</reviewDate>
    <returnReasonListId>301YVD9_000005LB4000009</returnReasonListId>
    <actionReasonListId>301YVD9_000005LB4000004</actionReasonListId>
    <returnReasonRequired>true</returnReasonRequired>
    <actionReasonRequired>false</actionReasonRequired>
    <pageId>301YVD9_000005LB4000001</pageId>
</task>

TaskTemplate (Version 1)

GET/v1/taskTemplate Get all of the task templates available for creating new tasks.

Expand Operation / Collapse Operation

Get all of the task templates available for creating new tasks.

Available from version: 1.0.0

Call Properties

Response
Content
taskTemplatesForCreationList
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

taskTemplatesForCreation type

The metadata elements defined for the taskTemplatesForCreation type.

Field Name Data Type Expected Description
description String Yes The description of the task template.
id String Yes The unique ID of the task template.
name String Yes The name of the task template.
type taskType Yes The type of the task. The taskType enumeration provides the possible values for this data element.
taskTemplatesForCreationList type

A list of task templates available for creating new tasks.

Field Name Data Type Expected Description
taskTemplatesForCreationList List of taskTemplatesForCreation [taskTemplatesForCreation] Yes A list of task templates available for creating new tasks.
taskType enumeration

This table lists the possible values for the taskType enumeration, which indicates the ImageNow task type.

Constant Name Description
SIGNATURE_REQUIRED ImageNow provides the signature required task type for when a document requires a digital signature.
DOCUMENT_DEFICIENCY ImageNow provides the document deficiency task type for when a document or folder is missing or incomplete.
POINTER ImageNow provides the pointer task type for when there is a need to draw attention to a specific document or folder for further action.
APPROVAL An approval task is a task type that Retention Policy Designer automatically generates for all approvers assigned within a retention policy.

JSON Samples

Sample 1
Request URL
/v1/taskTemplate
Response
{"taskTemplatesForCreationList":[{"id":"301YW2Q_0004HFZ1900009G","name":"Task Template One","description":"The first task template","type":"DOCUMENT_DEFICIENCY"},{"id":"301YW2Q_0004HFZ19000073","name":"Task Template Two","description":"The second task template","type":"POINTER"}]}

XML Samples

Sample 1
Request URL
/v1/taskTemplate
Response
<taskTemplatesForCreationList>
    <taskTemplatesForCreationList>
        <taskTemplatesForCreation>
            <id>301YW2Q_0004HFZ1900009G</id>
            <name>Task Template One</name>
            <description>The first task template</description>
            <type>DOCUMENT_DEFICIENCY</type>
        </taskTemplatesForCreation>
        <taskTemplatesForCreation>
            <id>301YW2Q_0004HFZ19000073</id>
            <name>Task Template Two</name>
            <description>The second task template</description>
            <type>POINTER</type>
        </taskTemplatesForCreation>
    </taskTemplatesForCreationList>
</taskTemplatesForCreationList>

GET/v1/taskTemplate/{id} This API call requests detailed information about the task template that matches the given ID.

Expand Operation / Collapse Operation

This API call requests detailed information about the task template that matches the given ID.

Available from version: 1.0.0

Call Properties

Query Parameter
getAllGroupMembers (optional) Determines whether to expand group members into the returned list of candidate users, default is false
Response
Content
taskTemplateForCreation
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
REGULAR The user is user-defined.
SYSTEM The user is system-defined.
POOLED The user is pooled.
AUTO_UPDATE The user is auto_update.
contactInfo type

Contains contact information for the user

Field Name Data Type Expected Description
email String No The email address for the user
fax String No The fax number for the user
location String No The location of the user
mobile String No The mobile number for the user
pager String No The pager number for the user
phone String No The phone number for the user
externalSystemInfo type

Contains external system information for the user

Field Name Data Type Expected Description
externalID String No The external id of the user
org String No The organization of the user
orgUnit String No The organization unit of the user
group type

Represents a group that a user belongs to

Field Name Data Type Expected Description
description String Yes description of the group
id String Yes The group's id
name String Yes name of the group
identityInfo type

Contains personal information for the user

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user
suffix String No The suffix of the user
title String No The title of the user
taskTemplateDueDateOffsetType enumeration

This table lists the possible values for the taskTemplateDueDateOffsetType enumeration.

Constant Name Description
NOT_SET The due date offset type of the task template is not set.
POSITIVE The due date offset type of the task template is positive.
NEGATIVE The due date offset type of the task template is negative.
taskTemplateDueDateType enumeration

This table lists the possible values for the taskTemplateDueDateType enumeration.

Constant Name Description
NOT_SET The due date type of the task template is not set.
MANUALLY_ASSIGNED The due date type of the task template is manually assigned.
OFFSET_ASSIGNMENT_DATE The due date type of the task template is assignment date.
OFFSET_START_DATE The due date type of the task template is start date.
OFFSET_CUSTOM_PROPERTY The due date type of the task template is custom property.
taskTemplateForCreation type

This table describes the elemements of the taskTemplateForCreation type.

Field Name Data Type Expected Description
actionReasonListId String Yes The action reason ID of the task template.
autoAssignToTaskCreator Boolean Yes If true, the task is automatically assigned to the task creator. If false, it is not.
canAttachToDocument Boolean Yes If true, the task can be attached to a document. If false, it cannot be.
canAttachToLogob Boolean Yes If true, the task can be attached to a logical object. If false, it cannot be.
canAttachToPositionInLogob Boolean Yes If true, the task can be attached to a position in a logical object. If false, it cannot be.
canAttachToProject Boolean Yes If true, the task can be attached to a project. If false, it cannot be.
candidateGroups List of group [candidateGroup] Yes The list of candidate groups.
candidateUsers List of user [candidateUser] Yes The list of candidate users.
completionReasonRequired Boolean Yes If true, a completion reason is required for the task template. If false, it is not.
description String Yes The description of the task template.
dueDateCustomPropertyId String Yes The due date custom property ID of the task template.
dueDateOffset Long Yes The due date offset of the task template.
dueDateOffsetType taskTemplateDueDateOffsetType Yes The type of due date offset for the task template. The dueDateOffsetType enumeration provides the possible values for this data element.
dueDateType taskTemplateDueDateType Yes The type of due date for the task template. The dueDateType enumeration provides the possible values for this data element.
id String Yes The unique ID of the task template.
instructions String Yes The instructions for of the task template.
instructionsEditable Boolean Yes If true, the instructions are editable. If false, they are not.
name String Yes The name of the task template.
promptForWorkflowQueueId Boolean Yes If true, the user should be prompted for workflow queue ID. If false, they should not be.
returnReasonListId String Yes The return reason ID of the task template.
returnReasonRequired Boolean Yes If true, a return reason is required for the task template. If false, it is not.
sendProjectToWorkflow Boolean Yes If true, the project should be sent to workflow. If false, it should not be.
type taskType Yes The type of the task template. The taskType enumeration provides the possible values for this data element.
workflowQueueId String Yes The workflow queue ID of the task template.
taskType enumeration

This table lists the possible values for the taskType enumeration, which indicates the ImageNow task type.

Constant Name Description
SIGNATURE_REQUIRED ImageNow provides the signature required task type for when a document requires a digital signature.
DOCUMENT_DEFICIENCY ImageNow provides the document deficiency task type for when a document or folder is missing or incomplete.
POINTER ImageNow provides the pointer task type for when there is a need to draw attention to a specific document or folder for further action.
APPROVAL An approval task is a task type that Retention Policy Designer automatically generates for all approvers assigned within a retention policy.
user type

user to be returned

Field Name Data Type Expected Description
category category Yes The category of the user
contactInfo contactInfo No Contains contact information for the user
externalSystemInfo externalSystemInfo No Contains external system information for the user
id String Yes The id of the user
identityInfo identityInfo No Contains personal information for the user
isActive boolean Yes Flag representing if the user is active
name String Yes The name of the user

JSON Samples

Sample 1 - Request without the getAllGroupMembers parameter (groups members not included)
Request URL
/v1/taskTemplate/301YW2Q_0004HFZ1900009G
Response
{"id":"301YW2P_0004HGZ660000ZZ","name":"User defined task template","description":"Description for user defined task template","type":"DOCUMENT_DEFICIENCY","instructions":"Instructions for user defined group","instructionsEditable":true,"dueDateType":"OFFSET_ASSIGNMENT_DATE","dueDateOffset":1553712040000,"dueDateOffsetType":"POSITIVE","dueDateCustomPropertyId":"301YW2P_0004HGZ550000ZZ","canAttachToProject":true,"canAttachToDocument":true,"canAttachToLogob":true,"canAttachToPositionInLogob":true,"sendProjectToWorkflow":true,"promptForWorkflowQueueId":false,"workflowQueueId":"301YW2P_0004HGZ440000ZZ","returnReasonRequired":true,"completionReasonRequired":true,"returnReasonListId":"301YW2P_0004HGZ330000ZZ","actionReasonListId":"301YW2P_0004HGZ220000ZZ","autoAssignToTaskCreator":true,"candidateGroups":[{"id":"301YW2P_0004HGZ880000ZZ","name":"User defined group","description":"Description for user defined group"}],"candidateUsers":[{"id":"301YW2P_0004HGZ770000ZZ","name":"John Doe","category":"REGULAR","isActive":true,"identityInfo":{"firstName":"John","lastName":"Doe","prefix":"Mr.","suffix":"Jr.","title":"Engineer"},"contactInfo":{"phone":"555-555-1234","mobile":"555-555-4321","pager":"555-555-6789","fax":"555-555-9876","email":"user@domain.com","location":"Shawnee, KS 66221, USA"},"externalSystemInfo":{"org":"Research and Development","orgUnit":"Developers","externalID":"15132"}}]}
Sample 2 - Request with the getAllGroupMembers parameter (groups members included)
Request URL
/v1/taskTemplate/301YW2Q_0004HFZ1900009G?getAllGroupMembers=true
Response
{"id":"301YW2P_0004HGZ660000ZZ","name":"User defined task template","description":"Description for user defined task template","type":"DOCUMENT_DEFICIENCY","instructions":"Instructions for user defined group","instructionsEditable":true,"dueDateType":"OFFSET_ASSIGNMENT_DATE","dueDateOffset":1553712040000,"dueDateOffsetType":"POSITIVE","dueDateCustomPropertyId":"301YW2P_0004HGZ550000ZZ","canAttachToProject":true,"canAttachToDocument":true,"canAttachToLogob":true,"canAttachToPositionInLogob":true,"sendProjectToWorkflow":true,"promptForWorkflowQueueId":false,"workflowQueueId":"301YW2P_0004HGZ440000ZZ","returnReasonRequired":true,"completionReasonRequired":true,"returnReasonListId":"301YW2P_0004HGZ330000ZZ","actionReasonListId":"301YW2P_0004HGZ220000ZZ","autoAssignToTaskCreator":null,"candidateGroups":[{"id":"301YW2P_0004HGZ880000ZZ","name":"User defined group","description":"Description for user defined group"}],"candidateUsers":[{"id":"301YW2P_0004HGZ770000ZZ","name":"John Doe","category":"REGULAR","isActive":true,"identityInfo":{"firstName":"John","lastName":"Doe","prefix":"Mr.","suffix":"Jr.","title":"Engineer"},"contactInfo":{"phone":"555-555-1234","mobile":"555-555-4321","pager":"555-555-6789","fax":"555-555-9876","email":"user@domain.com","location":"Shawnee, KS 66221, USA"},"externalSystemInfo":{"org":"Research and Development","orgUnit":"Developers","externalID":"15132"}},{"id":"301YW2P_0004HGZ770000QQ","name":"John Smith","category":"REGULAR","isActive":true,"identityInfo":{"firstName":"John","lastName":"Smith","prefix":"Dr.","suffix":"D.D","title":"Doctor"},"contactInfo":{"phone":"555-555-1234","mobile":"555-555-4321","pager":"555-555-6789","fax":"555-555-9876","email":"user@domain.com","location":"Shawnee, KS 66221, USA"},"externalSystemInfo":{"org":"Research and Development","orgUnit":"Developers","externalID":"15132"}}]}

XML Samples

Sample 1 - Request without the getAllGroupMembers parameter (groups members not included)
Request URL
/v1/taskTemplate/301YW2Q_0004HFZ1900009G
Response
<taskTemplateForCreation>
    <id>301YW2P_0004HGZ660000ZZ</id>
    <name>User defined task template</name>
    <description>Description for user defined task template</description>
    <type>DOCUMENT_DEFICIENCY</type>
    <instructions>Instructions for user defined group</instructions>
    <instructionsEditable>true</instructionsEditable>
    <dueDateType>OFFSET_ASSIGNMENT_DATE</dueDateType>
    <dueDateOffset>1553712040000</dueDateOffset>
    <dueDateOffsetType>POSITIVE</dueDateOffsetType>
    <dueDateCustomPropertyId>301YW2P_0004HGZ550000ZZ</dueDateCustomPropertyId>
    <canAttachToProject>true</canAttachToProject>
    <canAttachToDocument>true</canAttachToDocument>
    <canAttachToLogob>true</canAttachToLogob>
    <canAttachToPositionInLogob>true</canAttachToPositionInLogob>
    <sendProjectToWorkflow>true</sendProjectToWorkflow>
    <promptForWorkflowQueueId>false</promptForWorkflowQueueId>
    <workflowQueueId>301YW2P_0004HGZ440000ZZ</workflowQueueId>
    <returnReasonRequired>true</returnReasonRequired>
    <completionReasonRequired>true</completionReasonRequired>
    <returnReasonListId>301YW2P_0004HGZ330000ZZ</returnReasonListId>
    <actionReasonListId>301YW2P_0004HGZ220000ZZ</actionReasonListId>
    <autoAssignToTaskCreator>true</autoAssignToTaskCreator>
    <candidateGroups>
        <candidateGroup>
            <id>301YW2P_0004HGZ880000ZZ</id>
            <name>User defined group</name>
            <description>Description for user defined group</description>
        </candidateGroup>
    </candidateGroups>
    <candidateUsers>
        <candidateUser>
            <id>301YW2P_0004HGZ770000ZZ</id>
            <name>John Doe</name>
            <category>REGULAR</category>
            <isActive>true</isActive>
            <identityInfo>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <prefix>Mr.</prefix>
                <suffix>Jr.</suffix>
                <title>Engineer</title>
            </identityInfo>
            <contactInfo>
                <phone>555-555-1234</phone>
                <mobile>555-555-4321</mobile>
                <pager>555-555-6789</pager>
                <fax>555-555-9876</fax>
                <email>user@domain.com</email>
                <location>Shawnee, KS 66221, USA</location>
            </contactInfo>
            <externalSystemInfo>
                <org>Research and Development</org>
                <orgUnit>Developers</orgUnit>
                <externalID>15132</externalID>
            </externalSystemInfo>
        </candidateUser>
    </candidateUsers>
</taskTemplateForCreation>
Sample 2 - Request with the getAllGroupMembers parameter (groups members included)
Request URL
/v1/taskTemplate/301YW2Q_0004HFZ1900009G?getAllGroupMembers=true
Response
<taskTemplateForCreation>
    <id>301YW2P_0004HGZ660000ZZ</id>
    <name>User defined task template</name>
    <description>Description for user defined task template</description>
    <type>DOCUMENT_DEFICIENCY</type>
    <instructions>Instructions for user defined group</instructions>
    <instructionsEditable>true</instructionsEditable>
    <dueDateType>OFFSET_ASSIGNMENT_DATE</dueDateType>
    <dueDateOffset>1553712040000</dueDateOffset>
    <dueDateOffsetType>POSITIVE</dueDateOffsetType>
    <dueDateCustomPropertyId>301YW2P_0004HGZ550000ZZ</dueDateCustomPropertyId>
    <canAttachToProject>true</canAttachToProject>
    <canAttachToDocument>true</canAttachToDocument>
    <canAttachToLogob>true</canAttachToLogob>
    <canAttachToPositionInLogob>true</canAttachToPositionInLogob>
    <sendProjectToWorkflow>true</sendProjectToWorkflow>
    <promptForWorkflowQueueId>false</promptForWorkflowQueueId>
    <workflowQueueId>301YW2P_0004HGZ440000ZZ</workflowQueueId>
    <returnReasonRequired>true</returnReasonRequired>
    <completionReasonRequired>true</completionReasonRequired>
    <returnReasonListId>301YW2P_0004HGZ330000ZZ</returnReasonListId>
    <actionReasonListId>301YW2P_0004HGZ220000ZZ</actionReasonListId>
    <candidateGroups>
        <candidateGroup>
            <id>301YW2P_0004HGZ880000ZZ</id>
            <name>User defined group</name>
            <description>Description for user defined group</description>
        </candidateGroup>
    </candidateGroups>
    <candidateUsers>
        <candidateUser>
            <id>301YW2P_0004HGZ770000ZZ</id>
            <name>John Doe</name>
            <category>REGULAR</category>
            <isActive>true</isActive>
            <identityInfo>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <prefix>Mr.</prefix>
                <suffix>Jr.</suffix>
                <title>Engineer</title>
            </identityInfo>
            <contactInfo>
                <phone>555-555-1234</phone>
                <mobile>555-555-4321</mobile>
                <pager>555-555-6789</pager>
                <fax>555-555-9876</fax>
                <email>user@domain.com</email>
                <location>Shawnee, KS 66221, USA</location>
            </contactInfo>
            <externalSystemInfo>
                <org>Research and Development</org>
                <orgUnit>Developers</orgUnit>
                <externalID>15132</externalID>
            </externalSystemInfo>
        </candidateUser>
        <candidateUser>
            <id>301YW2P_0004HGZ770000QQ</id>
            <name>John Smith</name>
            <category>REGULAR</category>
            <isActive>true</isActive>
            <identityInfo>
                <firstName>John</firstName>
                <lastName>Smith</lastName>
                <prefix>Dr.</prefix>
                <suffix>D.D</suffix>
                <title>Doctor</title>
            </identityInfo>
            <contactInfo>
                <phone>555-555-1234</phone>
                <mobile>555-555-4321</mobile>
                <pager>555-555-6789</pager>
                <fax>555-555-9876</fax>
                <email>user@domain.com</email>
                <location>Shawnee, KS 66221, USA</location>
            </contactInfo>
            <externalSystemInfo>
                <org>Research and Development</org>
                <orgUnit>Developers</orgUnit>
                <externalID>15132</externalID>
            </externalSystemInfo>
        </candidateUser>
    </candidateUsers>
</taskTemplateForCreation>

UniqueId (Version 1)

GET/v1/uniqueId Returns a set of server generated unique IDs.

Expand Operation / Collapse Operation

Returns a set of server generated unique IDs.

Available from version: 1.0.0

Call Properties

Query Parameter
quantity (optional) Number of unique IDs to return, defaults to 1.
Response
Content
List of String [uniqueId]
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/uniqueId?quantity=2
Response
{"uniqueIds":["321YZ8B_0009KJMZH000MSX","321YZ8B_0009KJMZH000MSY"]}

XML Samples

Sample 1
Request URL
/v1/uniqueId?quantity=2
Response
<uniqueIds>
    <uniqueId>321YZ8B_0009KJMZH000MSX</uniqueId>
    <uniqueId>321YZ8B_0009KJMZH000MSY</uniqueId>
</uniqueIds>

User (Version 1)

GET/v1/user Gets a list of all users.

Expand Operation / Collapse Operation

Gets a list of all users.

Available from version: 1.0.0

Call Properties

Response
Content
List of user [user]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

user type

The list of users

Field Name Data Type Expected Description
userName String Yes

JSON Samples

Sample 1
Request URL
/v1/user
Response
{"users":[{"userName":"ImageNowUser1"},{"userName":"ImageNowUser2"},{"userName":"ImageNowUser3"}]}

XML Samples

Sample 1
Request URL
/v1/user
Response
<users>
    <user>
        <userName>ImageNowUser1</userName>
    </user>
    <user>
        <userName>ImageNowUser2</userName>
    </user>
    <user>
        <userName>ImageNowUser3</userName>
    </user>
</users>

POST/v1/user Creates a user.

Expand Operation / Collapse Operation

Creates a user.

Available from version: 1.0.0

Call Properties

Request
Content user
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the newly created user.

Call Types and Enumerations

contactInfo type

Contains contact information for the user

Field Name Data Type Expected Description
email String No The email address for the user
fax String No The fax number for the user
location String No The location of the user
mobile String No The mobile number for the user
pager String No The pager number for the user
phone String No The phone number for the user
externalSystemInfo type

Contains external system information for the user

Field Name Data Type Expected Description
externalID String No The external id of the user
org String No The organization of the user
orgUnit String No The organization unit of the user
identityInfo type

Contains personal information for the user

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user
suffix String No The suffix of the user
title String No The title of the user
user type

user to be created

Field Name Data Type Expected Description
contactInfo contactInfo No Contains contact information for the user
externalSystemInfo externalSystemInfo No Contains external system information for the user
identityInfo identityInfo No Contains personal information for the user
isActive boolean No Flag representing if the user is active
name String Yes The name of the user

JSON Samples

Sample 1
Request URL
/v1/user
Request
{"name":"jdoe","isActive":true,"identityInfo":{"firstName":"John","lastName":"Doe","prefix":"Mr.","suffix":"Jr.","title":"Engineer"},"contactInfo":{"phone":"555-555-1234","mobile":"555-555-4321","pager":"555-555-6789","fax":"555-555-9876","email":"john.doe@someplace.net","location":null},"externalSystemInfo":{"org":"Research and Development","orgUnit":"Developers","externalID":"15132"}}

XML Samples

Sample 1
Request URL
/v1/user
Request
<user>
    <name>jdoe</name>
    <isActive>true</isActive>
    <identityInfo>
        <firstName>John</firstName>
        <lastName>Doe</lastName>
        <prefix>Mr.</prefix>
        <suffix>Jr.</suffix>
        <title>Engineer</title>
    </identityInfo>
    <contactInfo>
        <phone>555-555-1234</phone>
        <mobile>555-555-4321</mobile>
        <pager>555-555-6789</pager>
        <fax>555-555-9876</fax>
        <email>john.doe@someplace.net</email>
    </contactInfo>
    <externalSystemInfo>
        <org>Research and Development</org>
        <orgUnit>Developers</orgUnit>
        <externalID>15132</externalID>
    </externalSystemInfo>
</user>

GET/v1/user/group Gets the list of groups a user belongs to.

Expand Operation / Collapse Operation

Gets the list of groups a user belongs to.

Available from version: 1.0.0

Call Properties

Query Parameter
userName Filter groups by user name
Response
Content
List of group [group]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
SYSTEM The group is system-defined.
USER_DEFINED The group is user-defined.
group type

Represents a group that a user belongs to

Field Name Data Type Expected Description
category category Yes category type of the group
departmentId String Yes The department id the group belongs to
description String Yes description of the group
id String Yes The group's id
isGloballyVisible boolean Yes Whether the group displays in a cross department context
name String Yes name of the group

JSON Samples

Sample 1
Request URL
/v1/user/group?userName=johndoe
Response
{"groups":[{"id":"301YVDM_0008XTGFH000001","category":"USER_DEFINED","name":"Accounting","isGloballyVisible":true,"description":"Accounting Users","departmentId":"321YY3M_0000Y2SWR00000W"}]}

XML Samples

Sample 1
Request URL
/v1/user/group?userName=johndoe
Response
<groups>
    <group>
        <id>301YVDM_0008XTGFH000001</id>
        <category>USER_DEFINED</category>
        <name>Accounting</name>
        <isGloballyVisible>true</isGloballyVisible>
        <description>Accounting Users</description>
        <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    </group>
</groups>

DELETE/v1/user/{id} Deletes an existing user

Expand Operation / Collapse Operation

Deletes an existing user

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ

XML Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ

GET/v1/user/{id} Gets an existing user.

Expand Operation / Collapse Operation

Gets an existing user.

Available from version: 1.0.0

Call Properties

Response
Content
user
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
REGULAR The user is user-defined.
SYSTEM The user is system-defined.
POOLED The user is pooled.
AUTO_UPDATE The user is auto_update.
identityInfo type

Contains personal information for the user

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user
suffix String No The suffix of the user
title String No The title of the user
user type

user to be returned

Field Name Data Type Expected Description
category category Yes The category of the user
id String Yes The id of the user
identityInfo identityInfo No Contains personal information for the user
isActive boolean Yes Flag representing if the user is active
name String Yes The name of the user

JSON Samples

Sample 1
Request URL
/v1/user/321YX48_0000XMJE2000004
Response
{"id":"321YX48_0000XMJE2000004","name":"jdoe","category":"REGULAR","isActive":true,"identityInfo":{"firstName":"John","lastName":"Doe","prefix":"Mr.","suffix":"Jr.","title":"Engineer"}}

XML Samples

Sample 1
Request URL
/v1/user/321YX48_0000XMJE2000004
Response
<user>
    <id>321YX48_0000XMJE2000004</id>
    <name>jdoe</name>
    <category>REGULAR</category>
    <isActive>true</isActive>
    <identityInfo>
        <firstName>John</firstName>
        <lastName>Doe</lastName>
        <prefix>Mr.</prefix>
        <suffix>Jr.</suffix>
        <title>Engineer</title>
    </identityInfo>
</user>

PUT/v1/user/{id}/account Updates an existing user with new account information

Expand Operation / Collapse Operation

Updates an existing user with new account information

Available from version: 1.0.0

Call Properties

Request
Content user
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

user type

Updated account information for the user.

Field Name Data Type Expected Description
isActive boolean No The active status for the user
name String Yes The user name for the user

JSON Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ/account
Request
{"name":"jsmith","isActive":false}

XML Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ/account
Request
<user>
    <name>jsmith</name>
    <isActive>false</isActive>
</user>

GET/v1/user/{id}/extendedInfo Gets an existing user.

Expand Operation / Collapse Operation

Gets an existing user.

Available from version: 1.0.0

Call Properties

Response
Content
user
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
REGULAR The user is user-defined.
SYSTEM The user is system-defined.
POOLED The user is pooled.
AUTO_UPDATE The user is auto_update.
contactInfo type

Contains contact information for the user

Field Name Data Type Expected Description
email String No The email address for the user
fax String No The fax number for the user
location String No The location of the user
mobile String No The mobile number for the user
pager String No The pager number for the user
phone String No The phone number for the user
externalSystemInfo type

Contains external system information for the user

Field Name Data Type Expected Description
externalID String No The external id of the user
org String No The organization of the user
orgUnit String No The organization unit of the user
identityInfo type

Contains personal information for the user

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user
suffix String No The suffix of the user
title String No The title of the user
user type

user to be returned

Field Name Data Type Expected Description
category category Yes The category of the user
contactInfo contactInfo No Contains contact information for the user
externalSystemInfo externalSystemInfo No Contains external system information for the user
id String Yes The id of the user
identityInfo identityInfo No Contains personal information for the user
isActive boolean Yes Flag representing if the user is active
name String Yes The name of the user

JSON Samples

Sample 1
Request URL
/v1/user/321YX48_0000XMJE2000004/extendedInfo
Response
{"id":"321YX48_0000XMJE2000004","name":"jdoe","category":"REGULAR","isActive":true,"identityInfo":{"firstName":"John","lastName":"Doe","prefix":"Mr.","suffix":"Jr.","title":"Engineer"},"contactInfo":{"phone":"555-555-1234","mobile":"555-555-4321","pager":"555-555-6789","fax":"555-555-9876","email":"john.doe@someplace.net","location":"Shawnee, KS 66221, USA"},"externalSystemInfo":{"org":"Research and Development","orgUnit":"Developers","externalID":"15132"}}

XML Samples

Sample 1
Request URL
/v1/user/321YX48_0000XMJE2000004/extendedInfo
Response
<user>
    <id>321YX48_0000XMJE2000004</id>
    <name>jdoe</name>
    <category>REGULAR</category>
    <isActive>true</isActive>
    <identityInfo>
        <firstName>John</firstName>
        <lastName>Doe</lastName>
        <prefix>Mr.</prefix>
        <suffix>Jr.</suffix>
        <title>Engineer</title>
    </identityInfo>
    <contactInfo>
        <phone>555-555-1234</phone>
        <mobile>555-555-4321</mobile>
        <pager>555-555-6789</pager>
        <fax>555-555-9876</fax>
        <email>john.doe@someplace.net</email>
        <location>Shawnee, KS 66221, USA</location>
    </contactInfo>
    <externalSystemInfo>
        <org>Research and Development</org>
        <orgUnit>Developers</orgUnit>
        <externalID>15132</externalID>
    </externalSystemInfo>
</user>

GET/v1/user/{id}/group Gets the list of groups a user belongs to.

Expand Operation / Collapse Operation

Gets the list of groups a user belongs to.

Available from version: 1.0.0

Call Properties

Response
Content
List of group [group]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
SYSTEM The group is system-defined.
USER_DEFINED The group is user-defined.
group type

Represents a group that a user belongs to

Field Name Data Type Expected Description
category category Yes category type of the group
departmentId String Yes The department id the group belongs to
description String Yes description of the group
id String Yes The group's id
isGloballyVisible boolean Yes Whether the group displays in a cross department context
name String Yes name of the group

JSON Samples

Sample 1
Request URL
/v1/user/321YX48_0000S12HX00001S/group
Response
{"groups":[{"id":"301YVDM_0008XTGFH000001","category":"USER_DEFINED","name":"Accounting","isGloballyVisible":true,"description":"Accounting Users","departmentId":"321YY3M_0000Y2SWR00000W"}]}

XML Samples

Sample 1
Request URL
/v1/user/321YX48_0000S12HX00001S/group
Response
<groups>
    <group>
        <id>301YVDM_0008XTGFH000001</id>
        <category>USER_DEFINED</category>
        <name>Accounting</name>
        <isGloballyVisible>true</isGloballyVisible>
        <description>Accounting Users</description>
        <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    </group>
</groups>

PUT/v1/user/{id}/group Updates an existing user with group membership

Expand Operation / Collapse Operation

Updates an existing user with group membership

Available from version: 1.0.0

Call Properties

Request
Content user
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

group type

A group for the user to be added to or removed from

Field Name Data Type Expected Description
id String Yes The id of the group
membership type

Groups to add current user to or removed from

Field Name Data Type Expected Description
groupsToAdd List of group [group] Yes The groups to add the user to
groupsToRemove List of group [group] Yes The groups to remove the user from
user type

Update user with group membership

Field Name Data Type Expected Description
membership membership Yes The group membership to be updated for a user

JSON Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ/group
Request
{"membership":{"groupsToAdd":[{"id":"321YX7J_0000V7YHZ000GSJ"}],"groupsToRemove":[{"id":"321YX7J_0000V7YHZ00RGSJ"}]}}

XML Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ/group
Request
<user>
    <membership>
        <groupsToAdd>
            <group>
                <id>321YX7J_0000V7YHZ000GSJ</id>
            </group>
        </groupsToAdd>
        <groupsToRemove>
            <group>
                <id>321YX7J_0000V7YHZ00RGSJ</id>
            </group>
        </groupsToRemove>
    </membership>
</user>

GET/v1/user/{id}/privilege Gets the privileges for a user

Expand Operation / Collapse Operation

Gets the privileges for a user

Available from version: 1.0.0

Call Properties

Query Parameters
global (optional) Include global privileges
documentTypeId (optional) Include privileges for the provided document type ids
drawerId (optional) Include privileges for the provided drawer ids
folderTypeId (optional) Include privileges for the provided folder type ids
Response
Content
List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges are returned, if applicable
inheritedPrivileges List of privilege [privilege] Yes The inherited privileges
privileges List of privilege [privilege] Yes The direct privileges
type type Yes The type of privileges returned
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE Document type
FOLDER_TYPE Folder type
DRAWER Drawer
GLOBAL Global
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v1/user/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&documentTypeId=301YVDM_0008XTGFH00004H
Response
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}],"inheritedPrivileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"UNSET"},{"name":"SEARCH_CONTENT","value":"UNSET"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}],"inheritedPrivileges":[{"name":"CONTENT_DELETE","value":"UNSET"},{"name":"CUSTOM_PROP_MODIFY","value":"UNSET"}]},{"id":"301YVDM_0008XTGFH00004H","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"DENIED"},{"name":"CUSTOM_PROP_MODIFY","value":"UNSET"}],"inheritedPrivileges":[{"name":"CONTENT_DELETE","value":"UNSET"},{"name":"CUSTOM_PROP_MODIFY","value":"UNSET"}]}]}

XML Samples

Sample 1
Request URL
/v1/user/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&documentTypeId=301YVDM_0008XTGFH00004H
Response
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
        <inheritedPrivileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>UNSET</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>UNSET</value>
            </privilege>
        </inheritedPrivileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
        <inheritedPrivileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>UNSET</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>UNSET</value>
            </privilege>
        </inheritedPrivileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004H</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>UNSET</value>
            </privilege>
        </privileges>
        <inheritedPrivileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>UNSET</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>UNSET</value>
            </privilege>
        </inheritedPrivileges>
    </privilegeSet>
</privilegeSets>

PUT/v1/user/{id}/privilege Sets the privileges for a user

Expand Operation / Collapse Operation

Sets the privileges for a user

Available from version: 1.0.0

Call Properties

Request
Content List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
List of failedPrivilegeSet [failedPrivilegeSet] (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

failedPrivilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges failed to be applied, if applicable
message String Yes The error message for why the privilege set failed to be applied
type type Yes The type of privilege set that failed to be applied
privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges are applied, if applicable
privileges List of privilege [privilege] Yes The privileges to apply
type type Yes The type of privileges applied
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE Document type
FOLDER_TYPE Folder type
DRAWER Drawer
GLOBAL Global
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v1/user/301YVDM_0008XTGFH000003/privilege
Request
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004H","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"DENIED"},{"name":"CUSTOM_PROP_MODIFY","value":"UNSET"}]}]}

XML Samples

Sample 1
Request URL
/v1/user/301YVDM_0008XTGFH000003/privilege
Request
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004H</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>UNSET</value>
            </privilege>
        </privileges>
    </privilegeSet>
</privilegeSets>

PUT/v1/user/{id}/profile Updates an existing user's profile

Expand Operation / Collapse Operation

Updates an existing user's profile

Available from version: 1.0.0

Call Properties

Request
Content user
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

contactInfo type

Contains contact information for the user

Field Name Data Type Expected Description
email String No The email address for the user
fax String No The fax number for the user
location String No The location of the user
mobile String No The mobile number for the user
pager String No The pager number for the user
phone String No The phone number for the user
externalSystemInfo type

Contains external system information for the user

Field Name Data Type Expected Description
externalID String No The external id of the user
org String No The organization of the user
orgUnit String No The organization unit of the user
identityInfo type

Contains personal information for the user

Field Name Data Type Expected Description
firstName String No The first name of the user
lastName String No The last name of the user
prefix String No The prefix of the user
suffix String No The suffix of the user
title String No The title of the user
user type

Updated profile information for the user.

Field Name Data Type Expected Description
contactInfo contactInfo No Contains contact information for the user
externalSystemInfo externalSystemInfo No Contains external system information for the user
identityInfo identityInfo No Contains personal information for the user

JSON Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ/profile
Request
{"identityInfo":{"firstName":"John","lastName":"Doe","prefix":"Mr.","suffix":"Jr.","title":"Engineer"},"contactInfo":{"phone":"555-555-1234","mobile":"555-555-4321","pager":"555-555-6789","fax":"555-555-9876","email":"john.doe@someplace.net","location":"US"},"externalSystemInfo":{"org":"Research and Development","orgUnit":"Developers","externalID":"15132"}}

XML Samples

Sample 1
Request URL
/v1/user/321YX7J_0000V7YHZ0000SJ/profile
Request
<user>
    <identityInfo>
        <firstName>John</firstName>
        <lastName>Doe</lastName>
        <prefix>Mr.</prefix>
        <suffix>Jr.</suffix>
        <title>Engineer</title>
    </identityInfo>
    <contactInfo>
        <phone>555-555-1234</phone>
        <mobile>555-555-4321</mobile>
        <pager>555-555-6789</pager>
        <fax>555-555-9876</fax>
        <email>john.doe@someplace.net</email>
        <location>US</location>
    </contactInfo>
    <externalSystemInfo>
        <org>Research and Development</org>
        <orgUnit>Developers</orgUnit>
        <externalID>15132</externalID>
    </externalSystemInfo>
</user>

User (Version 2)

GET/v2/user Gets a list of all users.

Expand Operation / Collapse Operation

Gets a list of all users.

Available from version: 1.0.0

Call Properties

Response
Content
List of user [user]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

user type

The list of users

Field Name Data Type Expected Description
id String Yes id of the user
name String Yes name of the user

JSON Samples

Sample 1
Request URL
/v2/user
Response
{"users":[{"id":"301YVDM_0008XTGFH000001","name":"ImageNowUser1"},{"id":"301YVDM_0008XTGFH000002","name":"ImageNowUser2"}]}

XML Samples

Sample 1
Request URL
/v2/user
Response
<users>
    <user>
        <id>301YVDM_0008XTGFH000001</id>
        <name>ImageNowUser1</name>
    </user>
    <user>
        <id>301YVDM_0008XTGFH000002</id>
        <name>ImageNowUser2</name>
    </user>
</users>

GET/v2/user/{id}/privilege Gets the privileges for a user

Expand Operation / Collapse Operation

Gets the privileges for a user

Available from version: 1.0.0

Call Properties

Query Parameters
global (optional) Include global privileges
documentTypeId (optional) Include privileges for the provided document type ids
drawerId (optional) Include privileges for the provided drawer ids
folderTypeId (optional) Include privileges for the provided folder type ids
departmentId (optional) Include privileges for the provided department ids
Response
Content
List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges are returned, if applicable
inheritedPrivileges List of privilege [privilege] Yes The inherited privileges
privileges List of privilege [privilege] Yes The direct privileges
type type Yes The type of privileges returned
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE The document type privileges for a given user group and document type.
FOLDER_TYPE The folder type privileges for a given user group and folder type.
DRAWER The drawer privileges for a given user group and drawer.
GLOBAL The global privileges for a user group.
DEPARTMENT The department privileges for a given user group and department.
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v2/user/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&departmentId=301YVDM_0008XTGFH00004L
Response
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}],"inheritedPrivileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"UNSET"},{"name":"SEARCH_CONTENT","value":"UNSET"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}],"inheritedPrivileges":[{"name":"CONTENT_DELETE","value":"UNSET"},{"name":"CUSTOM_PROP_MODIFY","value":"UNSET"}]},{"id":"301YVDM_0008XTGFH00004L","type":"DEPARTMENT","privileges":[{"name":"WORKER_FLOW_MANAGER","value":"DENIED"},{"name":"MANAGE_GROUPS","value":"UNSET"}],"inheritedPrivileges":[{"name":"MANAGE_FOLDER_TYPES","value":"UNSET"},{"name":"MANAGE_DEVICES","value":"UNSET"}]}]}

XML Samples

Sample 1
Request URL
/v2/user/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&departmentId=301YVDM_0008XTGFH00004L
Response
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
        <inheritedPrivileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>UNSET</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>UNSET</value>
            </privilege>
        </inheritedPrivileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
        <inheritedPrivileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>UNSET</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>UNSET</value>
            </privilege>
        </inheritedPrivileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004L</id>
        <type>DEPARTMENT</type>
        <privileges>
            <privilege>
                <name>WORKER_FLOW_MANAGER</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>MANAGE_GROUPS</name>
                <value>UNSET</value>
            </privilege>
        </privileges>
        <inheritedPrivileges>
            <privilege>
                <name>MANAGE_FOLDER_TYPES</name>
                <value>UNSET</value>
            </privilege>
            <privilege>
                <name>MANAGE_DEVICES</name>
                <value>UNSET</value>
            </privilege>
        </inheritedPrivileges>
    </privilegeSet>
</privilegeSets>

PUT/v2/user/{id}/privilege Sets the privileges for a user

Expand Operation / Collapse Operation

Sets the privileges for a user

Available from version: 1.0.0

Call Properties

Request
Content List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
List of failedPrivilegeSet [failedPrivilegeSet] (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

failedPrivilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges failed to be applied, if applicable
message String Yes The error message for why the privilege set failed to be applied
type type Yes The type of privilege set that failed to be applied
privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The ID of the privilege set. When the type is GLOBAL, the ID value will be NULL.
privileges List of privilege [privilege] Yes The name and value of each privilege in the privilege set.
type type Yes The type of the privilege set.
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE The document type privileges for a given user group and document type.
FOLDER_TYPE The folder type privileges for a given user group and folder type.
DRAWER The drawer privileges for a given user group and drawer.
GLOBAL The global privileges for a user group.
DEPARTMENT The department privileges for a given user group and department.
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v2/user/301YVDM_0008XTGFH000003/privilege
Request
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004L","type":"DEPARTMENT","privileges":[{"name":"WORKER_FLOW_MANAGER","value":"DENIED"},{"name":"MANAGE_GROUPS","value":"UNSET"}]}]}

XML Samples

Sample 1
Request URL
/v2/user/301YVDM_0008XTGFH000003/privilege
Request
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004L</id>
        <type>DEPARTMENT</type>
        <privileges>
            <privilege>
                <name>WORKER_FLOW_MANAGER</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>MANAGE_GROUPS</name>
                <value>UNSET</value>
            </privilege>
        </privileges>
    </privilegeSet>
</privilegeSets>

UserGroup (Version 1)

GET/v1/userGroup Retrieves all existing userGroups in the department and groups shared with that department

Expand Operation / Collapse Operation

Retrieves all existing userGroups in the department and groups shared with that department

Available from version: 1.0.0

Call Properties

Query Parameter
departmentId Department id to retrieve groups for
Response
Content
List of group [userGroup]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
SYSTEM The group is system-defined.
USER_DEFINED The group is user-defined.
group type

Represents a group that a user belongs to

Field Name Data Type Expected Description
category category Yes category type of the group
departmentId String Yes The department id the group belongs to
description String Yes description of the group
id String Yes The group's id
isGloballyVisible boolean Yes Whether the group displays in a cross department context
name String Yes name of the group

JSON Samples

Sample 1
Request URL
/v1/userGroup?departmentId=321YY3M_0000Y2SWR00000W
Response
{"userGroups":[{"id":"301YVDM_0008XTGFH000003","category":"USER_DEFINED","name":"HR","isGloballyVisible":true,"description":"HR users","departmentId":"321YY3M_0000Y2SWR00000W"},{"id":"321YY3L_0000DKLML000008","category":"USER_DEFINED","name":"AP","isGloballyVisible":false,"description":"AP Users","departmentId":"321YY3M_0000Y2SWR00000W"}]}

XML Samples

Sample 1
Request URL
/v1/userGroup?departmentId=321YY3M_0000Y2SWR00000W
Response
<userGroups>
    <userGroup>
        <id>301YVDM_0008XTGFH000003</id>
        <category>USER_DEFINED</category>
        <name>HR</name>
        <isGloballyVisible>true</isGloballyVisible>
        <description>HR users</description>
        <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    </userGroup>
    <userGroup>
        <id>321YY3L_0000DKLML000008</id>
        <category>USER_DEFINED</category>
        <name>AP</name>
        <isGloballyVisible>false</isGloballyVisible>
        <description>AP Users</description>
        <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    </userGroup>
</userGroups>

POST/v1/userGroup Creates a new user group

Expand Operation / Collapse Operation

Creates a new user group

Available from version: 1.0.0

Call Properties

Request
Content userGroup
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the newly created group.

Call Types and Enumerations

user type

A user to be added to a user group

Field Name Data Type Expected Description
id String Yes The id of the user
userGroup type

user group to be created

Field Name Data Type Expected Description
departmentId String Yes The department id the group belongs to
description String Yes The description of the group
isGloballyVisible boolean Yes Whether the group displays in a cross department context
name String Yes The name of the group
users List of user [user] Yes The members of the group

JSON Samples

Sample 1
Request URL
/v1/userGroup
Request
{"name":"User defined group","isGloballyVisible":true,"description":"Description for user defined group","departmentId":"321YY3M_0000Y2SWR00000W","users":[{"id":"301YVDM_0008XTGFH000001"},{"id":"301YVDM_0008XTGFH000002"}]}

XML Samples

Sample 1
Request URL
/v1/userGroup
Request
<userGroup>
    <name>User defined group</name>
    <isGloballyVisible>true</isGloballyVisible>
    <description>Description for user defined group</description>
    <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    <users>
        <user>
            <id>301YVDM_0008XTGFH000001</id>
        </user>
        <user>
            <id>301YVDM_0008XTGFH000002</id>
        </user>
    </users>
</userGroup>

DELETE/v1/userGroup/{id} Deletes an existing user group

Expand Operation / Collapse Operation

Deletes an existing user group

Available from version: 1.0.0

Call Properties

Response
Content
None
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003

XML Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003

GET/v1/userGroup/{id} Retrieves an existing userGroup

Expand Operation / Collapse Operation

Retrieves an existing userGroup

Available from version: 1.0.0

Call Properties

Response
Content
userGroup
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
SYSTEM The group is system-defined.
USER_DEFINED The group is user-defined.
userGroup type

user group to be returned

Field Name Data Type Expected Description
category category Yes The category type of the group
departmentId String Yes The id of the department the group belongs to
description String Yes The description of the group
id String Yes The id of the group
isGloballyVisible boolean Yes Whether the group displays in a cross department context
name String Yes The name of the group
users List of users [user] Yes The members of the group
users type

Represents a user who is a member of a group

Field Name Data Type Expected Description
id String Yes The id of the user
userName String Yes The user name of the user

JSON Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003
Response
{"id":"301YVDM_0008XTGFH000003","category":"USER_DEFINED","name":"User defined group","isGloballyVisible":true,"description":"Description for user defined group","departmentId":"321YY3M_0000Y2SWR00000W","users":[{"id":"301YVDM_0008XTGFH000001","userName":"User1"},{"id":"301YVDM_0008XTGFH000002","userName":"User2"}]}

XML Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003
Response
<userGroup>
    <id>301YVDM_0008XTGFH000003</id>
    <category>USER_DEFINED</category>
    <name>User defined group</name>
    <isGloballyVisible>true</isGloballyVisible>
    <description>Description for user defined group</description>
    <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    <users>
        <user>
            <id>301YVDM_0008XTGFH000001</id>
            <userName>User1</userName>
        </user>
        <user>
            <id>301YVDM_0008XTGFH000002</id>
            <userName>User2</userName>
        </user>
    </users>
</userGroup>

PUT/v1/userGroup/{id} Updates an existing user group

Expand Operation / Collapse Operation

Updates an existing user group

Available from version: 1.0.0

Call Properties

Request
Content userGroup
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the newly created group.

Call Types and Enumerations

membership type

Users to be added to or removed from an existing user group

Field Name Data Type Expected Description
usersToAdd List of user [user] Yes The users to be added to the group
usersToRemove List of user [user] Yes The users to be removed from the group
user type

A user to be added to or removed from an existing user group

Field Name Data Type Expected Description
id String Yes The id of the user
userGroup type

user group to be updated

Field Name Data Type Expected Description
description String Yes The description of the group
isGloballyVisible boolean Yes Whether the group displays in a cross department context
membership membership Yes The modification of the group membership
name String Yes The name of the group

JSON Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003
Request
{"name":"User defined group","isGloballyVisible":true,"description":"Description for user defined group","membership":{"usersToAdd":[{"id":"301YVDM_0008XTGFH000003"}],"usersToRemove":[{"id":"301YVDM_0008XTGFH000001"}]}}

XML Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003
Request
<userGroup>
    <name>User defined group</name>
    <isGloballyVisible>true</isGloballyVisible>
    <description>Description for user defined group</description>
    <membership>
        <usersToAdd>
            <user>
                <id>301YVDM_0008XTGFH000003</id>
            </user>
        </usersToAdd>
        <usersToRemove>
            <user>
                <id>301YVDM_0008XTGFH000001</id>
            </user>
        </usersToRemove>
    </membership>
</userGroup>

GET/v1/userGroup/{id}/privilege Gets the privileges for a user group

Expand Operation / Collapse Operation

Gets the privileges for a user group

Available from version: 1.0.0

Call Properties

Query Parameters
global (optional) Include global privileges
documentTypeId (optional) Include privileges for the provided document type ids
drawerId (optional) Include privileges for the provided drawer ids
folderTypeId (optional) Include privileges for the provided folder type ids
Response
Content
List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges are applied, if applicable
privileges List of privilege [privilege] Yes The privileges to apply
type type Yes The type of privileges applied
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE Document type
FOLDER_TYPE Folder type
DRAWER Drawer
GLOBAL Global
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&documentTypeId=301YVDM_0008XTGFH00004H
Response
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004H","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"DENIED"},{"name":"CUSTOM_PROP_MODIFY","value":"UNSET"}]}]}

XML Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&documentTypeId=301YVDM_0008XTGFH00004H
Response
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004H</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>UNSET</value>
            </privilege>
        </privileges>
    </privilegeSet>
</privilegeSets>

PUT/v1/userGroup/{id}/privilege Sets the privileges for a user group

Expand Operation / Collapse Operation

Sets the privileges for a user group

Available from version: 1.0.0

Call Properties

Request
Content List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
List of failedPrivilegeSet [failedPrivilegeSet] (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

failedPrivilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges failed to be applied, if applicable
message String Yes The error message for why the privilege set failed to be applied
type type Yes The type of privilege set that failed to be applied
privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges are applied, if applicable
privileges List of privilege [privilege] Yes The privileges to apply
type type Yes The type of privileges applied
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE Document type
FOLDER_TYPE Folder type
DRAWER Drawer
GLOBAL Global
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003/privilege
Request
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004H","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"DENIED"},{"name":"CUSTOM_PROP_MODIFY","value":"IGNORE"}]}]}

XML Samples

Sample 1
Request URL
/v1/userGroup/301YVDM_0008XTGFH000003/privilege
Request
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004H</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>IGNORE</value>
            </privilege>
        </privileges>
    </privilegeSet>
</privilegeSets>

UserGroup (Version 2)

GET/v2/userGroup/{id} Retrieves an existing user group

Expand Operation / Collapse Operation

Retrieves an existing user group

Available from version: 1.0.0

Call Properties

Response
Content
userGroup
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
SYSTEM The group is system-defined.
USER_DEFINED The group is user-defined.
userGroup type

A representation of a user group.

Field Name Data Type Expected Description
category category Yes The category type of the user group.
departmentId String Yes The ID of the user group's department.
description String Yes The description of the user group.
isGloballyVisible boolean Yes A flag that represents whether the user group displays in a cross department context.
name String Yes The name of the user group.
users List of users [user] Yes The users of the group.
users type

A representation of a user in a user group.

Field Name Data Type Expected Description
id String Yes The ID of the user.
userName String Yes The user name of the user.

JSON Samples

Sample 1
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Response
{"name":"HR Managers","category":"USER_DEFINED","isGloballyVisible":true,"description":"Managers of the HR department.","departmentId":"321YY3M_0000Y2SWR00000W","users":[{"id":"301YVDM_0008XTGFH000001","userName":"jsmith"},{"id":"301YVDM_0008XTGFH000002","userName":"jdoe"}]}

XML Samples

Sample 1
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Response
<userGroup>
    <name>HR Managers</name>
    <category>USER_DEFINED</category>
    <isGloballyVisible>true</isGloballyVisible>
    <description>Managers of the HR department.</description>
    <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    <users>
        <user>
            <id>301YVDM_0008XTGFH000001</id>
            <userName>jsmith</userName>
        </user>
        <user>
            <id>301YVDM_0008XTGFH000002</id>
            <userName>jdoe</userName>
        </user>
    </users>
</userGroup>

PATCH/v2/userGroup/{id} Executes the list of patch operations and updates the user group accordingly.

Expand Operation / Collapse Operation

Executes the list of patch operations and updates the user group accordingly.

Available from version: 1.0.0

Call Properties

Request
Content patchDocument
Content-Types
  • application/json
  • application/xml
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

patchDocument type

Field Name Data Type Expected Description
operations List of patchOperation [operation] Yes A list of operations to apply to a JSON document.
patchOperation type

A representation of an operation to perform on a JSON document.

Field Name Data Type Expected Description
from String No Path of a json node required for copy and move operations.
op String Yes The patch operation to execute. Supported operations are add, remove, move, replace, copy and test.
path String Yes Path of a json node.
value Object No Value of a json node.
valuePathComparator String No Specifies the path within the collection object to verify if the item exists before removal.

JSON Samples

Sample 1 - Add a user to a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"operations":[{"op":"add","path":"/users/2","value":"{\"id\": \"value\", \"userName\":\"admin1\"}","from":null,"valuePathComparator":null}]}
Sample 2 - Remove a user from a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"operations":[{"op":"remove","path":"/users/0","value":null,"from":null,"valuePathComparator":null}]}
Sample 3 - Remove a user from a user group by ID.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"operations":[{"op":"replace","path":"/users","value":"301YVDM_0008XTGFH000003","from":null,"valuePathComparator":"/id"}]}
Sample 4 - Replace a field on the user group with a new value.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"operations":[{"op":"replace","path":"/isGloballyVisible","value":false,"from":null,"valuePathComparator":null}]}
Sample 5 - Validate existing value is set on a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"operations":[{"op":"test","path":"/isGloballyVisible","value":false,"from":null,"valuePathComparator":null}]}
Sample 6 - Copy a value from one field in a user group to another.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"operations":[{"op":"copy","path":"/description","value":null,"from":"/name","valuePathComparator":null}]}

XML Samples

Sample 1 - Add a user to a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<patchDocument>
    <operations>
        <operation>
            <op>add</op>
            <path>/users/2</path>
            <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">{"id": "value", "userName":"admin1"}</value>
        </operation>
    </operations>
</patchDocument>
Sample 2 - Remove a user from a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<patchDocument>
    <operations>
        <operation>
            <op>remove</op>
            <path>/users/0</path>
        </operation>
    </operations>
</patchDocument>
Sample 3 - Remove a user from a user group by ID.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<patchDocument>
    <operations>
        <operation>
            <op>replace</op>
            <path>/users</path>
            <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">301YVDM_0008XTGFH000003</value>
            <valuePathComparator>/id</valuePathComparator>
        </operation>
    </operations>
</patchDocument>
Sample 4 - Replace a field on the user group with a new value.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<patchDocument>
    <operations>
        <operation>
            <op>replace</op>
            <path>/isGloballyVisible</path>
            <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:boolean">false</value>
        </operation>
    </operations>
</patchDocument>
Sample 5 - Validate existing value is set on a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<patchDocument>
    <operations>
        <operation>
            <op>test</op>
            <path>/isGloballyVisible</path>
            <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:boolean">false</value>
        </operation>
    </operations>
</patchDocument>
Sample 6 - Copy a value from one field in a user group to another.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<patchDocument>
    <operations>
        <operation>
            <op>copy</op>
            <path>/description</path>
            <from>/name</from>
        </operation>
    </operations>
</patchDocument>

PUT/v2/userGroup/{id} Updates an existing user group.

Expand Operation / Collapse Operation

Updates an existing user group.

Available from version: 1.0.0

Call Properties

Request
Content userGroup
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

category enumeration

Represents the type of category.

Constant Name Description
SYSTEM The group is system-defined.
USER_DEFINED The group is user-defined.
userGroup type

A representation of a user group.

Field Name Data Type Expected Description
category category Yes The category type of the user group.
departmentId String Yes The ID of the user group's department.
description String Yes The description of the user group.
isGloballyVisible boolean Yes A flag that represents whether the user group displays in a cross department context.
name String Yes The name of the user group.
users List of users [user] Yes The users of the group.
users type

A representation of a user in a user group.

Field Name Data Type Expected Description
id String Yes The ID of the user.
userName String Yes The user name of the user.

JSON Samples

Sample 1 - Add a user to a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"name":"HR Managers","category":"USER_DEFINED","isGloballyVisible":true,"description":"Managers of the HR department.","departmentId":"321YY3M_0000Y2SWR00000W","users":[{"id":"301YVDM_0008XTGFH000001","userName":null},{"id":"301YVDM_0008XTGFH000002","userName":null},{"id":"301YVDM_0008XTGFH000003","userName":null}]}
Sample 2 - Remove a user from a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
{"name":"HR Managers","category":"USER_DEFINED","isGloballyVisible":true,"description":"Managers of the HR department.","departmentId":"321YY3M_0000Y2SWR00000W","users":[{"id":"301YVDM_0008XTGFH000001","userName":null}]}

XML Samples

Sample 1 - Add a user to a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<userGroup>
    <name>HR Managers</name>
    <category>USER_DEFINED</category>
    <isGloballyVisible>true</isGloballyVisible>
    <description>Managers of the HR department.</description>
    <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    <users>
        <user>
            <id>301YVDM_0008XTGFH000001</id>
        </user>
        <user>
            <id>301YVDM_0008XTGFH000002</id>
        </user>
        <user>
            <id>301YVDM_0008XTGFH000003</id>
        </user>
    </users>
</userGroup>
Sample 2 - Remove a user from a user group.
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003
Request
<userGroup>
    <name>HR Managers</name>
    <category>USER_DEFINED</category>
    <isGloballyVisible>true</isGloballyVisible>
    <description>Managers of the HR department.</description>
    <departmentId>321YY3M_0000Y2SWR00000W</departmentId>
    <users>
        <user>
            <id>301YVDM_0008XTGFH000001</id>
        </user>
    </users>
</userGroup>

GET/v2/userGroup/{id}/privilege This API call requests detailed information about the privileges for the user group that matches ...

Expand Operation / Collapse Operation

This API call requests detailed information about the privileges for the user group that matches the given ID. Integration Server structures the response using the privilegeSet type, which provides the unique ID and type of each privilege set, the name of each privilege within a set, as well as whether the privilege for that user group is GRANTED, DENIED, or UNSET. You can use query parameters to return specific privilege sets for a user group, such as global privileges and document type privileges. You can enter multiple query parameters on the same call. If a query parameter is repeated, Integration Server ignores the extra query parameters. If you don't provide any query parameters, Integration Server returns an empty structure.

Available from version: 1.0.0

Call Properties

Query Parameters
global (optional) Returns the global privileges for the user group. A unique ID is not required for the global query parameter.
documentTypeId (optional) Returns the document type privileges for the user group. The unique ID of the document type is required.
drawerId (optional) Returns the drawer privileges for the user group. The unique ID of the drawer type is required.
folderTypeId (optional) Returns the folder type privileges for the user group. The unique ID of the folder type is required.
departmentId (optional) Returns the department privileges for the user group. The unique ID of the department is required.
Response
Content
List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The ID of the privilege set. When the type is GLOBAL, the ID value will be NULL.
privileges List of privilege [privilege] Yes The name and value of each privilege in the privilege set.
type type Yes The type of the privilege set.
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE The document type privileges for a given user group and document type.
FOLDER_TYPE The folder type privileges for a given user group and folder type.
DRAWER The drawer privileges for a given user group and drawer.
GLOBAL The global privileges for a user group.
DEPARTMENT The department privileges for a given user group and department.
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&departmentId=301YVDM_0008XTGFH00004L
Response
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004L","type":"DEPARTMENT","privileges":[{"name":"WORKER_FLOW_MANAGER","value":"DENIED"},{"name":"MANAGE_GROUPS","value":"UNSET"}]}]}

XML Samples

Sample 1
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003/privilege?global&documentTypeId=301YVDM_0008XTGFH00004G&departmentId=301YVDM_0008XTGFH00004L
Response
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004L</id>
        <type>DEPARTMENT</type>
        <privileges>
            <privilege>
                <name>WORKER_FLOW_MANAGER</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>MANAGE_GROUPS</name>
                <value>UNSET</value>
            </privilege>
        </privileges>
    </privilegeSet>
</privilegeSets>

PUT/v2/userGroup/{id}/privilege This API call modifies the privileges for an existing user group. Integration Server structures t...

Expand Operation / Collapse Operation

This API call modifies the privileges for an existing user group. Integration Server structures the request using the privilegeSet type, which provides the unique ID and type of each privilege set, the name of each privilege within a set, as well as whether the privilege for that user group is GRANTED, DENIED, UNSET, or IGNORE. For the call to succeed, the request must contain all of the privileges for the given privilege type, such as FOLDER_TYPE in the example below.

Available from version: 1.0.0

Call Properties

Request
Content List of privilegeSet [privilegeSet]
Content-Types
  • application/xml
  • application/json
Response
Content
None (expected)
List of failedPrivilegeSet [failedPrivilegeSet] (not expected)
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

failedPrivilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The id of the item whose privileges failed to be applied, if applicable
message String Yes The error message for why the privilege set failed to be applied
type type Yes The type of privilege set that failed to be applied
privilege type

A privilege and its value

Field Name Data Type Expected Description
name String Yes The name of the privilege.
value value Yes The value of the privilege. The privilegeType enumeration provides the possible values for this element.
privilegeSet type

Represents a set of privileges

Field Name Data Type Expected Description
id String Yes The ID of the privilege set. When the type is GLOBAL, the ID value will be NULL.
privileges List of privilege [privilege] Yes The name and value of each privilege in the privilege set.
type type Yes The type of the privilege set.
type enumeration

Security privilege type

Constant Name Description
DOCUMENT_TYPE The document type privileges for a given user group and document type.
FOLDER_TYPE The folder type privileges for a given user group and folder type.
DRAWER The drawer privileges for a given user group and drawer.
GLOBAL The global privileges for a user group.
DEPARTMENT The department privileges for a given user group and department.
value enumeration

Security privilege value

Constant Name Description
UNSET The administrator has not set the privilege.
IGNORE The privilege remains unchanged.
GRANTED The privilege is granted.
DENIED The privilege is denied.

JSON Samples

Sample 1
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003/privilege
Request
{"privilegeSets":[{"id":null,"type":"GLOBAL","privileges":[{"name":"CAPTURE_SINGLE_CREATE","value":"GRANTED"},{"name":"SEARCH_CONTENT","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004G","type":"DOCUMENT_TYPE","privileges":[{"name":"CONTENT_DELETE","value":"GRANTED"},{"name":"CUSTOM_PROP_MODIFY","value":"DENIED"}]},{"id":"301YVDM_0008XTGFH00004L","type":"DEPARTMENT","privileges":[{"name":"CONTENT_DELETE","value":"DENIED"},{"name":"CUSTOM_PROP_MODIFY","value":"IGNORE"}]}]}

XML Samples

Sample 1
Request URL
/v2/userGroup/301YVDM_0008XTGFH000003/privilege
Request
<privilegeSets>
    <privilegeSet>
        <type>GLOBAL</type>
        <privileges>
            <privilege>
                <name>CAPTURE_SINGLE_CREATE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>SEARCH_CONTENT</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004G</id>
        <type>DOCUMENT_TYPE</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>GRANTED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>DENIED</value>
            </privilege>
        </privileges>
    </privilegeSet>
    <privilegeSet>
        <id>301YVDM_0008XTGFH00004L</id>
        <type>DEPARTMENT</type>
        <privileges>
            <privilege>
                <name>CONTENT_DELETE</name>
                <value>DENIED</value>
            </privilege>
            <privilege>
                <name>CUSTOM_PROP_MODIFY</name>
                <value>IGNORE</value>
            </privilege>
        </privileges>
    </privilegeSet>
</privilegeSets>

View (Version 1)

GET/v1/view Gets all views in the server.

Expand Operation / Collapse Operation

Gets all views in the server.

Available from version: 1.0.0

Call Properties

Query Parameters
category category (optional) Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
classifier classifier (optional) Filter views by classifier
Response
Content
List of view [view]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Along with viewClassifier, represents the type of view.

Constant Name Description
DOCUMENT A view that returns documents
FOLDER A view that returns folders
TASK A view that returns tasks
WORKFLOW A view that returns workflow items in a process or queue
FOLDER_CONTENT A view that returns workflow items in a process or queue
classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
view type

Represents a view.

Field Name Data Type Expected Description
category category Yes The category of the view
classifier classifier Yes The classifier of the view
description String Yes A description of the view
hasFilters boolean Yes Flag representing if the view has filters
id String Yes The ID of the view
name String Yes The name of the view

JSON Samples

Sample 1
Request URL
/v1/view?category=DOCUMENT
Response
{"views":[{"id":"301US2G_0005CT5AS000025","name":"DevelopmentDocumentsView","description":"All Development documents available to the user account","category":"DOCUMENT","classifier":"NONE","hasFilters":true},{"id":"301YW1Y_0006CY7ZX000013","name":"SystemDocumentsAll","description":"All documents available to the user account","category":"DOCUMENT","classifier":"NONE","hasFilters":false}]}

XML Samples

Sample 1
Request URL
/v1/view?category=DOCUMENT
Response
<views>
    <view>
        <id>301US2G_0005CT5AS000025</id>
        <name>DevelopmentDocumentsView</name>
        <description>All Development documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <hasFilters>true</hasFilters>
    </view>
    <view>
        <id>301YW1Y_0006CY7ZX000013</id>
        <name>SystemDocumentsAll</name>
        <description>All documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <hasFilters>false</hasFilters>
    </view>
</views>

GET/v1/view/{id} Gets the view in the server that matches the ID.

Expand Operation / Collapse Operation

Gets the view in the server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameter
category category Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
Response
Content
view
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Along with viewClassifier, represents the type of view.

Constant Name Description
DOCUMENT A view that returns documents
FOLDER A view that returns folders
TASK A view that returns tasks
WORKFLOW A view that returns workflow items in a process or queue
FOLDER_CONTENT A view that returns workflow items in a process or queue
classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
dataType enumeration

Data type for the column.

Constant Name Description
STRING
INTEGER
BOOLEAN
DATE
CUSTOM_PROPERTY
PRIV_STRING
DOUBLE
workflowItemState
taskStatus
taskType
taskCompletionType
folderStatus
folderContentType
digitalSignatureStatus
displayType enumeration

Visibility for the column.

Constant Name Description
HIDDEN
VISIBLE
sortDirection enumeration

Sort direction for the column.

Constant Name Description
ASCENDING
DESCENDING
summaryFunction enumeration

Function for the summary field

Constant Name Description
AVERAGE
MEDIAN
MAXIMUM
MINIMUM
NUMERIC_MODE
TOTAL
COUNT_FUTURE
COUNT_PAST
NEXT
PREVIOUS
FIRST
LAST
LIST_COUNT
view type

Field Name Data Type Expected Description
autoRun boolean Yes
category category Yes
classifier classifier Yes
columns List of viewColumn [column] Yes
description String Yes
filters List of viewFilter [filter] Yes
id String Yes
name String Yes
searchPrompts List of viewSearchPrompt [searchPrompt] Yes
summaryColumns List of viewSummaryColumn [summaryColumn] Yes
viewColumn type

Field Name Data Type Expected Description
columnId String Yes
dataType dataType Yes
displayType displayType Yes
groupOrder Integer Yes
name String Yes
sortDirection sortDirection Yes
sortOrder Integer Yes
width Double Yes
viewFilter type

Field Name Data Type Expected Description
autoRun boolean Yes
category category Yes
classifier classifier Yes
description String Yes
id String Yes
name String Yes
public boolean Yes
viewSearchPrompt type

Field Name Data Type Expected Description
constraintId String Yes
message String Yes
propertyId String No
viewSummaryColumn type

Field Name Data Type Expected Description
columnId String Yes
filterValue String Yes
function summaryFunction Yes
identifierColumnId String No
label String Yes
sequence Integer Yes

JSON Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
{"id":"301YW1Y_0006CY7ZX000013","name":"Test Document View","description":"","category":"DOCUMENT","autoRun":true,"classifier":"NONE","searchPrompts":[],"filters":[{"id":"301YW1Y_0006CH7ZW00002G","name":"Test Filter","description":"","category":"DOCUMENT","autoRun":true,"classifier":"NONE","public":true}],"columns":[{"columnId":"39","dataType":"STRING","displayType":"HIDDEN","name":"Details","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"columnId":"301YW1T_000693JRD00000L","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Coin Toss","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"summaryColumns":[{"function":"LIST_COUNT","label":"Heads Count","filterValue":"1","sequence":0,"columnId":"301YW1T_000693JRD00000L","identifierColumnId":null}]}

XML Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
<view>
    <id>301YW1Y_0006CY7ZX000013</id>
    <name>Test Document View</name>
    <description/>
    <category>DOCUMENT</category>
    <autoRun>true</autoRun>
    <classifier>NONE</classifier>
    <searchPrompts/>
    <filters>
        <filter>
            <id>301YW1Y_0006CH7ZW00002G</id>
            <name>Test Filter</name>
            <description/>
            <category>DOCUMENT</category>
            <autoRun>true</autoRun>
            <classifier>NONE</classifier>
            <public>true</public>
        </filter>
    </filters>
    <columns>
        <column>
            <columnId>39</columnId>
            <dataType>STRING</dataType>
            <displayType>HIDDEN</displayType>
            <name>Details</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
        <column>
            <columnId>301YW1T_000693JRD00000L</columnId>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Coin Toss</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
    </columns>
    <summaryColumns>
        <summaryColumn>
            <function>LIST_COUNT</function>
            <label>Heads Count</label>
            <filterValue>1</filterValue>
            <sequence>0</sequence>
            <columnId>301YW1T_000693JRD00000L</columnId>
        </summaryColumn>
    </summaryColumns>
</view>

POST/v1/view/{id}/refreshResult Run view of the given type and context information.

Expand Operation / Collapse Operation

Run view of the given type and context information.

Available from version: 1.0.0

Call Properties

Query Parameter
category category Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
Request
Content viewRefreshParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Along with viewClassifier, represents the type of view.

Constant Name Description
DOCUMENT A view that returns documents
FOLDER A view that returns folders
TASK A view that returns tasks
WORKFLOW A view that returns workflow items in a process or queue
FOLDER_CONTENT A view that returns workflow items in a process or queue
viewRefreshParameters type

Represents a set of view options.

Field Name Data Type Expected Description
columnIds List of String [columnId] No A list of custom property column ids to append to the view
contextId String No The queue ID on which the view will be run, used only in workflow views
itemIds List of String [itemId] Yes A list of row object IDs to constrain the view, depending on the view type.
viewResultRow type

Represents a row of a view result.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs making up the row.
viewResultRowField type

Field Name Data Type Expected Description
columnId String Yes
value String Yes
viewResults type

Field Name Data Type Expected Description
hasMore boolean Yes
resultRows List of viewResultRow [resultRow] Yes

JSON Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/refreshResult?category=DOCUMENT
Request
{"contextId":null,"columnIds":["301YW1T_000693JRD00000L"],"itemIds":["301YW27_0006CP7ZX00018F"]}
Response
{"hasMore":false,"resultRows":[{"fields":[{"columnId":"24","value":"false"},{"columnId":"9","value":"false"},{"columnId":"301YW1T_000693JRD00000L","value":"Some value"}]}]}

XML Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/refreshResult?category=DOCUMENT
Request
<viewRefreshParameters>
    <columnIds>
        <columnId>301YW1T_000693JRD00000L</columnId>
    </columnIds>
    <itemIds>
        <itemId>301YW27_0006CP7ZX00018F</itemId>
    </itemIds>
</viewRefreshParameters>
Response
<viewResults>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>24</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>301YW1T_000693JRD00000L</columnId>
                    <value>Some value</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

POST/v1/view/{id}/result Run view with type and id in the server.

Expand Operation / Collapse Operation

Run view with type and id in the server.

Available from version: 1.0.0

Call Properties

Path Parameter
id The ID of the view to run
Query Parameter
category category Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
Request
Content viewParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Along with viewClassifier, represents the type of view.

Constant Name Description
DOCUMENT A view that returns documents
FOLDER A view that returns folders
TASK A view that returns tasks
WORKFLOW A view that returns workflow items in a process or queue
FOLDER_CONTENT A view that returns workflow items in a process or queue
viewParameters type

Field Name Data Type Expected Description
vslText String No
viewResultRow type

Represents a row of a view result.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs making up the row.
viewResultRowField type

Field Name Data Type Expected Description
columnId String Yes
value String Yes
viewResults type

Field Name Data Type Expected Description
hasMore boolean Yes
resultRows List of viewResultRow [resultRow] Yes

JSON Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
{"vslText":"[name] startswith 'test'"}
Response
{"hasMore":false,"resultRows":[{"fields":[{"columnId":"24","value":"false"},{"columnId":"9","value":"false"}]},{"fields":[{"columnId":"24","value":"false"},{"columnId":"9","value":"false"}]}]}

XML Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
<viewParameters>
    <vslText>[name] startswith 'test'</vslText>
</viewParameters>
Response
<viewResults>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>24</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>24</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

POST/v1/view/{viewId}/filter Create a private filter on the view.

Expand Operation / Collapse Operation

Create a private filter on the view.

Available from version: 4.5.0

Call Properties

Path Parameter
viewId The ID of the view on which to create the filter.
Request
Content createFilterParameters
Content-Types
  • application/xml
  • application/json
Response
Content
createFilterResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

createFilterParameters type

Parameters for creating a filter on a view.

Field Name Data Type Expected Description
description String No Description of the filter.
name String Yes Name of the filter.
vslText String No VSL text for the filter.
createFilterResults type

IDs returned after creating a filter.

Field Name Data Type Expected Description
filterId String Yes ID of the filter created.
vslRuleId String Yes ID of the VSL rule created.

JSON Samples

Sample 1 (Since 4.5.0)
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter
Request
{"name":"Filter Name","description":"Description of the filter","vslText":"[docType] = 'Default'"}
Response
{"filterId":"321YXCN_0000CL5B500002F","vslRuleId":"321YXCN_0000CL5B500002G"}

XML Samples

Sample 1 (Since 4.5.0)
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter
Request
<createFilterParameters>
    <name>Filter Name</name>
    <description>Description of the filter</description>
    <vslText>[docType] = 'Default'</vslText>
</createFilterParameters>
Response
<createFilterResults>
    <filterId>321YXCN_0000CL5B500002F</filterId>
    <vslRuleId>321YXCN_0000CL5B500002G</vslRuleId>
</createFilterResults>

DELETE/v1/view/{viewId}/filter/{filterId} Delete a private filter.

Expand Operation / Collapse Operation

Delete a private filter.

Available from version: 4.5.0

Call Properties

Path Parameters
viewId The ID of the view being filtered.
filterId The ID of the filter to delete.
Response
Content
None
Content-Type Not Applicable

JSON Samples

Sample 1 (Since 4.5.0)
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter/321YXCN_0000CL5B500002F

XML Samples

Sample 1 (Since 4.5.0)
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter/321YXCN_0000CL5B500002F

PUT/v1/view/{viewId}/filter/{filterId} Update a private filter.

Expand Operation / Collapse Operation

Update a private filter.

Available from version: 4.5.0

Call Properties

Path Parameters
viewId The ID of the view being filtered.
filterId The ID of the filter to update.
Request
Content createFilterParameters
Content-Types
  • application/xml
  • application/json
Response
Content
updateFilterResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

createFilterParameters type

Parameters for creating a filter on a view.

Field Name Data Type Expected Description
description String No Description of the filter.
name String Yes Name of the filter.
vslText String No VSL text for the filter.
updateFilterResults type

IDs returned after updating a filter.

Field Name Data Type Expected Description
vslRuleId String Yes ID of the new VSL rule created.

JSON Samples

Sample 1 (Since 4.5.0)
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter/321YXCN_0000CL5B500002F
Request
{"name":"New name for the filter","description":"New description of the filter","vslText":"[docType] = 'A Different Type'"}
Response
{"vslRuleId":"321YXCN_0000CL5B500002H"}

XML Samples

Sample 1 (Since 4.5.0)
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter/321YXCN_0000CL5B500002F
Request
<createFilterParameters>
    <name>New name for the filter</name>
    <description>New description of the filter</description>
    <vslText>[docType] = 'A Different Type'</vslText>
</createFilterParameters>
Response
<updateFilterResults>
    <vslRuleId>321YXCN_0000CL5B500002H</vslRuleId>
</updateFilterResults>

POST/v1/view/{viewId}/filter/{filterId}/result Run view with type and id in the server and apply the filter to it.

Expand Operation / Collapse Operation

Run view with type and id in the server and apply the filter to it.

Available from version: 1.0.0

Call Properties

Path Parameters
viewId The view ID to run.
filterId The filter ID to run
Query Parameter
category category Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
Request
Content viewFilterParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

category enumeration

Along with viewClassifier, represents the type of view.

Constant Name Description
DOCUMENT A view that returns documents
FOLDER A view that returns folders
TASK A view that returns tasks
WORKFLOW A view that returns workflow items in a process or queue
FOLDER_CONTENT A view that returns workflow items in a process or queue
viewFilterParameters type

Field Name Data Type Expected Description
runtimeVariables List of viewRuntimeVariable [runtimeVariable] No
vslText String No
viewResultRow type

Represents a row of a view result.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs making up the row.
viewResultRowField type

Field Name Data Type Expected Description
columnId String Yes
value String Yes
viewResults type

Field Name Data Type Expected Description
hasMore boolean Yes
resultRows List of viewResultRow [resultRow] Yes
viewRuntimeVariable type

Field Name Data Type Expected Description
constraintId String Yes
value String Yes

JSON Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')"}
Response
{"hasMore":false,"resultRows":[{"fields":[{"columnId":"24","value":"false"},{"columnId":"9","value":"false"}]},{"fields":[{"columnId":"24","value":"false"},{"columnId":"9","value":"false"}]}]}

XML Samples

Sample 1
Request URL
/v1/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewParameters>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
</viewParameters>
Response
<viewResults>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>24</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>24</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

View (Version 2)

GET/v2/view Gets all views in the server.

Expand Operation / Collapse Operation

Gets all views in the server.

Available from version: 1.0.0

Call Properties

Query Parameters
category viewCategory (optional) Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
classifier classifier (optional) Filter views by classifier
Response
Content
List of view [view]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
view type

Represents a view.

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto run enabled
category viewCategory Yes The category of the view
classifier classifier Yes The classifier of the view
description String Yes A description of the view
hasFilters boolean Yes Flag representing if the view has filters
id String Yes The ID of the view
name String Yes The name of the view
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.

JSON Samples

Sample 1
Request URL
/v2/view?category=DOCUMENT
Response
{"views":[{"id":"301US2G_0005CT5AS000025","name":"DevelopmentDocumentsView","description":"All Development documents available to the user account","category":"DOCUMENT","classifier":"NONE","autoRun":false,"hasFilters":true},{"id":"301YW1Y_0006CY7ZX000013","name":"SystemDocumentsAll","description":"All documents available to the user account","category":"DOCUMENT","classifier":"NONE","autoRun":false,"hasFilters":false}]}

XML Samples

Sample 1
Request URL
/v2/view?category=DOCUMENT
Response
<views>
    <view>
        <id>301US2G_0005CT5AS000025</id>
        <name>DevelopmentDocumentsView</name>
        <description>All Development documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <autoRun>false</autoRun>
        <hasFilters>true</hasFilters>
    </view>
    <view>
        <id>301YW1Y_0006CY7ZX000013</id>
        <name>SystemDocumentsAll</name>
        <description>All documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
</views>

GET/v2/view/{id} Gets the view in the server that matches the ID.

Expand Operation / Collapse Operation

Gets the view in the server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
Response
Content
view
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
dataType enumeration

Data type for the column.

Constant Name Description
STRING
INTEGER
BOOLEAN
DATE
CUSTOM_PROPERTY
PRIV_STRING
DOUBLE
workflowItemState
taskStatus
taskType
taskCompletionType
folderStatus
folderContentType
digitalSignatureStatus
displayType enumeration

Visibility for the column.

Constant Name Description
HIDDEN
VISIBLE
sortDirection enumeration

Sort direction for the column.

Constant Name Description
ASCENDING
DESCENDING
summaryFunction enumeration

Function for the summary field

Constant Name Description
AVERAGE
MEDIAN
MAXIMUM
MINIMUM
NUMERIC_MODE
TOTAL
COUNT_FUTURE
COUNT_PAST
NEXT
PREVIOUS
FIRST
LAST
LIST_COUNT
view type

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto run enabled
category viewCategory Yes The category of the view
classifier classifier Yes The classifier of the view
columns List of viewColumn [column] Yes
description String Yes The description of the view
filters List of viewFilter [filter] Yes
id String Yes The ID of the view
name String Yes The name of the view
searchPrompts List of viewSearchPrompt [searchPrompt] Yes
summaryColumns List of viewSummaryColumn [summaryColumn] Yes
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumn type

Field Name Data Type Expected Description
columnId String Yes
dataType dataType Yes
displayType displayType Yes
groupOrder Integer Yes
name String Yes
sortDirection sortDirection Yes
sortOrder Integer Yes
width Double Yes
viewFilter type

Field Name Data Type Expected Description
autoRun boolean Yes Indicate the filter is auto run enabled
category viewCategory Yes The category of the filter
classifier classifier Yes The classifier of the filter
description String Yes The description of the filter
id String Yes The ID of the filter
name String Yes The name of the filter
public boolean Yes Indicate the filter is public or private
viewSearchPrompt type

Field Name Data Type Expected Description
constraintId String Yes
message String Yes
propertyId String No
viewSummaryColumn type

Field Name Data Type Expected Description
columnId String Yes
filterValue String Yes
function summaryFunction Yes
identifierColumnId String No
label String Yes
sequence Integer Yes

JSON Samples

Sample 1
Request URL
/v2/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
{"id":"301YW1Y_0006CY7ZX000013","name":"Test Document View","description":"","category":"DOCUMENT","classifier":"NONE","autoRun":true,"searchPrompts":[],"filters":[{"id":"301YW1Y_0006CH7ZW00002G","name":"Test Filter","description":"","category":"DOCUMENT","classifier":"NONE","autoRun":true,"public":true}],"columns":[{"columnId":"39","dataType":"STRING","displayType":"HIDDEN","name":"Details","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"columnId":"301YW1T_000693JRD00000L","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Coin Toss","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"summaryColumns":[{"function":"LIST_COUNT","label":"Heads Count","filterValue":"1","sequence":0,"columnId":"301YW1T_000693JRD00000L","identifierColumnId":null}]}

XML Samples

Sample 1
Request URL
/v2/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
<view>
    <id>301YW1Y_0006CY7ZX000013</id>
    <name>Test Document View</name>
    <description/>
    <category>DOCUMENT</category>
    <classifier>NONE</classifier>
    <autoRun>true</autoRun>
    <searchPrompts/>
    <filters>
        <filter>
            <id>301YW1Y_0006CH7ZW00002G</id>
            <name>Test Filter</name>
            <description/>
            <category>DOCUMENT</category>
            <classifier>NONE</classifier>
            <autoRun>true</autoRun>
            <public>true</public>
        </filter>
    </filters>
    <columns>
        <column>
            <columnId>39</columnId>
            <dataType>STRING</dataType>
            <displayType>HIDDEN</displayType>
            <name>Details</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
        <column>
            <columnId>301YW1T_000693JRD00000L</columnId>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Coin Toss</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
    </columns>
    <summaryColumns>
        <summaryColumn>
            <function>LIST_COUNT</function>
            <label>Heads Count</label>
            <filterValue>1</filterValue>
            <sequence>0</sequence>
            <columnId>301YW1T_000693JRD00000L</columnId>
        </summaryColumn>
    </summaryColumns>
</view>

POST/v2/view/{id}/result Run view with ID and type in the server.

Expand Operation / Collapse Operation

Run view with ID and type in the server.

Available from version: 1.0.0

Call Properties

Path Parameter
id The ID of the view to run
Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, and WORKFLOW.
Request
Content viewParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewParameters type

The viewParameters type provides the optional column selectors and VSL search string.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document views.
vslText String No The VSL search string. You can view more information about VSL in the help documentation at Manage Content > Configure > Content System > Set up Content system > Use VSL.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.

JSON Samples

Sample 1 - Returns the specified view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}
Sample 2 - Returns all view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":null}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"9","dataType":"BOOLEAN","displayType":"HIDDEN","name":"In Version Control","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"},{"columnId":"9","value":"false"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"},{"columnId":"9","value":"false"}]}]}

XML Samples

Sample 1 - Returns the specified view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
<viewParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>
Sample 2 - Returns all view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
<viewParameters>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>9</id>
            <dataType>BOOLEAN</dataType>
            <displayType>HIDDEN</displayType>
            <name>In Version Control</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

POST/v2/view/{viewId}/filter/{filterId}/result Run view with ID and type in the server and apply the filter to it.

Expand Operation / Collapse Operation

Run view with ID and type in the server and apply the filter to it.

Available from version: 1.0.0

Call Properties

Path Parameters
viewId The ID of the view to run.
filterId The ID of the filter to run
Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, and WORKFLOW.
Request
Content viewFilterParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewFilterParameters type

The viewFilterParameters type provides the optional column selectors and VSL search string as well as the list of search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document views.
runtimeVariables List of viewRuntimeVariable [runtimeVariable] No The list of constraint IDs and values for the prompted searches associated with the given filter.
vslText String No The VSL search string. You can view more information about VSL in the help documentation at Manage Content > Configure > Content System > Set up Content system > Use VSL.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.
viewRuntimeVariable type

The viewRuntimeVariable type provides the search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
constraintId String Yes The unique ID of the search constraint for a prompted search associated with the filter.
value String Yes For the prompted search, this is the value to search by. If this value is a date and time, the time must be in UTC. The clientTimeZoneOffset will not be applied.

JSON Samples

Sample 1 - Returns the specified view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}],"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}
Sample 2 - Returns all view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":null,"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"9","dataType":"BOOLEAN","displayType":"HIDDEN","name":"In Version Control","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"},{"columnId":"9","value":"false"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"},{"columnId":"9","value":"false"}]}]}

XML Samples

Sample 1 - Returns the specified view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>
Sample 2 - Returns all view columns
Request URL
/v2/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>9</id>
            <dataType>BOOLEAN</dataType>
            <displayType>HIDDEN</displayType>
            <name>In Version Control</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

View (Version 3)

GET/v3/view Gets all views in the server. Includes basic filter information.

Expand Operation / Collapse Operation

Gets all views in the server. Includes basic filter information.

Available from version: 1.0.0

Call Properties

Query Parameters
category viewCategory (optional) Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
classifier classifier (optional) Filter views by classifier
Response
Content
List of view [view]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
view type

Represents a view.

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto run enabled
category viewCategory Yes The category of the view
classifier classifier Yes The classifier of the view
description String Yes A description of the view
filters List of viewFilter [filter] Yes
hasFilters boolean Yes Flag representing if the view has filters
id String Yes The ID of the view
name String Yes The name of the view
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewFilter type

Field Name Data Type Expected Description
autoRun boolean Yes Indicate the filter is auto run enabled
category viewCategory Yes The category of the filter
classifier classifier Yes The classifier of the filter
description String Yes The description of the filter
id String Yes The ID of the filter
name String Yes The name of the filter
public boolean Yes Indicate the filter is public or private

JSON Samples

Sample 1
Request URL
/v3/view?category=DOCUMENT
Response
{"views":[{"id":"301US2G_0005CT5AS000025","name":"DevelopmentDocumentsView","description":"All Development documents available to the user account","category":"DOCUMENT","classifier":"NONE","autoRun":false,"hasFilters":true,"filters":[{"id":"301YW1Y_0006CH7ZW00002G","name":"Test Filter","description":"","category":"DOCUMENT","classifier":"NONE","autoRun":true,"public":true}]},{"id":"301YW1Y_0006CY7ZX000013","name":"SystemDocumentsAll","description":"All documents available to the user account","category":"DOCUMENT","classifier":"NONE","autoRun":false,"hasFilters":false,"filters":null}]}

XML Samples

Sample 1
Request URL
/v3/view?category=DOCUMENT
Response
<views>
    <view>
        <id>301US2G_0005CT5AS000025</id>
        <name>DevelopmentDocumentsView</name>
        <description>All Development documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <autoRun>false</autoRun>
        <hasFilters>true</hasFilters>
        <filters>
            <filter>
                <id>301YW1Y_0006CH7ZW00002G</id>
                <name>Test Filter</name>
                <description/>
                <category>DOCUMENT</category>
                <classifier>NONE</classifier>
                <autoRun>true</autoRun>
                <public>true</public>
            </filter>
        </filters>
    </view>
    <view>
        <id>301YW1Y_0006CY7ZX000013</id>
        <name>SystemDocumentsAll</name>
        <description>All documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
    </view>
</views>

GET/v3/view/{id} Gets the view in the server that matches the ID.

Expand Operation / Collapse Operation

Gets the view in the server that matches the ID.

Available from version: 1.0.0

Call Properties

Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
Response
Content
view
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
dataType enumeration

Data type for the column.

Constant Name Description
STRING
INTEGER
BOOLEAN
DATE
CUSTOM_PROPERTY
PRIV_STRING
DOUBLE
workflowItemState
taskStatus
taskType
taskCompletionType
folderStatus
folderContentType
digitalSignatureStatus
displayType enumeration

Visibility for the column.

Constant Name Description
HIDDEN
VISIBLE
operatorType enumeration

Operator for a search constraint.

Constant Name Description
NONE
EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
CONTAINS
STARTS_WITH
ENDS_WITH
NOT_EQUALS
IS_NULL
IS_NOT_NULL
DOES_NOT_CONTAIN
IN
NOT_IN
BETWEEN
NOT_BETWEEN
DOES_NOT_START_WITH
DOES_NOT_END_WITH
sortDirection enumeration

Sort direction for the column.

Constant Name Description
ASCENDING
DESCENDING
summaryFunction enumeration

Function for the summary field

Constant Name Description
AVERAGE
MEDIAN
MAXIMUM
MINIMUM
NUMERIC_MODE
TOTAL
COUNT_FUTURE
COUNT_PAST
NEXT
PREVIOUS
FIRST
LAST
LIST_COUNT
view type

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto run enabled
category viewCategory Yes The category of the view
classifier classifier Yes The classifier of the view
columns List of viewColumn [column] Yes
description String Yes The description of the view
filters List of viewFilter [filter] Yes
id String Yes The ID of the view
name String Yes The name of the view
parentViewId String Yes The ID of the parent view when this is a filter
searchPrompts List of viewSearchPrompt [searchPrompt] Yes
summaryColumns List of viewSummaryColumn [summaryColumn] Yes
vslText String Yes The VSL text when this is a filter
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumn type

Field Name Data Type Expected Description
columnId String Yes
dataType dataType Yes
displayType displayType Yes
groupOrder Integer Yes
name String Yes
sortDirection sortDirection Yes
sortOrder Integer Yes
width Double Yes
viewFilter type

Field Name Data Type Expected Description
autoRun boolean Yes Indicate the filter is auto run enabled
category viewCategory Yes The category of the filter
classifier classifier Yes The classifier of the filter
description String Yes The description of the filter
id String Yes The ID of the filter
name String Yes The name of the filter
public boolean Yes Indicate the filter is public or private
viewSearchPrompt type

Field Name Data Type Expected Description
constraintId String Yes
fieldId Integer No The classifier-specific VSL field identifier if the search is not on a custom property field
message String Yes The prompt shown to the user for this search criteria
operatorId operatorType No The VSL search operator
propertyId String No The custom property identifier if the search is on a custom property field
typeListId String No The identifier of the document type list or folder type list if the search is on a type by a list
viewSummaryColumn type

Field Name Data Type Expected Description
columnId String Yes
filterValue String Yes
function summaryFunction Yes
identifierColumnId String No
label String Yes
sequence Integer Yes

JSON Samples

Sample 1
Request URL
/v3/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
{"id":"301YW1Y_0006CY7ZX000013","name":"Filter on a document view","description":"Filters documents between a user-specified range of date/times","category":"DOCUMENT","classifier":"NONE","autoRun":true,"vslText":"[Created] between <<Prompt: Created date between x and y>>","parentViewId":"301YW1Y_0006CY7ZX000010","searchPrompts":[{"constraintId":"301YW1Y_0006CWHBX000013","message":"Created date between x and y","propertyId":"","fieldId":2,"typeListId":null,"operatorId":"BETWEEN"}],"filters":[],"columns":[{"columnId":"39","dataType":"STRING","displayType":"HIDDEN","name":"Details","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"columnId":"301YW1T_000693JRD00000L","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Coin Toss","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"summaryColumns":[{"function":"LIST_COUNT","label":"Heads Count","filterValue":"1","sequence":0,"columnId":"301YW1T_000693JRD00000L","identifierColumnId":null}]}

XML Samples

Sample 1
Request URL
/v3/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
<view>
    <id>301YW1Y_0006CY7ZX000013</id>
    <name>Filter on a document view</name>
    <description>Filters documents between a user-specified range of date/times</description>
    <category>DOCUMENT</category>
    <classifier>NONE</classifier>
    <autoRun>true</autoRun>
    <vslText>[Created] between &lt;&lt;Prompt: Created date between x and y&gt;&gt;</vslText>
    <parentViewId>301YW1Y_0006CY7ZX000010</parentViewId>
    <searchPrompts>
        <searchPrompt>
            <constraintId>301YW1Y_0006CWHBX000013</constraintId>
            <message>Created date between x and y</message>
            <propertyId/>
            <fieldId>2</fieldId>
            <operatorId>BETWEEN</operatorId>
        </searchPrompt>
    </searchPrompts>
    <filters/>
    <columns>
        <column>
            <columnId>39</columnId>
            <dataType>STRING</dataType>
            <displayType>HIDDEN</displayType>
            <name>Details</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
        <column>
            <columnId>301YW1T_000693JRD00000L</columnId>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Coin Toss</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
    </columns>
    <summaryColumns>
        <summaryColumn>
            <function>LIST_COUNT</function>
            <label>Heads Count</label>
            <filterValue>1</filterValue>
            <sequence>0</sequence>
            <columnId>301YW1T_000693JRD00000L</columnId>
        </summaryColumn>
    </summaryColumns>
</view>

POST/v3/view/{id}/result Run view with ID and type on the server. This version returns the correct unix timestamp for date...

Expand Operation / Collapse Operation

Run view with ID and type on the server. This version returns the correct unix timestamp for date custom properties.

Available from version: 1.0.0

Call Properties

Path Parameter
id The ID of the view to run
Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, and WORKFLOW.
Request
Content viewParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewParameters type

The viewParameters type provides the optional column selectors and VSL search string.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document views.
vslText String No The VSL search string. You can view more information about VSL in the help documentation at Manage Content > Configure > Content System > Set up Content system > Use VSL.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.

JSON Samples

Sample 1 - Returns the specified view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}
Sample 2 - Returns all view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":null}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"9","dataType":"BOOLEAN","displayType":"HIDDEN","name":"In Version Control","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"},{"columnId":"9","value":"false"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"},{"columnId":"9","value":"false"}]}]}

XML Samples

Sample 1 - Returns the specified view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
<viewParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>
Sample 2 - Returns all view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
<viewParameters>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>9</id>
            <dataType>BOOLEAN</dataType>
            <displayType>HIDDEN</displayType>
            <name>In Version Control</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

POST/v3/view/{viewId}/filter/{filterId}/result Run view with ID and type on the server and apply the filter to it. This version returns the corr...

Expand Operation / Collapse Operation

Run view with ID and type on the server and apply the filter to it. This version returns the correct unix timestamp for date custom properties.

Available from version: 1.0.0

Call Properties

Path Parameters
viewId The ID of the view to run.
filterId The ID of the filter to run
Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, and WORKFLOW.
Request
Content viewFilterParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewFilterParameters type

The viewFilterParameters type provides the optional column selectors and VSL search string as well as the list of search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document views.
runtimeVariables List of viewRuntimeVariable [runtimeVariable] No The list of constraint IDs and values for the prompted searches associated with the given filter.
vslText String No The VSL search string. You can view more information about VSL in the help documentation at Manage Content > Configure > Content System > Set up Content system > Use VSL.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.
viewRuntimeVariable type

The viewRuntimeVariable type provides the search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
constraintId String Yes The unique ID of the search constraint for a prompted search associated with the filter.
value String Yes For the prompted search, this is the value to search by. If this value is a date and time, the time must be in UTC. The clientTimeZoneOffset will not be applied.

JSON Samples

Sample 1 - Returns the specified view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}],"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}
Sample 2 - Returns all view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","columnSelectors":null,"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"9","dataType":"BOOLEAN","displayType":"HIDDEN","name":"In Version Control","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"},{"columnId":"9","value":"false"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"},{"columnId":"9","value":"false"}]}]}

XML Samples

Sample 1 - Returns the specified view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>
Sample 2 - Returns all view columns
Request URL
/v3/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>9</id>
            <dataType>BOOLEAN</dataType>
            <displayType>HIDDEN</displayType>
            <name>In Version Control</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

View (Version 4)

GET/v4/view Gets all views in the server. Includes user privileges.

Expand Operation / Collapse Operation

Gets all views in the server. Includes user privileges.

Available from version: 4.6.0

Call Properties

Query Parameters
category viewCategory (optional) Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
classifier classifier (optional) Filter views by classifier
Response
Content
List of view [view]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
view type

Represents a view.

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto-run enabled.
category viewCategory Yes The category of the view.
classifier classifier Yes The classifier of the view.
description String Yes A description of the view.
filters List of viewFilter [filter] Yes Filters created on the view.
hasFilters boolean Yes Flag representing if the view has filters.
id String Yes The ID of the view.
name String Yes The name of the view.
privileges viewPrivileges Yes Information about the user's privileges on the view.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewFilter type

Field Name Data Type Expected Description
autoRun boolean Yes Indicate the filter is auto run enabled
category viewCategory Yes The category of the filter
classifier classifier Yes The classifier of the filter
description String Yes The description of the filter
id String Yes The ID of the filter
name String Yes The name of the filter
public boolean Yes Indicate the filter is public or private
viewPrivileges type

Full set of view privileges

Field Name Data Type Expected Description
filter Boolean Yes Indicates the user can filter the view.
manage Boolean Yes Indicates the user can manage the view.
use Boolean Yes Indicates the user can use the view.

JSON Samples

Sample 1
Request URL
/v4/view?category=DOCUMENT
Response
{"views":[{"id":"301US2G_0005CT5AS000025","name":"DevelopmentDocumentsView","description":"All Development documents available to the user account","category":"DOCUMENT","classifier":"NONE","autoRun":false,"hasFilters":true,"privileges":{"use":true,"filter":true,"manage":false},"filters":[{"id":"301YW1Y_0006CH7ZW00002G","name":"Test Filter","description":"","category":"DOCUMENT","classifier":"NONE","autoRun":true,"public":true}]},{"id":"301YW1Y_0006CY7ZX000013","name":"SystemDocumentsAll","description":"All documents available to the user account","category":"DOCUMENT","classifier":"NONE","autoRun":false,"hasFilters":false,"privileges":{"use":true,"filter":false,"manage":false},"filters":null}]}

XML Samples

Sample 1
Request URL
/v4/view?category=DOCUMENT
Response
<views>
    <view>
        <id>301US2G_0005CT5AS000025</id>
        <name>DevelopmentDocumentsView</name>
        <description>All Development documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <autoRun>false</autoRun>
        <hasFilters>true</hasFilters>
        <filters>
            <filter>
                <id>301YW1Y_0006CH7ZW00002G</id>
                <name>Test Filter</name>
                <description/>
                <category>DOCUMENT</category>
                <classifier>NONE</classifier>
                <autoRun>true</autoRun>
                <public>true</public>
            </filter>
        </filters>
        <privileges>
            <use>true</use>
            <filter>true</filter>
            <manage>false</manage>
        </privileges>
    </view>
    <view>
        <id>301YW1Y_0006CY7ZX000013</id>
        <name>SystemDocumentsAll</name>
        <description>All documents available to the user account</description>
        <category>DOCUMENT</category>
        <classifier>NONE</classifier>
        <autoRun>false</autoRun>
        <hasFilters>false</hasFilters>
        <privileges>
            <use>true</use>
            <filter>false</filter>
            <manage>false</manage>
        </privileges>
    </view>
</views>

GET/v4/view/{id} Gets the view in the server that matches the ID. Inclues user privileges

Expand Operation / Collapse Operation

Gets the view in the server that matches the ID. Inclues user privileges

Available from version: 4.6.0

Call Properties

Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW.
Response
Content
view
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

classifier enumeration

Along with viewCategory, represents the type of view.

Constant Name Description
NONE Classifier for standard views (document, folder, folder content, and task)
LEARNMODE The classifier for learnmode view
RELATIONSHIP The classifier for relationship view
PROCESS Workflow process view
SUPERQUEUE A workflow super queue view
RECYCLE_DOCS The classifier for recycled documents (either all or my)
RECYCLE_FOLDERS The classifier for recycled folders (either all or my)
dataType enumeration

Data type for the column.

Constant Name Description
STRING
INTEGER
BOOLEAN
DATE
CUSTOM_PROPERTY
PRIV_STRING
DOUBLE
workflowItemState
taskStatus
taskType
taskCompletionType
folderStatus
folderContentType
digitalSignatureStatus
displayType enumeration

Visibility for the column.

Constant Name Description
HIDDEN
VISIBLE
operatorType enumeration

Operator for a search constraint.

Constant Name Description
NONE
EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
CONTAINS
STARTS_WITH
ENDS_WITH
NOT_EQUALS
IS_NULL
IS_NOT_NULL
DOES_NOT_CONTAIN
IN
NOT_IN
BETWEEN
NOT_BETWEEN
DOES_NOT_START_WITH
DOES_NOT_END_WITH
sortDirection enumeration

Sort direction for the column.

Constant Name Description
ASCENDING
DESCENDING
summaryFunction enumeration

Function for the summary field

Constant Name Description
AVERAGE
MEDIAN
MAXIMUM
MINIMUM
NUMERIC_MODE
TOTAL
COUNT_FUTURE
COUNT_PAST
NEXT
PREVIOUS
FIRST
LAST
LIST_COUNT
view type

Represents a view.

Field Name Data Type Expected Description
autoRun boolean Yes Whether the view is auto-run enabled.
category viewCategory Yes The category of the view.
classifier classifier Yes The classifier of the view.
columns List of viewColumn [column] Yes Columns displayed in the view.
description String Yes The description of the view.
filters List of viewFilter [filter] Yes Available filters.
id String Yes The ID of the view.
name String Yes The name of the view.
parentViewId String Yes The ID of the parent view when this is a filter.
privileges viewPrivileges Yes Information about the user's privileges on the view.
searchPrompts List of viewSearchPrompt [searchPrompt] Yes Available search prompts.
summaryColumns List of viewSummaryColumn [summaryColumn] Yes Information about a view column.
vslText String Yes The VSL text when this is a filter.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumn type

Field Name Data Type Expected Description
columnId String Yes
dataType dataType Yes
displayType displayType Yes
groupOrder Integer Yes
name String Yes
sortDirection sortDirection Yes
sortOrder Integer Yes
width Double Yes
viewFilter type

Field Name Data Type Expected Description
autoRun boolean Yes Indicate the filter is auto run enabled
category viewCategory Yes The category of the filter
classifier classifier Yes The classifier of the filter
description String Yes The description of the filter
id String Yes The ID of the filter
name String Yes The name of the filter
public boolean Yes Indicate the filter is public or private
viewPrivileges type

Full set of view privileges

Field Name Data Type Expected Description
filter Boolean Yes Indicates the user can filter the view.
manage Boolean Yes Indicates the user can manage the view.
use Boolean Yes Indicates the user can use the view.
viewSearchPrompt type

Field Name Data Type Expected Description
constraintId String Yes
fieldId Integer No The classifier-specific VSL field identifier if the search is not on a custom property field
message String Yes The prompt shown to the user for this search criteria
operatorId operatorType No The VSL search operator
propertyId String No The custom property identifier if the search is on a custom property field
typeListId String No The identifier of the document type list or folder type list if the search is on a type by a list
viewSummaryColumn type

Field Name Data Type Expected Description
columnId String Yes
filterValue String Yes
function summaryFunction Yes
identifierColumnId String No
label String Yes
sequence Integer Yes

JSON Samples

Sample 1
Request URL
/v4/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
{"id":"301YW1Y_0006CY7ZX000013","name":"Filter on a document view","description":"Filters documents between a user-specified range of date/times","category":"DOCUMENT","classifier":"NONE","autoRun":true,"vslText":"[Created] between <<Prompt: Created date between x and y>>","parentViewId":"301YW1Y_0006CY7ZX000010","privileges":{"use":true,"filter":false,"manage":false},"searchPrompts":[{"constraintId":"301YW1Y_0006CWHBX000013","message":"Created date between x and y","propertyId":"","fieldId":2,"typeListId":null,"operatorId":"BETWEEN"}],"filters":[],"columns":[{"columnId":"39","dataType":"STRING","displayType":"HIDDEN","name":"Details","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"columnId":"301YW1T_000693JRD00000L","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Coin Toss","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"summaryColumns":[{"function":"LIST_COUNT","label":"Heads Count","filterValue":"1","sequence":0,"columnId":"301YW1T_000693JRD00000L","identifierColumnId":null}]}

XML Samples

Sample 1
Request URL
/v4/view/301YW1Y_0006CY7ZX000013?category=DOCUMENT
Response
<view>
    <id>301YW1Y_0006CY7ZX000013</id>
    <name>Filter on a document view</name>
    <description>Filters documents between a user-specified range of date/times</description>
    <category>DOCUMENT</category>
    <classifier>NONE</classifier>
    <autoRun>true</autoRun>
    <vslText>[Created] between &lt;&lt;Prompt: Created date between x and y&gt;&gt;</vslText>
    <parentViewId>301YW1Y_0006CY7ZX000010</parentViewId>
    <searchPrompts>
        <searchPrompt>
            <constraintId>301YW1Y_0006CWHBX000013</constraintId>
            <message>Created date between x and y</message>
            <propertyId/>
            <fieldId>2</fieldId>
            <operatorId>BETWEEN</operatorId>
        </searchPrompt>
    </searchPrompts>
    <filters/>
    <columns>
        <column>
            <columnId>39</columnId>
            <dataType>STRING</dataType>
            <displayType>HIDDEN</displayType>
            <name>Details</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
        <column>
            <columnId>301YW1T_000693JRD00000L</columnId>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Coin Toss</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </column>
    </columns>
    <summaryColumns>
        <summaryColumn>
            <function>LIST_COUNT</function>
            <label>Heads Count</label>
            <filterValue>1</filterValue>
            <sequence>0</sequence>
            <columnId>301YW1T_000693JRD00000L</columnId>
        </summaryColumn>
    </summaryColumns>
    <privileges>
        <use>true</use>
        <filter>false</filter>
        <manage>false</manage>
    </privileges>
</view>

POST/v4/view/{id}/result Run view with ID and category on the server. This version provides an option to return additional...

Expand Operation / Collapse Operation

Run view with ID and category on the server. This version provides an option to return additional custom property columns found in the vslText, even when they are not provided in the columnSelectors.

Available from version: 1.0.0

Call Properties

Path Parameter
id The ID of the view to run
Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, and WORKFLOW.
Request
Content viewParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewParameters type

The viewParameters type provides the optional column selectors and VSL search string.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document views.
includeCPColFoundInVsl Boolean No Determines whether to include custom property columns that are found in VSL constraint but not found in request columns. The default value is false.
vslText String No The VSL search string. You can view more information about VSL in the help documentation at Manage Content > Configure > Content System > Set up Content system > Use VSL.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.

JSON Samples

Sample 1 - Returns the specified view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","includeCPColFoundInVsl":null,"columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}
Sample 2 - Returns all view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","includeCPColFoundInVsl":true,"columnSelectors":null}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"9","dataType":"BOOLEAN","displayType":"HIDDEN","name":"In Version Control","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"321YXD6_00005D6PH00000Q","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Invoice Amount","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":-1.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"},{"columnId":"9","value":"false"},{"columnId":"301YW1Y_0006GH9ZX000A95","value":"11100.00"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"},{"columnId":"9","value":"false"},{"columnId":"301YW1Y_0006GH9ZX000A95","value":"10200.00"}]}]}

XML Samples

Sample 1 - Returns the specified view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
<viewParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
</viewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>
Sample 2 - Returns all view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/result?category=DOCUMENT
Request
<viewParameters>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
    <includeCPColFoundInVsl>true</includeCPColFoundInVsl>
</viewParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>9</id>
            <dataType>BOOLEAN</dataType>
            <displayType>HIDDEN</displayType>
            <name>In Version Control</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>321YXD6_00005D6PH00000Q</id>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Invoice Amount</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>-1.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>301YW1Y_0006GH9ZX000A95</columnId>
                    <value>11100.00</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>301YW1Y_0006GH9ZX000A95</columnId>
                    <value>10200.00</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

POST/v4/view/{viewId}/filter/{filterId}/result Run view with ID and category on the server and apply the filter to it. This version provides an ...

Expand Operation / Collapse Operation

Run view with ID and category on the server and apply the filter to it. This version provides an option to return additional custom property columns found in the vslText, even when they are not provided in the columnSelectors.

Available from version: 1.0.0

Call Properties

Path Parameters
viewId The ID of the view to run.
filterId The ID of the filter to run
Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, and WORKFLOW.
Request
Content viewFilterParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewFilterParameters type

The viewFilterParameters type provides the optional column selectors and VSL search string as well as the list of search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document views.
includeCPColFoundInVsl Boolean No Determines whether to include custom property columns that are found in VSL constraint but not found in request columns. The default value is false.
runtimeVariables List of viewRuntimeVariable [runtimeVariable] No The list of constraint IDs and values for the prompted searches associated with the given filter.
vslText String No The VSL search string. You can view more information about VSL in the help documentation at Manage Content > Configure > Content System > Set up Content system > Use VSL.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.
viewRuntimeVariable type

The viewRuntimeVariable type provides the search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
constraintId String Yes The unique ID of the search constraint for a prompted search associated with the filter.
value String Yes For the prompted search, this is the value to search by. If this value is a date and time, the time must be in UTC. The clientTimeZoneOffset will not be applied.

JSON Samples

Sample 1 - Returns the specified view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","includeCPColFoundInVsl":false,"columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}],"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}
Sample 2 - Returns all view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","includeCPColFoundInVsl":true,"columnSelectors":null,"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"9","dataType":"BOOLEAN","displayType":"HIDDEN","name":"In Version Control","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"321YXD6_00005D6PH00000Q","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Invoice Amount","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":-1.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"},{"columnId":"9","value":"false"},{"columnId":"321YXD6_00005D6PH00000Q","value":"10200.00"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"},{"columnId":"9","value":"false"},{"columnId":"321YXD6_00005D6PH00000Q","value":"10500.00"}]}]}

XML Samples

Sample 1 - Returns the specified view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
    <includeCPColFoundInVsl>false</includeCPColFoundInVsl>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>
Sample 2 - Returns all view columns
Request URL
/v4/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
    <includeCPColFoundInVsl>true</includeCPColFoundInVsl>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>9</id>
            <dataType>BOOLEAN</dataType>
            <displayType>HIDDEN</displayType>
            <name>In Version Control</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>321YXD6_00005D6PH00000Q</id>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Invoice Amount</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>-1.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>321YXD6_00005D6PH00000Q</columnId>
                    <value>10200.00</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>321YXD6_00005D6PH00000Q</columnId>
                    <value>10500.00</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

View (Version 5)

POST/v5/view/{viewId}/filter/{filterId}/result Run view with ID and category on the server and apply the filter to it. This version provides an ...

Expand Operation / Collapse Operation

Run view with ID and category on the server and apply the filter to it. This version provides an option to override the existing filter rule for the view.

Available from version: 6.4.0

Call Properties

Path Parameters
viewId The ID of the view to run.
filterId The ID of the filter to run
Query Parameter
category viewCategory Has 5 possible values: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, and WORKFLOW.
Request
Content viewFilterParameters
Content-Types
  • application/xml
  • application/json
Response
Content
viewResults
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

columnDataType enumeration

The columnDataType enumeration provides the possible values for the type of data in a column.

Constant Name Description
STRING The column contains an alphanumeric string.
INTEGER The column contains an integer value.
BOOLEAN The column contains a boolean true or false value.
DATE The column contains a date value.
CUSTOM_PROPERTY The column contains a property value.
PRIV_STRING The column contains a privilege string.
DOUBLE The column contains a 64-bit IEEE 754 floating-point number.
workflowItemState The column indicates the workflow item state. The workflowItemState enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskStatus The column indicates the current status of the task. The taskStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskType The column indicates the task type. The taskType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
taskCompletionType The column indicates the method for completing a task. The taskCompletionType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderStatus The column indicates whether the folder status is marked as active or inactive. The folderStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
folderContentType The column indicates the content type of the folder item. The folderContentType enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
digitalSignatureStatus The column indicates the status of a document regarding a digital signature. The digitalSignatureStatus enumeration contains the possible values that the POST: /view/{id}/result call can return for a column value.
columnDisplayType enumeration

The columnDisplayType enumeration provides the possible values for the display type, which reflects whether the system shows or hides the column in a view.

Constant Name Description
HIDDEN The column is hidden in the view.
VISIBLE The column is visible in the view.
NEVER The column is never visible in the view.
columnSortDirection enumeration

The columnSortDirection enumeration provides the possible values for the sort order that the system uses to display a column.

Constant Name Description
ASCENDING Indicates that the column sorts in ascending order, such as A-Z or 1-10, for example.
DESCENDING Indicates that the column sorts in descending order, such as Z-A or 10-1, for example.
viewCategory enumeration

The viewCategory enumeration provides the possible values for the general type of view.

Constant Name Description
DOCUMENT The view is the document view type.
FOLDER The view is the folder view type.
TASK The view is the task view type.
WORKFLOW The view is the workflow view type. Workflow views are available at the queue, process, and superqueue levels.
FOLDER_CONTENT The view is the folder content view type.
viewColumnSelector type

The viewColumnSelector type provides the column ID and sorting options for the selected column.

Field Name Data Type Expected Description
id String Yes The column number that ImageNow assigns to the column. If the column contains property values, this is the unique ID of the property.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
viewFilterParameters type

The viewFilterParameters type provides the optional column selectors and VSL search string as well as the list of search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
clientTimeZoneOffset String No The client time zone represented as an ISO 8601 offset from UTC (e.g., -06:00).
columnSelectors List of viewColumnSelector [columnSelector] No The list of columns to be returned in the view results. The ID column that uniquely identifies each result must be included in this list. For example, the docID column is required for document views.
includeCPColFoundInVsl Boolean No Determines whether to include custom property columns that are found in VSL constraint but not found in request columns. The default value is false.
overrideFilterRule Boolean No Determines whether to override the existing filter rule for the view. The default value is false.
runtimeVariables List of viewRuntimeVariable [runtimeVariable] No The list of constraint IDs and values for the prompted searches associated with the given filter.
vslText String No The VSL search string. You can view more information about VSL in the help documentation at Manage Content > Configure > Content System > Set up Content system > Use VSL.
viewResultColumn type

The viewResultColumn type provides detailed information about each column in the view.

Field Name Data Type Expected Description
dataType columnDataType Yes The type of data that the column holds. The columnDataType enumeration contains the possible values for this data element.
displayType columnDisplayType Yes Indicates whether the column is visible or hidden in the view. The columnDisplayType enumeration contains the possible values for this data element.
groupOrder Integer Yes This is the hierarchical order number for the column if the view uses the column to group the view results. A value of 0 (zero) means that the column is not a group column; 1 means that the results are sorted on this column as a group with highest precedence; 2 means that results are sorted on this column as a group with second-highest precedence, and so on.
id String Yes The column number that the system assigns to the column. If the column contains property values, this is the unique ID of the property.
name String Yes The label for the column.
sortDirection columnSortDirection Yes Indicates whether the column sorts in ascending or descending order. The columnSortDirection enumeration contains the possible values for this data element.
sortOrder Integer Yes The hierarchical sort order for the column. A value of 0 (zero) means that results are not sorted on this column; 1 means that the results are sorted on this column with highest precedence; 2 means that results are sorted on this column with second-highest precedence, and so on.
width Double Yes The width of the column in characters. The unit of width is the underscore symbol. A value of -1 indicates that the width is the number of characters in the column label.
viewResultRow type

The viewResultRow type provides a list of column ID and value pairs to populate the fields for a row.

Field Name Data Type Expected Description
fields List of viewResultRowField [field] Yes A list of column ID and value pairs for a row of a view result.
viewResultRowField type

The viewResultRowField type is a subtype to the viewResultRow type that provides the column IDs and column values for a row.

Field Name Data Type Expected Description
columnId String Yes The ID for the column in the row.
value String Yes The value of the column.
viewResults type

The viewResults type provides the list of result rows and columns and indicates whether there are additional results that Integration Server did not return.

Field Name Data Type Expected Description
hasMore boolean Yes Indicates whether there are more results than what Integration Server returned.
resultColumns List of viewResultColumn [resultColumn] Yes A list of the result columns for the view.
resultRows List of viewResultRow [resultRow] Yes A list of the result rows for the view.
viewRuntimeVariable type

The viewRuntimeVariable type provides the search constraint IDs and values for a prompted search.

Field Name Data Type Expected Description
constraintId String Yes The unique ID of the search constraint for a prompted search associated with the filter.
value String Yes For the prompted search, this is the value to search by. If this value is a date and time, the time must be in UTC. The clientTimeZoneOffset will not be applied.

JSON Samples

Sample 1 - Returns the specified view columns
Request URL
/v5/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","includeCPColFoundInVsl":false,"overrideFilterRule":false,"columnSelectors":[{"id":"8","sortOrder":0,"sortDirection":"ASCENDING"}],"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"}]}]}
Sample 2 - Returns all view columns
Request URL
/v5/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
{"vslText":"[drawer] = 'Invoices' AND ({Invoice Amount} > '10000' OR [creationUser] = 'jdoe')","clientTimeZoneOffset":"-06:00","includeCPColFoundInVsl":true,"overrideFilterRule":true,"columnSelectors":null,"runtimeVariables":[{"constraintId":"301YW1Y_0006JN5ZX000937","value":"2013-01-01 08:30:00.0"}]}
Response
{"hasMore":false,"resultColumns":[{"id":"8","dataType":"STRING","displayType":"VISIBLE","name":"Document ID","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"9","dataType":"BOOLEAN","displayType":"HIDDEN","name":"In Version Control","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":20.0},{"id":"321YXD6_00005D6PH00000Q","dataType":"CUSTOM_PROPERTY","displayType":"VISIBLE","name":"Invoice Amount","sortOrder":0,"sortDirection":"ASCENDING","groupOrder":0,"width":-1.0}],"resultRows":[{"fields":[{"columnId":"8","value":"301YW1Y_0006GH9ZX000A95"},{"columnId":"9","value":"false"},{"columnId":"321YXD6_00005D6PH00000Q","value":"10200.00"}]},{"fields":[{"columnId":"8","value":"301YW1Y_0009IK4ZX000J89"},{"columnId":"9","value":"false"},{"columnId":"321YXD6_00005D6PH00000Q","value":"10500.00"}]}]}

XML Samples

Sample 1 - Returns the specified view columns
Request URL
/v5/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <columnSelectors>
        <columnSelector>
            <id>8</id>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
        </columnSelector>
    </columnSelectors>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
    <includeCPColFoundInVsl>false</includeCPColFoundInVsl>
    <overrideFilterRule>false</overrideFilterRule>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>
Sample 2 - Returns all view columns
Request URL
/v5/view/301YW1Y_0006CY7ZX000013/filter/301YW1Y_0006CH7ZW00002G/result?category=DOCUMENT
Request
<viewFilterParameters>
    <runtimeVariables>
        <runtimeVariable>
            <constraintId>301YW1Y_0006JN5ZX000937</constraintId>
            <value>2013-01-01 08:30:00.0</value>
        </runtimeVariable>
    </runtimeVariables>
    <vslText>[drawer] = 'Invoices' AND ({Invoice Amount} &gt; '10000' OR [creationUser] = 'jdoe')</vslText>
    <clientTimeZoneOffset>-06:00</clientTimeZoneOffset>
    <includeCPColFoundInVsl>true</includeCPColFoundInVsl>
    <overrideFilterRule>true</overrideFilterRule>
</viewFilterParameters>
Response
<viewResults>
    <resultColumns>
        <resultColumn>
            <id>8</id>
            <dataType>STRING</dataType>
            <displayType>VISIBLE</displayType>
            <name>Document ID</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>9</id>
            <dataType>BOOLEAN</dataType>
            <displayType>HIDDEN</displayType>
            <name>In Version Control</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>20.0</width>
        </resultColumn>
        <resultColumn>
            <id>321YXD6_00005D6PH00000Q</id>
            <dataType>CUSTOM_PROPERTY</dataType>
            <displayType>VISIBLE</displayType>
            <name>Invoice Amount</name>
            <sortOrder>0</sortOrder>
            <sortDirection>ASCENDING</sortDirection>
            <groupOrder>0</groupOrder>
            <width>-1.0</width>
        </resultColumn>
    </resultColumns>
    <resultRows>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0006GH9ZX000A95</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>321YXD6_00005D6PH00000Q</columnId>
                    <value>10200.00</value>
                </field>
            </fields>
        </resultRow>
        <resultRow>
            <fields>
                <field>
                    <columnId>8</columnId>
                    <value>301YW1Y_0009IK4ZX000J89</value>
                </field>
                <field>
                    <columnId>9</columnId>
                    <value>false</value>
                </field>
                <field>
                    <columnId>321YXD6_00005D6PH00000Q</columnId>
                    <value>10500.00</value>
                </field>
            </fields>
        </resultRow>
    </resultRows>
    <hasMore>false</hasMore>
</viewResults>

WorkflowItem (Version 1)

POST/v1/workflowItem/ Adds the document or folder to a workflow

Expand Operation / Collapse Operation

Adds the document or folder to a workflow

Available from version: 1.0.0

Call Properties

Request
Content workflowItem
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable
Additional Header
Location The URI location of the newly created workflow item.

Call Types and Enumerations

workflowItem type

Describes a workflow item

Field Name Data Type Expected Description
itemPriority workflowItemPriority Yes The priority of the document or folder to be added to workflow.
itemType workflowItemType Yes The type of the item to be added to workflow.
objectId String Yes The ID of the document or folder to be added to workflow.
workflowQueueId String Yes The ID of the workflow queue that the item will be added to.
workflowItemPriority enumeration

Represents the priority of item in a workflow.

Constant Name Description
LOW The object has low priority.
MEDIUM The object has medium priority.
HIGH The object has high priority.
workflowItemType enumeration

Represents the type of item in a workflow.

Constant Name Description
DOCUMENT The item has exactly 1 document.
FOLDER The item has exactly 1 folder.

JSON Samples

Sample 1
Request URL
/v1/workflowItem
Request
{"objectId":"301YW2G_0006YVLZ1000011","itemType":"DOCUMENT","workflowQueueId":"301YW2G_0006YMLZ100001R","itemPriority":"MEDIUM"}

XML Samples

Sample 1
Request URL
/v1/workflowItem
Request
<workflowItem>
    <objectId>301YW2G_0006YVLZ1000011</objectId>
    <itemType>DOCUMENT</itemType>
    <workflowQueueId>301YW2G_0006YMLZ100001R</workflowQueueId>
    <itemPriority>MEDIUM</itemPriority>
</workflowItem>

DELETE/v1/workflowItem/{id} Removes an item from workflow, leaving the attached object untouched.

Expand Operation / Collapse Operation

Removes an item from workflow, leaving the attached object untouched.

Available from version: 1.0.0

Call Properties

Query Parameter
workflowQueueId The current workflow queue the item is.
Response
Content
None
Content-Types
  • application/xml
  • application/json

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301EV3Y_0005GLQE900002B?workflowQueueId=301YW2G_0006YTLZ100000C

XML Samples

Sample 1
Request URL
/v1/workflowItem/301EV3Y_0005GLQE900002B?workflowQueueId=301YW2G_0006YTLZ100000C

GET/v1/workflowItem/{id} Gets the workflow queue item stored in the ImageNow server.

Expand Operation / Collapse Operation

Gets the workflow queue item stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Response
Content
workflowItem
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

state enumeration

Describes a workflow item's state

Constant Name Description
IDLE Workflow item is idle
WORKING Workflow item is being worked on
ON_HOLD Workflow item is on hold
PENDING Workflow item is pending
FINISHED Workflow item is finished
COMPLETED Workflow item is completed
WAITING_FOR_ROUTING Workflow item is waiting for routing
WAITING_FOR_SIBLINGS Workflow item is waiting for siblings
WAITING_FOR_INBOUND_ACTION Workflow item is waiting for an inbound action
ERROR Workflow item has an error
stateDetail enumeration

Detail type explaining how a workflow item got into a state

Constant Name Description
UNKNOWN Unknown state detail
ROUTED_IN Workflow item routed in
ROUTED_OUT Workflow item routed out
MARKED_ROUTABLE Workflow item marked routable
CREATED Workflow item created
CANCELLED Workflow item cancelled
PUT_ON_HOLD Workflow item put on hold
SET_TO_WORK Workflow item set to work
FINISHED Workflow item finished
SPLIT Workflow item was split
JOINED Workflow item was joined
PRIORITY_CHANGED Workflow item's priority changed
RECALLED Workflow item recalled
RESET_POST_INBOUND Workflow item state reset at post inbound action
STATE_SETBY_GET_NEXT Workflow item state set by GetNext
DELAYED_ROUTE_CONDITION_NOT_MET Workflow item condition not met for delayed route
DELAYED_ROUTE_FAILED Workflow item delayed route failed
DELETED Workflow item deleted
RESTORED Workflow item restored
CALL_WAITING Web service call made
CALL_PENDING Web service call pending
PROPERTY_SELECTION_FAILED Web service parameter selection failed
PARAMETER_MISMATCH Web service parameter map is invalid
INVALID_OBJECT Web service object is invalid
CALL_FAILED Web service call failed
LOCK_CLEANUP State was reset
stateInfo type

Represents a workflow item's state info

Field Name Data Type Expected Description
state state Yes The workflow item's state
stateDetail stateDetail Yes Details about the workflow item's state
stateStartTime Long Yes The time the workflow item entered this state
stateUserId String Yes The id of the user that put the workflow item in this state
stateUsername String Yes The username of the user that put the workflow item in this state
totalHoldTime Integer Yes The total time the workflow item has been on hold (in seconds)
workflowItem type

Represents a workflow item

Field Name Data Type Expected Description
childGenerationNum Integer Yes The child item's generation number
completedTime Long No The completion time
creationTime Long Yes The time of creation
creationUserId String Yes The id of the creation user
creationUserName String Yes The username of the creation user
destinationWorkflowQueueId String No The destination workflow queue id
id String Yes Workflow item id
isChildItem boolean Yes Determines if the item is a child item
objectId String Yes The id of the object the workflow item references
parentItemId String No The id of the item parent
priority workflowItemPriority Yes Workflow item priority
stateInfo stateInfo Yes Information about the state of the workflow item
type workflowItemType Yes Workflow item type
workflowQueueId String Yes The id of the workflow queue the item is in
workflowQueueName String Yes The name of the workflow queue the item is in
workflowQueueSequenceNum Integer Yes The sequence number in the workflow queue
workflowQueueStartTime Long Yes The time the workflow item was started
workflowQueueStartUserId String Yes The id of the user that started the workflow item
workflowQueueStartUsername String Yes The username of the user that started the workflow item
workflowItemPriority enumeration

Represents the priority of item in a workflow.

Constant Name Description
LOW The object has low priority.
MEDIUM The object has medium priority.
HIGH The object has high priority.
workflowItemType enumeration

Represents the type of item in a workflow.

Constant Name Description
DOCUMENT The item has exactly 1 document.
FOLDER The item has exactly 1 folder.

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YTLZ100000C
Response
{"id":"301YW2G_0006YTLZ100000C","type":"DOCUMENT","objectId":"301YW2G_0006YRLZ100005Y","priority":"LOW","isChildItem":false,"parentItemId":null,"childGenerationNum":0,"creationUserId":"301YVBK_0000736ZJ000005","creationUserName":"User1","creationTime":1329333384067,"completedTime":null,"workflowQueueSequenceNum":1,"workflowQueueId":"301YW2G_0006YRLZ100005X","workflowQueueName":"301YW2G_0006YLLZ000000C","workflowQueueStartUserId":"301YVBK_0000736ZJ000005","workflowQueueStartUsername":"User1","workflowQueueStartTime":1329333384067,"stateInfo":{"state":"IDLE","stateDetail":"CREATED","stateStartTime":1329333384067,"stateUserId":"301YVBK_0000736ZJ000005","stateUsername":"User1","totalHoldTime":0},"destinationWorkflowQueueId":null}

XML Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YTLZ100000C
Response
<workflowItem>
    <id>301YW2G_0006YTLZ100000C</id>
    <type>DOCUMENT</type>
    <objectId>301YW2G_0006YRLZ100005Y</objectId>
    <priority>LOW</priority>
    <isChildItem>false</isChildItem>
    <childGenerationNum>0</childGenerationNum>
    <creationUserId>301YVBK_0000736ZJ000005</creationUserId>
    <creationUserName>User1</creationUserName>
    <creationTime>1329333384067</creationTime>
    <workflowQueueSequenceNum>1</workflowQueueSequenceNum>
    <workflowQueueId>301YW2G_0006YRLZ100005X</workflowQueueId>
    <workflowQueueName>301YW2G_0006YLLZ000000C</workflowQueueName>
    <workflowQueueStartUserId>301YVBK_0000736ZJ000005</workflowQueueStartUserId>
    <workflowQueueStartUsername>User1</workflowQueueStartUsername>
    <workflowQueueStartTime>1329333384067</workflowQueueStartTime>
    <stateInfo>
        <state>IDLE</state>
        <stateDetail>CREATED</stateDetail>
        <stateStartTime>1329333384067</stateStartTime>
        <stateUserId>301YVBK_0000736ZJ000005</stateUserId>
        <stateUsername>User1</stateUsername>
        <totalHoldTime>0</totalHoldTime>
    </stateInfo>
</workflowItem>

GET/v1/workflowItem/{id}/backRoute Gets the back workflow queue route for the workflow item.

Expand Operation / Collapse Operation

Gets the back workflow queue route for the workflow item.

Available from version: 1.0.0

Call Properties

Response
Content
List of route [route]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

route type

Represents an available workflow queue route

Field Name Data Type Expected Description
destinationQueueId String Yes The ID of the destination queue.
destinationQueueName String Yes The name of the destination queue.

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301YW22_0003G6S0L00001H/backRoute
Response
{"routes":[{"destinationQueueId":"301YW23_0003G1S0L000017","destinationQueueName":"Queue 4"}]}

XML Samples

Sample 1
Request URL
/v1/workflowItem/301YW22_0003G6S0L00001H/backRoute
Response
<routes>
    <route>
        <destinationQueueId>301YW23_0003G1S0L000017</destinationQueueId>
        <destinationQueueName>Queue 4</destinationQueueName>
    </route>
</routes>

GET/v1/workflowItem/{id}/history Gets the history for the workflow item

Expand Operation / Collapse Operation

Gets the history for the workflow item

Available from version: 6.5.0

Call Properties

Response
Content
List of historyEntry [historyEntry]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

historyEntry type

Represents a history entry

Field Name Data Type Expected Description
holdReasonText String Yes If placed on hold, the reason provided by the user.
queueName String Yes The queue the item was in when it's state was changed.
reasonText String Yes The reason the item's state was changed.
startTime Long Yes The time the item's state was updated.
state state Yes The state of the item.
userName String Yes The user who updated the item's state.
state enumeration

Describes a workflow item's state

Constant Name Description
IDLE Workflow item is idle
WORKING Workflow item is being worked on
ON_HOLD Workflow item is on hold
PENDING Workflow item is pending
FINISHED Workflow item is finished
COMPLETED Workflow item is completed
WAITING_FOR_ROUTING Workflow item is waiting for routing
WAITING_FOR_SIBLINGS Workflow item is waiting for siblings
WAITING_FOR_INBOUND_ACTION Workflow item is waiting for an inbound action
ERROR Workflow item has an error

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301YW22_0003G6S0L00001H/history
Response
{"history":[{"state":"IDLE","userName":"inadmin","startTime":1391793376460,"holdReasonText":"","reasonText":"Updated item state from Perceptive Experience","queueName":null},{"state":"WORKING","userName":"inadmin","startTime":1391792376460,"holdReasonText":"","reasonText":"Changed state to working.","queueName":null}]}

XML Samples

Sample 1
Request URL
/v1/workflowItem/301YW22_0003G6S0L00001H/history
Response
<history>
    <historyEntry>
        <state>IDLE</state>
        <userName>inadmin</userName>
        <startTime>1391793376460</startTime>
        <holdReasonText/>
        <reasonText>Updated item state from Perceptive Experience</reasonText>
    </historyEntry>
    <historyEntry>
        <state>WORKING</state>
        <userName>inadmin</userName>
        <startTime>1391792376460</startTime>
        <holdReasonText/>
        <reasonText>Changed state to working.</reasonText>
    </historyEntry>
</history>

PUT/v1/workflowItem/{id}/hold Puts a workflow item on hold.

Expand Operation / Collapse Operation

Puts a workflow item on hold.

Available from version: 1.0.0

Call Properties

Request
Content holdInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

holdInfo type

Hold to place on a workflow item

Field Name Data Type Expected Description
comments String No Any comment about holding this item.
holdReasonId String No The ID of the reason code for putting item on hold.
holdTime Long No The time the hold should expire in GMT
workflowQueueId String Yes The ID of the workflow queue that holds the workflow item
workflowQueueName String No The name of the workflow queue that holds the workflow item

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YVLZ1000027/hold
Request
{"workflowQueueId":"301YW2H_000735SNP000019","workflowQueueName":"Report Review","holdTime":1330035331817,"holdReasonId":"301YW2H_000735SNP000005","comments":"Item is on hold."}

XML Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YVLZ1000027/hold
Request
<holdInfo>
    <workflowQueueId>301YW2H_000735SNP000019</workflowQueueId>
    <workflowQueueName>Report Review</workflowQueueName>
    <holdTime>1330035331817</holdTime>
    <holdReasonId>301YW2H_000735SNP000005</holdReasonId>
    <comments>Item is on hold.</comments>
</holdInfo>

POST/v1/workflowItem/{id}/routingAction Create a routing action for a workflow queue item.

Expand Operation / Collapse Operation

Create a routing action for a workflow queue item.

Available from version: 1.0.0

Call Properties

Request
Content routingAction
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

routeType enumeration

Represents the type of a route in a workflow.

Constant Name Description
MANUAL
AUTO
CONDITIONAL
PARALLEL
CONDITIONAL_PARALLEL
PEER
BALANCED
routingAction type

Describes a routing action to perform on a workflow item

Field Name Data Type Expected Description
destinationWorkflowQueueId String Yes The destination queue ID
originWorkflowQueueId String Yes The ID of the queue.
originWorkflowQueueName String Yes The name of the queue.
reason String Yes The reason for routing
routeType routeType Yes Describes the type of route this is

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
{"originWorkflowQueueId":"301YW2G_0006YSLZ100002G","originWorkflowQueueName":"301YW2G_0006YNLZ1000013","destinationWorkflowQueueId":"301YW2G_0006YSLZ100002J","routeType":"AUTO","reason":"Routing test"}

XML Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
<routingAction>
    <originWorkflowQueueId>301YW2G_0006YSLZ100002G</originWorkflowQueueId>
    <originWorkflowQueueName>301YW2G_0006YNLZ1000013</originWorkflowQueueName>
    <destinationWorkflowQueueId>301YW2G_0006YSLZ100002J</destinationWorkflowQueueId>
    <routeType>AUTO</routeType>
    <reason>Routing test</reason>
</routingAction>

PUT/v1/workflowItem/{id}/state Updates the state of a workflow queue item stored in the ImageNow server.

Expand Operation / Collapse Operation

Updates the state of a workflow queue item stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Request
Content stateInfo
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

state enumeration

A workflow item's state

Constant Name Description
PENDING The workflow item is pending
IDLE The workflow item is idle
WORKING The workflow item is being worked on
stateInfo type

Describes a state update for a workflow item

Field Name Data Type Expected Description
comments String No Any comments about the state change
state state Yes The state to update the workflow item to

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YVLZ1000027/state
Request
{"state":"WORKING","comments":"Changed state to working."}

XML Samples

Sample 1
Request URL
/v1/workflowItem/301YW2G_0006YVLZ1000027/state
Request
<stateInfo>
    <state>WORKING</state>
    <comments>Changed state to working.</comments>
</stateInfo>

GET/v1/workflowItem/{id}/upstreamRoute Gets the upstream workflow queue routes for the workflow item.

Expand Operation / Collapse Operation

Gets the upstream workflow queue routes for the workflow item.

Available from version: 1.0.0

Call Properties

Response
Content
List of route [route]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

route type

Represents an available workflow queue route

Field Name Data Type Expected Description
destinationQueueId String Yes The ID of the destination queue.
destinationQueueName String Yes The name of the destination queue.

JSON Samples

Sample 1
Request URL
/v1/workflowItem/301YW22_0003G6S0L00001H/upstreamRoute
Response
{"routes":[{"destinationQueueId":"301YW23_0003G1S0L000017","destinationQueueName":"Queue 4"},{"destinationQueueId":"301YW23_0003G1S0L0A4D87","destinationQueueName":"Queue 5"}]}

XML Samples

Sample 1
Request URL
/v1/workflowItem/301YW22_0003G6S0L00001H/upstreamRoute
Response
<routes>
    <route>
        <destinationQueueId>301YW23_0003G1S0L000017</destinationQueueId>
        <destinationQueueName>Queue 4</destinationQueueName>
    </route>
    <route>
        <destinationQueueId>301YW23_0003G1S0L0A4D87</destinationQueueId>
        <destinationQueueName>Queue 5</destinationQueueName>
    </route>
</routes>

WorkflowItem (Version 2)

POST/v2/workflowItem/{id}/routingAction Create a routing action for a workflow queue item.

Expand Operation / Collapse Operation

Create a routing action for a workflow queue item.

Available from version: 1.0.0

Call Properties

Request
Content routingAction
Content-Types
  • application/xml
  • application/json
Response
Content
None
Content-Type Not Applicable

Call Types and Enumerations

routeType enumeration

Represents the type of a route in a workflow.

Constant Name Description
MANUAL A manual route.
AUTO A sequential auto route.
CONDITIONAL A conditional route.
PARALLEL A parallel route.
CONDITIONAL_PARALLEL A conditional parallel route.
PEER A peer route between sub queues.
BALANCED A load balanced route.
AD_HOC_PARALLEL An ad hoc parallel route.
BACK A route back to the previous queue.
routingAction type

Describes a routing action to perform on a workflow item

Field Name Data Type Expected Description
destinationWorkflowQueueIds List of String [destinationWorkflowQueueId] No The destination queue ID for manual, peer, and ad hoc parallel routes. Multiple queue IDs may only be specified for ad hoc parallel routes.
originWorkflowQueueId String No The ID of the queue. Optional if the queue name is provided.
originWorkflowQueueName String No The name of the queue. Optional if the queue ID is provided.
reason String Yes The reason for routing.
routeType routeType Yes The routeType enumeration represents the type of a route in a workflow.

JSON Samples

Sample 1 - Create a routing action for a workflow queue item.
Request URL
/v2/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
{"originWorkflowQueueId":"301YW2G_0006YSLZ100002G","originWorkflowQueueName":null,"routeType":"MANUAL","reason":"Manual routing test","destinationWorkflowQueueIds":["301YW2G_0006YSLZ100002J"]}
Sample 2 - Create a parallel routing action for a workflow queue item.
Request URL
/v2/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
{"originWorkflowQueueId":null,"originWorkflowQueueName":"Test Queue","routeType":"PARALLEL","reason":"Parallel routing test","destinationWorkflowQueueIds":null}
Sample 3 - Create an ad hoc parallel routing action for a workflow queue item.
Request URL
/v2/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
{"originWorkflowQueueId":"301YW2G_0006YSLZ100002G","originWorkflowQueueName":"Test Queue","routeType":"AD_HOC_PARALLEL","reason":"Ad hoc parallel routing test","destinationWorkflowQueueIds":["301YW2G_0006YSLZ100002J","301YW2G_0006YSLZ10BH34A"]}

XML Samples

Sample 1 - Create a routing action for a workflow queue item.
Request URL
/v2/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
<routingAction>
    <originWorkflowQueueId>301YW2G_0006YSLZ100002G</originWorkflowQueueId>
    <destinationWorkflowQueueIds>
        <destinationWorkflowQueueId>301YW2G_0006YSLZ100002J</destinationWorkflowQueueId>
    </destinationWorkflowQueueIds>
    <routeType>MANUAL</routeType>
    <reason>Manual routing test</reason>
</routingAction>
Sample 2 - Create a parallel routing action for a workflow queue item.
Request URL
/v2/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
<routingAction>
    <originWorkflowQueueName>Test Queue</originWorkflowQueueName>
    <routeType>PARALLEL</routeType>
    <reason>Parallel routing test</reason>
</routingAction>
Sample 3 - Create an ad hoc parallel routing action for a workflow queue item.
Request URL
/v2/workflowItem/301YW2G_0006YVLZ1000027/routingAction
Request
<routingAction>
    <originWorkflowQueueId>301YW2G_0006YSLZ100002G</originWorkflowQueueId>
    <originWorkflowQueueName>Test Queue</originWorkflowQueueName>
    <destinationWorkflowQueueIds>
        <destinationWorkflowQueueId>301YW2G_0006YSLZ100002J</destinationWorkflowQueueId>
        <destinationWorkflowQueueId>301YW2G_0006YSLZ10BH34A</destinationWorkflowQueueId>
    </destinationWorkflowQueueIds>
    <routeType>AD_HOC_PARALLEL</routeType>
    <reason>Ad hoc parallel routing test</reason>
</routingAction>

WorkflowProcessManagement (Version 1)

GET/v1/management/workflowProcess Retrieves all workflow processes that the user can manage.

Expand Operation / Collapse Operation

Retrieves all workflow processes that the user can manage.

Available from version: 1.0.0

Call Properties

Query Parameter
departmentId (optional) ID of the department to retrieve workflow processes for.
Response
Content
List of workflowProcess [workflowProcess]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

workflowProcess type

Represents a workflow process that can be managed.

Field Name Data Type Expected Description
departmentId String Yes The unique ID of the process's department.
departmentName String Yes The name of the process's department.
description String Yes The description of the process.
id String Yes The unique ID of the process.
name String Yes The name of the process.

JSON Samples

Sample 1
Request URL
/v1/management/workflowProcess?departmentId=321YZ9P_00009GX6000000J
Response
{"workflowProcesses":[{"id":"321YZ9P_0000CFZ7100000E","name":"Process 1","description":"Process 1 description.","departmentId":"321YZ9P_00009GX6000000J","departmentName":"HR"},{"id":"321YZB5_0000MW0D7000004","name":"Process 2","description":"Process 2 description.","departmentId":"321YZ9P_00009GX6000000J","departmentName":"Receipts"}]}

XML Samples

Sample 1
Request URL
/v1/management/workflowProcess?departmentId=321YZ9P_00009GX6000000J
Response
<workflowProcesses>
    <workflowProcess>
        <id>321YZ9P_0000CFZ7100000E</id>
        <name>Process 1</name>
        <description>Process 1 description.</description>
        <departmentId>321YZ9P_00009GX6000000J</departmentId>
        <departmentName>HR</departmentName>
    </workflowProcess>
    <workflowProcess>
        <id>321YZB5_0000MW0D7000004</id>
        <name>Process 2</name>
        <description>Process 2 description.</description>
        <departmentId>321YZ9P_00009GX6000000J</departmentId>
        <departmentName>Receipts</departmentName>
    </workflowProcess>
</workflowProcesses>

WorkflowQueue (Version 1)

GET/v1/workflowQueue/ Gets the specified set of workflow queues for the user stored in the server.

Expand Operation / Collapse Operation

Gets the specified set of workflow queues for the user stored in the server.

Available from version: 1.0.0

Call Properties

Query Parameter
access access (optional) Filter queues by user access
Response
Content
List of workflowQueue [workflowQueue]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

access enumeration

Represents the access to queues a user can have.

Constant Name Description
ALL The access for the queues a user can add or process items
PROCESS The access for queues a user can process items in
ADD The access for queues a user can add items to
workflowQueue type

Represents a workflow queue

Field Name Data Type Expected Description
id String Yes The ID of the queue.
name String Yes The name of the queue.
onHoldReasonListId String No
processId String Yes The ID of this queue's process
processName String Yes The name of this queue's process.

JSON Samples

Sample 1
Request URL
/v1/workflowQueue
Response
{"workflowQueues":[{"name":"Queue 1","id":"301YW1Z_0003DBRLH000001","onHoldReasonListId":null,"processName":"Process","processId":"301YW1Z_0003DPRLH000001"},{"name":"Queue 2","id":"301YW22_0003G6S0L000013","onHoldReasonListId":null,"processName":"Process","processId":"301YW1Z_0003DPRLH000001"},{"name":"Queue 3","id":"301YW22_0003G6S0L00001H","onHoldReasonListId":null,"processName":"Process","processId":"301YW1Z_0003DPRLH000001"}]}

XML Samples

Sample 1
Request URL
/v1/workflowQueue
Response
<workflowQueues>
    <workflowQueue>
        <name>Queue 1</name>
        <id>301YW1Z_0003DBRLH000001</id>
        <processName>Process</processName>
        <processId>301YW1Z_0003DPRLH000001</processId>
    </workflowQueue>
    <workflowQueue>
        <name>Queue 2</name>
        <id>301YW22_0003G6S0L000013</id>
        <processName>Process</processName>
        <processId>301YW1Z_0003DPRLH000001</processId>
    </workflowQueue>
    <workflowQueue>
        <name>Queue 3</name>
        <id>301YW22_0003G6S0L00001H</id>
        <processName>Process</processName>
        <processId>301YW1Z_0003DPRLH000001</processId>
    </workflowQueue>
</workflowQueues>

GET/v1/workflowQueue/{id} Gets the workflow queue stored in the ImageNow server.

Expand Operation / Collapse Operation

Gets the workflow queue stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Response
Content
workflowQueue
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

workflowQueue type

Represents a workflow queue

Field Name Data Type Expected Description
id String Yes The ID of the queue.
name String Yes The name of the queue.
onHoldReasonListId String Yes
processId String Yes The ID of this queue's process
processName String Yes The name of this queue's process.

JSON Samples

Sample 1
Request URL
/v1/workflowQueue/301YW22_0003G6S0L00001H
Response
{"name":"Queue 3","id":"301YW22_0003G6S0L00001H","onHoldReasonListId":"301YW28_000C16P9300000L","processName":"Process","processId":"301YW1Z_0003DPRLH000001"}

XML Samples

Sample 1
Request URL
/v1/workflowQueue/301YW22_0003G6S0L00001H
Response
<workflowQueue>
    <name>Queue 3</name>
    <id>301YW22_0003G6S0L00001H</id>
    <onHoldReasonListId>301YW28_000C16P9300000L</onHoldReasonListId>
    <processName>Process</processName>
    <processId>301YW1Z_0003DPRLH000001</processId>
</workflowQueue>

GET/v1/workflowQueue/{id}/allRoute Gets all the available workflow queue routes stored in the server.

Expand Operation / Collapse Operation

Gets all the available workflow queue routes stored in the server.

Available from version: 1.0.0

Call Properties

Response
Content
List of route [route]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

route type

Represents an available workflow queue route

Field Name Data Type Expected Description
destinationQueueId String Yes The ID of the destination queue.
destinationQueueName String Yes The name of the destination queue.

JSON Samples

Sample 1
Request URL
/v1/workflowQueue/301YW22_0003G6S0L00001H/allRoute
Response
{"routes":[{"destinationQueueId":"301YW23_0003G1S0L000017","destinationQueueName":"Queue 4"},{"destinationQueueId":"301YW23_0003G1S0L0A4D87","destinationQueueName":"Queue 5"}]}

XML Samples

Sample 1
Request URL
/v1/workflowQueue/301YW22_0003G6S0L00001H/allRoute
Response
<routes>
    <route>
        <destinationQueueId>301YW23_0003G1S0L000017</destinationQueueId>
        <destinationQueueName>Queue 4</destinationQueueName>
    </route>
    <route>
        <destinationQueueId>301YW23_0003G1S0L0A4D87</destinationQueueId>
        <destinationQueueName>Queue 5</destinationQueueName>
    </route>
</routes>

GET/v1/workflowQueue/{id}/form Gets the workflow queue related forms stored in the ImageNow server.

Expand Operation / Collapse Operation

Gets the workflow queue related forms stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Response
Content
List of form [form]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

form type

Represents a workflow queue related form

Field Name Data Type Expected Description
id String Yes The ID of the form.
isDefault boolean Yes Determine if it's the default form on the queue.
name String Yes The name of the form.

JSON Samples

Sample 1
Request URL
/v1/workflowQueue/301YV98_00004W969000017/form
Response
{"forms":[{"id":"301YV96_00000J4270000PX","name":"Content Review Form","isDefault":false},{"id":"301YV96_00000Q4270000QS","name":"Approval Form","isDefault":true},{"id":"301YV96_00000B4270001W7","name":"Change List Form","isDefault":false}]}

XML Samples

Sample 1
Request URL
/v1/workflowQueue/301YV98_00004W969000017/form
Response
<forms>
    <form>
        <id>301YV96_00000J4270000PX</id>
        <name>Content Review Form</name>
        <isDefault>false</isDefault>
    </form>
    <form>
        <id>301YV96_00000Q4270000QS</id>
        <name>Approval Form</name>
        <isDefault>true</isDefault>
    </form>
    <form>
        <id>301YV96_00000B4270001W7</id>
        <name>Change List Form</name>
        <isDefault>false</isDefault>
    </form>
</forms>

GET/v1/workflowQueue/{id}/forwardRoute Gets the workflow queue forward routes stored in the ImageNow server.

Expand Operation / Collapse Operation

Gets the workflow queue forward routes stored in the ImageNow server.

Available from version: 1.0.0

Call Properties

Response
Content
List of forwardRoute [forwardRoute]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

forwardRoute type

Represents a workflow queue forward route

Field Name Data Type Expected Description
adHocParallelRoute boolean Yes Indicates if this is an adhoc parallel route.
defaultRoute boolean Yes Indicates if this is the default route.
destinationQueueId String No The ID of the destination queue.
destinationQueueName String No The name of the destination queue.
name String Yes The name of the route.
type routeType Yes The type of the route.
routeType enumeration

Represents the type of a route in a workflow.

Constant Name Description
MANUAL
AUTO
CONDITIONAL
PARALLEL
CONDITIONAL_PARALLEL
PEER
BALANCED

JSON Samples

Sample 1
Request URL
/v1/workflowQueue/301YW22_0003G6S0L00001H/forwardRoute
Response
{"forwardRoutes":[{"type":"MANUAL","name":"Queue 4","destinationQueueId":"301YW23_0003G1S0L000017","destinationQueueName":"Queue 4","defaultRoute":false,"adHocParallelRoute":false},{"type":"PARALLEL","name":"Parallel","destinationQueueId":null,"destinationQueueName":null,"defaultRoute":false,"adHocParallelRoute":false}]}

XML Samples

Sample 1
Request URL
/v1/workflowQueue/301YW22_0003G6S0L00001H/forwardRoute
Response
<forwardRoutes>
    <forwardRoute>
        <type>MANUAL</type>
        <name>Queue 4</name>
        <destinationQueueId>301YW23_0003G1S0L000017</destinationQueueId>
        <destinationQueueName>Queue 4</destinationQueueName>
        <defaultRoute>false</defaultRoute>
        <adHocParallelRoute>false</adHocParallelRoute>
    </forwardRoute>
    <forwardRoute>
        <type>PARALLEL</type>
        <name>Parallel</name>
        <defaultRoute>false</defaultRoute>
        <adHocParallelRoute>false</adHocParallelRoute>
    </forwardRoute>
</forwardRoutes>

WorkflowQueue (Version 2)

GET/v2/workflowQueue/ Gets the specified set of workflow queues for the user stored in the server. This version returns...

Expand Operation / Collapse Operation

Gets the specified set of workflow queues for the user stored in the server. This version returns privileges.

Available from version: 1.0.0

Call Properties

Query Parameter
access access (optional) Filter queues by user access.
Response
Content
List of workflowQueue [workflowQueue]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

access enumeration

Represents the access to queues a user can have.

Constant Name Description
ALL The access for the queues a user can add or process items
PROCESS The access for queues a user can process items in
ADD The access for queues a user can add items to
queuePrivileges type

Full set of workflow queue privileges

Field Name Data Type Expected Description
add Boolean Yes Indicates the user can add content to the queue.
archive Boolean Yes Indicates the user can archive content from the queue.
changePriority Boolean Yes Indicates the user can change the priority of content in the queue.
delete Boolean Yes Indicates the user can delete queue items and the content they reference.
process Boolean Yes Indicates the user can process content in the queue.
queueLead Boolean Yes Indicates the user is a queue lead for the queue.
remove Boolean Yes Indicates the user can remove content from the queue.
routeAnywhere Boolean Yes Indicates the user can route content to any other queue in the same process.
routeUpstream Boolean Yes Indicates the user can route content to any of the prior queues the content has been in.
workflowQueue type

Represents a workflow queue.

Field Name Data Type Expected Description
id String Yes The ID of the queue.
name String Yes The name of the queue.
onHoldReasonListId String No The ID of a list of reasons for placing an item on hold.
privileges queuePrivileges Yes The requesting user's privileges for the queue.
processId String Yes The ID of this queue's process.
processName String Yes The name of this queue's process.

JSON Samples

Sample 1
Request URL
/v2/workflowQueue
Response
{"workflowQueues":[{"name":"Queue 1","id":"301YW1Z_0003DBRLH000001","onHoldReasonListId":null,"processName":"Process","processId":"301YW1Z_0003DPRLH000001","privileges":{"queueLead":false,"add":true,"process":false,"delete":false,"remove":true,"archive":false,"routeAnywhere":false,"routeUpstream":false,"changePriority":false}},{"name":"Queue 2","id":"301YW22_0003G6S0L000013","onHoldReasonListId":null,"processName":"Process","processId":"301YW1Z_0003DPRLH000001","privileges":{"queueLead":true,"add":true,"process":true,"delete":true,"remove":true,"archive":true,"routeAnywhere":true,"routeUpstream":true,"changePriority":true}}]}

XML Samples

Sample 1
Request URL
/v2/workflowQueue
Response
<workflowQueues>
    <workflowQueue>
        <name>Queue 1</name>
        <id>301YW1Z_0003DBRLH000001</id>
        <processName>Process</processName>
        <processId>301YW1Z_0003DPRLH000001</processId>
        <privileges>
            <queueLead>false</queueLead>
            <add>true</add>
            <process>false</process>
            <delete>false</delete>
            <remove>true</remove>
            <archive>false</archive>
            <routeAnywhere>false</routeAnywhere>
            <routeUpstream>false</routeUpstream>
            <changePriority>false</changePriority>
        </privileges>
    </workflowQueue>
    <workflowQueue>
        <name>Queue 2</name>
        <id>301YW22_0003G6S0L000013</id>
        <processName>Process</processName>
        <processId>301YW1Z_0003DPRLH000001</processId>
        <privileges>
            <queueLead>true</queueLead>
            <add>true</add>
            <process>true</process>
            <delete>true</delete>
            <remove>true</remove>
            <archive>true</archive>
            <routeAnywhere>true</routeAnywhere>
            <routeUpstream>true</routeUpstream>
            <changePriority>true</changePriority>
        </privileges>
    </workflowQueue>
</workflowQueues>

GET/v2/workflowQueue/{id} Gets properties of the workflow queue stored in the server. This version returns key attributes.

Expand Operation / Collapse Operation

Gets properties of the workflow queue stored in the server. This version returns key attributes.

Available from version: 1.0.0

Call Properties

Response
Content
workflowQueue
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

keyAttributes type

Represents the override attributes of a workflow queue

Field Name Data Type Expected Description
allowBlankField1 boolean Yes Indicates if the queue allows field one of document metadata to be blank before routing.
allowBlankField2 boolean Yes Indicates if the queue allows field two of document metadata to be blank before routing.
allowBlankField3 boolean Yes Indicates if the queue allows field three of document metadata to be blank before routing.
allowBlankField4 boolean Yes Indicates if the queue allows field four of document metadata to be blank before routing.
allowBlankField5 boolean Yes Indicates if the queue allows field five of document metadata to be blank before routing.
canModifyField1 boolean Yes Indicates if the queue allows edit of field one of document metadata.
canModifyField2 boolean Yes Indicates if the queue allows edit of field two of document metadata.
canModifyField3 boolean Yes Indicates if the queue allows edit of field three of document metadata.
canModifyField4 boolean Yes Indicates if the queue allows edit of field four of document metadata.
canModifyField5 boolean Yes Indicates if the queue allows edit of field five of document metadata.
canModifyLocation boolean Yes Indicates if the queue allows edit of the content location.
canModifyName boolean Yes Indicates if the queue allows edit of the content name.
canModifyProperties boolean Yes Indicates if the queue allows edit of custom properties.
canModifyType boolean Yes Indicates if the queue allows edit of the document type.
onlyBlankFields boolean Yes Indicates if the queue only allows changing blank document metadata fields.
workflowQueue type

Represents a workflow queue

Field Name Data Type Expected Description
canRecallRoute boolean Yes Indicates if the queue allows routed items to be recalled back to this queue.
canRouteBack boolean Yes Indicates if the queue allows items to be routed back to the previous queue.
id String Yes The ID of the queue.
isComplete boolean Yes Indicates if the queue is marked as a complete queue.
keyOverrides keyAttributes Yes Information about the queue's key overrides.
name String Yes The name of the queue.
onHoldReasonListId String Yes The ID of the reason list for putting an item in this queue on hold.
processId String Yes The ID of this queue's process.
processName String Yes The name of this queue's process.

JSON Samples

Sample 1
Request URL
/v2/workflowQueue/301YW22_0003G6S0L00001H
Response
{"name":"Queue 3","id":"301YW22_0003G6S0L00001H","onHoldReasonListId":"301YW28_000C16P9300000L","processName":"Process","processId":"301YW1Z_0003DPRLH000001","canRouteBack":true,"canRecallRoute":false,"isComplete":false,"keyOverrides":{"canModifyLocation":true,"canModifyName":true,"canModifyField1":false,"canModifyField2":true,"canModifyField3":false,"canModifyField4":true,"canModifyField5":false,"canModifyType":false,"canModifyProperties":false,"allowBlankField1":true,"allowBlankField2":false,"allowBlankField3":true,"allowBlankField4":false,"allowBlankField5":true,"onlyBlankFields":false}}

XML Samples

Sample 1
Request URL
/v2/workflowQueue/301YW22_0003G6S0L00001H
Response
<workflowQueue>
    <name>Queue 3</name>
    <id>301YW22_0003G6S0L00001H</id>
    <onHoldReasonListId>301YW28_000C16P9300000L</onHoldReasonListId>
    <processName>Process</processName>
    <processId>301YW1Z_0003DPRLH000001</processId>
    <canRouteBack>true</canRouteBack>
    <canRecallRoute>false</canRecallRoute>
    <isComplete>false</isComplete>
    <keyOverrides>
        <canModifyLocation>true</canModifyLocation>
        <canModifyName>true</canModifyName>
        <canModifyField1>false</canModifyField1>
        <canModifyField2>true</canModifyField2>
        <canModifyField3>false</canModifyField3>
        <canModifyField4>true</canModifyField4>
        <canModifyField5>false</canModifyField5>
        <canModifyType>false</canModifyType>
        <canModifyProperties>false</canModifyProperties>
        <allowBlankField1>true</allowBlankField1>
        <allowBlankField2>false</allowBlankField2>
        <allowBlankField3>true</allowBlankField3>
        <allowBlankField4>false</allowBlankField4>
        <allowBlankField5>true</allowBlankField5>
        <onlyBlankFields>false</onlyBlankFields>
    </keyOverrides>
</workflowQueue>

GET/v2/workflowQueue/{id}/form Gets the workflow queue related forms stored in the server.

Expand Operation / Collapse Operation

Gets the workflow queue related forms stored in the server.

Available from version: 1.0.0

Call Properties

Query Parameter
includeInactive (optional) Determines whether to include inactive forms. The default value is false.
Response
Content
List of form [form]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

form type

Represents a workflow queue related form.

Field Name Data Type Expected Description
id String Yes The ID of the form.
isActive boolean Yes A flag that represents if the form is active or not.
isDefault boolean Yes A flag to determine if it's the default form on the queue.
name String Yes The name of the form.

JSON Samples

Sample 1 - Request without the includeInactive parameter (inactive forms not returned)
Request URL
/v2/workflowQueue/301YV98_00004W969000017/form
Response
{"forms":[{"id":"301YV96_00000J4270000PX","name":"Content Review Form","isDefault":false,"isActive":true},{"id":"301YV96_00000Q4270000QS","name":"Approval Form","isDefault":true,"isActive":true},{"id":"301YV96_00000B4270001W7","name":"Change List Form","isDefault":false,"isActive":true}]}
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL
/v2/workflowQueue/301YV98_00004W969000017/form?includeInactive=true
Response
{"forms":[{"id":"301YV96_00000J4270000PX","name":"Content Review Form","isDefault":false,"isActive":false},{"id":"301YV96_00000Q4270000QS","name":"Approval Form","isDefault":true,"isActive":true},{"id":"301YV96_00000B4270001W7","name":"Change List Form","isDefault":false,"isActive":true}]}

XML Samples

Sample 1 - Request without the includeInactive parameter (inactive forms not returned)
Request URL
/v2/workflowQueue/301YV98_00004W969000017/form
Response
<forms>
    <form>
        <id>301YV96_00000J4270000PX</id>
        <name>Content Review Form</name>
        <isDefault>false</isDefault>
        <isActive>true</isActive>
    </form>
    <form>
        <id>301YV96_00000Q4270000QS</id>
        <name>Approval Form</name>
        <isDefault>true</isDefault>
        <isActive>true</isActive>
    </form>
    <form>
        <id>301YV96_00000B4270001W7</id>
        <name>Change List Form</name>
        <isDefault>false</isDefault>
        <isActive>true</isActive>
    </form>
</forms>
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL
/v2/workflowQueue/301YV98_00004W969000017/form?includeInactive=true
Response
<forms>
    <form>
        <id>301YV96_00000J4270000PX</id>
        <name>Content Review Form</name>
        <isDefault>false</isDefault>
        <isActive>false</isActive>
    </form>
    <form>
        <id>301YV96_00000Q4270000QS</id>
        <name>Approval Form</name>
        <isDefault>true</isDefault>
        <isActive>true</isActive>
    </form>
    <form>
        <id>301YV96_00000B4270001W7</id>
        <name>Change List Form</name>
        <isDefault>false</isDefault>
        <isActive>true</isActive>
    </form>
</forms>

GET/v2/workflowQueue/{id}/forwardRoute Gets the workflow queue forward routes stored in the server. This version also returns destinatio...

Expand Operation / Collapse Operation

Gets the workflow queue forward routes stored in the server. This version also returns destinations for ad-hoc parallel routes.

Available from version: 1.0.0

Call Properties

Response
Content
List of forwardRoute [forwardRoute]
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

forwardRoute type

Represents a workflow queue forward route

Field Name Data Type Expected Description
adHocParallelRoute boolean Yes Indicates if this is an adhoc parallel route.
defaultRoute boolean Yes Indicates if this is the default route.
destinationQueueId String No The ID of the destination queue.
destinationQueueName String No The name of the destination queue.
name String Yes The name of the route.
type routeType Yes The type of the route.
routeType enumeration

Represents the type of a route in a workflow.

Constant Name Description
MANUAL
AUTO
CONDITIONAL
PARALLEL
CONDITIONAL_PARALLEL
PEER
BALANCED

JSON Samples

Sample 1 - Gets the workflow queue forward routes stored in the server.
Request URL
/v2/workflowQueue/301YW22_0003G6S0L00001H/forwardRoute
Response
{"forwardRoutes":[{"type":"MANUAL","name":"Queue 4","destinationQueueId":"301YW23_0003G1S0L000017","destinationQueueName":"Queue 4","defaultRoute":false,"adHocParallelRoute":false},{"type":"PARALLEL","name":"Parallel","destinationQueueId":"301YW23_0003G1S0L000019","destinationQueueName":"Parallel Queue 2","defaultRoute":false,"adHocParallelRoute":true},{"type":"PARALLEL","name":"Parallel","destinationQueueId":"301YW23_0003G1S0L000018","destinationQueueName":"Parallel Queue 1","defaultRoute":false,"adHocParallelRoute":true}]}

XML Samples

Sample 1 - Gets the workflow queue forward routes stored in the server.
Request URL
/v2/workflowQueue/301YW22_0003G6S0L00001H/forwardRoute
Response
<forwardRoutes>
    <forwardRoute>
        <type>MANUAL</type>
        <name>Queue 4</name>
        <destinationQueueId>301YW23_0003G1S0L000017</destinationQueueId>
        <destinationQueueName>Queue 4</destinationQueueName>
        <defaultRoute>false</defaultRoute>
        <adHocParallelRoute>false</adHocParallelRoute>
    </forwardRoute>
    <forwardRoute>
        <type>PARALLEL</type>
        <name>Parallel</name>
        <destinationQueueId>301YW23_0003G1S0L000019</destinationQueueId>
        <destinationQueueName>Parallel Queue 2</destinationQueueName>
        <defaultRoute>false</defaultRoute>
        <adHocParallelRoute>true</adHocParallelRoute>
    </forwardRoute>
    <forwardRoute>
        <type>PARALLEL</type>
        <name>Parallel</name>
        <destinationQueueId>301YW23_0003G1S0L000018</destinationQueueId>
        <destinationQueueName>Parallel Queue 1</destinationQueueName>
        <defaultRoute>false</defaultRoute>
        <adHocParallelRoute>true</adHocParallelRoute>
    </forwardRoute>
</forwardRoutes>

WorkflowQueue (Version 3)

GET/v3/workflowQueue/{id} Gets properties of the workflow queue stored in the server. This version returns key attributes a...

Expand Operation / Collapse Operation

Gets properties of the workflow queue stored in the server. This version returns key attributes and privileges.

Available from version: 1.0.0

Call Properties

Response
Content
workflowQueue
Content-Types
  • application/xml
  • application/json

Call Types and Enumerations

keyAttributes type

Represents the override attributes of a workflow queue

Field Name Data Type Expected Description
allowBlankField1 boolean Yes Indicates if the queue allows field one of document metadata to be blank before routing.
allowBlankField2 boolean Yes Indicates if the queue allows field two of document metadata to be blank before routing.
allowBlankField3 boolean Yes Indicates if the queue allows field three of document metadata to be blank before routing.
allowBlankField4 boolean Yes Indicates if the queue allows field four of document metadata to be blank before routing.
allowBlankField5 boolean Yes Indicates if the queue allows field five of document metadata to be blank before routing.
canModifyField1 boolean Yes Indicates if the queue allows edit of field one of document metadata.
canModifyField2 boolean Yes Indicates if the queue allows edit of field two of document metadata.
canModifyField3 boolean Yes Indicates if the queue allows edit of field three of document metadata.
canModifyField4 boolean Yes Indicates if the queue allows edit of field four of document metadata.
canModifyField5 boolean Yes Indicates if the queue allows edit of field five of document metadata.
canModifyLocation boolean Yes Indicates if the queue allows edit of the content location.
canModifyName boolean Yes Indicates if the queue allows edit of the content name.
canModifyProperties boolean Yes Indicates if the queue allows edit of custom properties.
canModifyType boolean Yes Indicates if the queue allows edit of the document type.
onlyBlankFields boolean Yes Indicates if the queue only allows changing blank document metadata fields.
queuePrivileges type

Full set of workflow queue privileges

Field Name Data Type Expected Description
add Boolean Yes Indicates the user can add content to the queue.
archive Boolean Yes Indicates the user can archive content from the queue.
changePriority Boolean Yes Indicates the user can change the priority of content in the queue.
delete Boolean Yes Indicates the user can delete queue items and the content they reference.
process Boolean Yes Indicates the user can process content in the queue.
queueLead Boolean Yes Indicates the user is a queue lead for the queue.
remove Boolean Yes Indicates the user can remove content from the queue.
routeAnywhere Boolean Yes Indicates the user can route content to any other queue in the same process.
routeUpstream Boolean Yes Indicates the user can route content to any of the prior queues the content has been in.
workflowQueue type

Represents a workflow queue

Field Name Data Type Expected Description
canRecallRoute boolean Yes Indicates if the queue allows routed items to be recalled back to this queue.
canRouteBack boolean Yes Indicates if the queue allows items to be routed back to the previous queue.
id String Yes The ID of the queue.
isComplete boolean Yes Indicates if the queue is marked as a complete queue.
keyOverrides keyAttributes Yes Information about the queue's key overrides.
name String Yes The name of the queue.
onHoldReasonListId String Yes The ID of the reason list for putting an item in this queue on hold.
privileges queuePrivileges Yes The requesting user's privileges for the queue.
processId String Yes The ID of this queue's process.
processName String Yes The name of this queue's process.

JSON Samples

Sample 1
Request URL
/v3/workflowQueue/301YW22_0003G6S0L00001H
Response
{"name":"Queue 3","id":"301YW22_0003G6S0L00001H","onHoldReasonListId":"301YW28_000C16P9300000L","processName":"Process","processId":"301YW1Z_0003DPRLH000001","canRouteBack":true,"canRecallRoute":false,"isComplete":false,"keyOverrides":{"canModifyLocation":true,"canModifyName":true,"canModifyField1":false,"canModifyField2":true,"canModifyField3":false,"canModifyField4":true,"canModifyField5":false,"canModifyType":false,"canModifyProperties":false,"allowBlankField1":true,"allowBlankField2":false,"allowBlankField3":true,"allowBlankField4":false,"allowBlankField5":true,"onlyBlankFields":false},"privileges":{"queueLead":false,"add":false,"process":true,"delete":false,"remove":false,"archive":false,"routeAnywhere":false,"routeUpstream":false,"changePriority":false}}

XML Samples

Sample 1
Request URL
/v3/workflowQueue/301YW22_0003G6S0L00001H
Response
<workflowQueue>
    <name>Queue 3</name>
    <id>301YW22_0003G6S0L00001H</id>
    <onHoldReasonListId>301YW28_000C16P9300000L</onHoldReasonListId>
    <processName>Process</processName>
    <processId>301YW1Z_0003DPRLH000001</processId>
    <canRouteBack>true</canRouteBack>
    <canRecallRoute>false</canRecallRoute>
    <isComplete>false</isComplete>
    <keyOverrides>
        <canModifyLocation>true</canModifyLocation>
        <canModifyName>true</canModifyName>
        <canModifyField1>false</canModifyField1>
        <canModifyField2>true</canModifyField2>
        <canModifyField3>false</canModifyField3>
        <canModifyField4>true</canModifyField4>
        <canModifyField5>false</canModifyField5>
        <canModifyType>false</canModifyType>
        <canModifyProperties>false</canModifyProperties>
        <allowBlankField1>true</allowBlankField1>
        <allowBlankField2>false</allowBlankField2>
        <allowBlankField3>true</allowBlankField3>
        <allowBlankField4>false</allowBlankField4>
        <allowBlankField5>true</allowBlankField5>
        <onlyBlankFields>false</onlyBlankFields>
    </keyOverrides>
    <privileges>
        <queueLead>false</queueLead>
        <add>false</add>
        <process>true</process>
        <delete>false</delete>
        <remove>false</remove>
        <archive>false</archive>
        <routeAnywhere>false</routeAnywhere>
        <routeUpstream>false</routeUpstream>
        <changePriority>false</changePriority>
    </privileges>
</workflowQueue>
© 2019 Perceptive Software