Operations
List Operations / Hide OperationsExpand Fully / Collapse Fully
AnnotationTemplate (Version 1)
Gets all annotations templates for which the user has any priv access stored in ImageNow Server. /v1/annotationTemplate
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Gets the file associated with a picture stamp annotation template stored in ImageNow Server. /v1/annotationTemplate/PICTURE_STAMP/{id}/file
Gets the file associated with a picture stamp annotation template stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the file info associated with a picture stamp annotation template stored in ImageNow Server. /v1/annotationTemplate/PICTURE_STAMP/{id}/file
Gets the file info associated with a picture stamp annotation template stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
ApplicationPlan (Version 1)
Gets all Application Plans if no type parameter provided or only those Application Plans of the t... /v1/applicationPlan
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the Application Plan information for the provided id /v1/applicationPlan/{id}
Gets the Application Plan information for the provided id
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Resolves the location of an application plan /v1/applicationPlan/{id}/location
Resolves the location of an application plan
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Application plan expects an existing drawer name
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Multi-level application plan including a folder type with custom properties
Request URL |
|
Request |
|
Response |
|
Sample 2 - Application plan expects an existing drawer name
Request URL |
|
Request |
|
Response |
|
ApplicationPlan (Version 2)
Gets all Application Plans if no type parameter provided or only those Application Plans of the t... /v2/applicationPlan
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the Application Plan information for the provided id /v2/applicationPlan/{id}
Gets the Application Plan information for the provided id
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Resolves the location of an application plan /v2/applicationPlan/{id}/location
Resolves the location of an application plan
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Application plan expects an existing drawer name
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Multi-level application plan including a folder type with custom properties
Request URL |
|
Request |
|
Response |
|
Sample 2 - Application plan expects an existing drawer name
Request URL |
|
Request |
|
Response |
|
ApplicationPlan (Version 3)
Gets all Application Plans if no type parameter provided or only those Application Plans of the t... /v3/applicationPlan
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the Application Plan information for the provided id /v3/applicationPlan/{id}
Gets the Application Plan information for the provided id
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
ApplicationPlan (Version 4)
Gets the Application Plan information for the provided ID /v4/applicationPlan/{id}
Gets the Application Plan information for the provided ID
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
ApplicationPlan (Version 5)
Gets all application plans if no type parameter provided or only those application plans of the t... /v5/applicationPlan
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the script for the provided ID. /v5/applicationPlan/script/{scriptId}
Gets the script for the provided ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets an application plan with the given ID. /v5/applicationPlan/{appPlanId}
Gets an application plan with the given ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
CaptureGroup (Version 1)
Creates a capture group that can be used to capture a group of pages into one or more documents /v1/captureGroup/
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 |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Completes the capture process for a captured document group. /v1/captureGroup/{id}
Completes the capture process for a captured document group.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Captures a page to a capture group /v1/captureGroup/{id}/page
Captures a page to a capture group
Available from version: 1.0.0
Call Properties
Request |
|
||||||||||||
Multipart Parameters |
|
||||||||||||
Response |
|
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 |
|
||
Multipart Request |
|
||
Response |
|
XML Samples
Sample 1
Request URL |
|
||
Multipart Request |
|
||
Response |
|
CaptureProfile (Version 1)
This API call requests the list of active capture profiles stored in ImageNow Server. Integration... /v1/captureProfile
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - sourceType parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1 - sourceType parameter excluded
Request URL |
|
Response |
|
Sample 2 - sourceType parameter included
Request URL |
|
Response |
|
This API call requests the context map item list stored in ImageNow Server that matches the given... /v1/captureProfile/applicationPlan/itemList/{id}
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
This API call requests the capture profile stored in ImageNow Server that matches the given ID. I... /v1/captureProfile/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
CaptureProfile (Version 2)
This API call requests the list of active capture profiles stored in ImageNow Server. Integration... /v2/captureProfile
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - sourceType parameter included
Request URL |
|
Response |
|
Sample 3 - categoryType parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1 - sourceType parameter excluded
Request URL |
|
Response |
|
Sample 2 - sourceType parameter included
Request URL |
|
Response |
|
Sample 3 - categoryType parameter included
Request URL |
|
Response |
|
This API call requests the capture profile stored in ImageNow Server that matches the given ID. I... /v2/captureProfile/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
CaptureProfile (Version 3)
This API call requests the list of active capture profiles stored in ImageNow Server. Integration... /v3/captureProfile
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - sourceType parameter included
Request URL |
|
Response |
|
Sample 3 - categoryType parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1 - sourceType parameter excluded
Request URL |
|
Response |
|
Sample 2 - sourceType parameter included
Request URL |
|
Response |
|
Sample 3 - categoryType parameter included
Request URL |
|
Response |
|
This API call requests the capture profile stored in ImageNow Server that matches the given ID. I... /v3/captureProfile/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
CaptureSourceProfile (Version 1)
This API call requests the capture source profile from ImageNow Server that matches the given ID.... /v1/captureSourceProfile/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
CaptureSourceProfile (Version 2)
This API call requests the capture source profile from ImageNow Server that matches the given ID.... /v2/captureSourceProfile/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
CaptureSourceProfile (Version 3)
This API call requests the capture source profile from ImageNow Server that matches the given ID.... /v3/captureSourceProfile/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Connection (Version 1)
Disconnect current connection from the server. /v1/connection/
Disconnect current connection from the server.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
This API call verifies the connection status of Integration Server to ImageNow Server. If a conne... /v1/connection/
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Connection (Version 2)
This API call verifies the connection status of Integration Server to ImageNow Server. If a conne... /v2/connection/
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
ConnectionType (Version 1)
Gets all connection types that the user has create privileges for. /v1/connectionType
Gets all connection types that the user has create privileges for.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Department (Version 1)
Retrieve the list of departments. /v1/department
Retrieve the list of departments.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Creates a department. /v1/department
Creates a department.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Retrieve a department by ID. /v1/department/{id}
Retrieve a department by ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Updates an existing department. /v1/department/{id}
Updates an existing department.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
DigitalId (Version 1)
This API call creates a digital ID for the user. Integration Server uses the digitalIdPasswordInf... /v1/digitalId
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 |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
This API call checks whether the user's digital ID is valid. Integration Server uses the digitalI... /v1/digitalId/validity
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
DigitalId (Version 2)
This API call creates a digital ID for the user. Integration Server uses the digitalIdPasswordInf... /v2/digitalId
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 |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
This API call checks whether the user's digital ID is valid. Integration Server uses the digitalI... /v2/digitalId/validity
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Document (Version 1)
Store a new Document in the Server. /v1/document
Store a new Document in the Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
||||||||||||
Request |
|
||||||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to replace the existing document with the new document
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to create a document with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to replace the existing document with the new document
Request URL |
|
Request |
|
Verifies a signature on a document. /v1/document/digitalSignature/{signatureId}/verify
Verifies a signature on a document.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Voids a digital signature. /v1/document/digitalSignature/{signatureId}/void
Voids a digital signature.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Exports one or more documents as an archive file. /v1/document/export
Exports one or more documents as an archive file.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
||||||||||||||
Response |
|
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 |
|
Sample 2 - Export more than one document.
Request URL |
|
Sample 3 - Convert a document to PDF and export.
Request URL |
|
Sample 4 - Export a specific version of a document.
Request URL |
|
Sample 5 - Export a document using a workflow context.
Request URL |
|
XML Samples
Sample 1 - Export a single document.
Request URL |
|
Sample 2 - Export more than one document.
Request URL |
|
Sample 3 - Convert a document to PDF and export.
Request URL |
|
Sample 4 - Export a specific version of a document.
Request URL |
|
Sample 5 - Export a document using a workflow context.
Request URL |
|
Delete a Document stored in the Server. /v1/document/{id}
Delete a Document stored in the Server.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the document information stored in the Server that matches the ID. /v1/document/{id}
Gets the document information stored in the Server that matches the ID.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber paramater included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber paramater included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Update full document object. Missing information will clear out that portion of the document. /v1/document/{id}
Update full document object. Missing information will clear out that portion of the document.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
||||||||
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to replace the existing document with the updated document
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to update a document with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to replace the existing document with the updated document
Request URL |
|
Request |
|
Converts a document into a single pdf or tiff. If a portion of the document is unable to be conve... /v1/document/{id}/conversion/{outputType}
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 |
|
|||||||||||
Query Parameters |
|
|||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2
Request URL |
|
Sample 3
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2
Request URL |
|
Sample 3
Request URL |
|
Copies a Document stored in the Server. /v1/document/{id}/copy
Copies a Document stored in the Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
||||||||||||
Request |
|
||||||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to append the document you are copying to the existing document
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to copy a document with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to append the document you are copying to the existing document
Request URL |
|
Request |
|
Gets the digital signatures associated with a document version. /v1/document/{id}/digitalSignature
Gets the digital signatures associated with a document version.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Will sign a document on behalf of the current user. /v1/document/{id}/digitalSignature/sign
Will sign a document on behalf of the current user.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Verifies all signatures on a specific version of a document. /v1/document/{id}/digitalSignature/verifyAll
Verifies all signatures on a specific version of a document.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Get retention holds for the document. /v1/document/{id}/hold
Get retention holds for the document.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1 - Request to get all hold assignments for document.
Request URL |
|
Response |
|
Update the name of a document stored in the Server. /v1/document/{id}/name
Update the name of a document stored in the Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
||||||||
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to append the document you are renaming to the existing document
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to rename a document with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to append the document you are renaming to the existing document
Request URL |
|
Request |
|
Gets all of the page information for the document stored in the Server that matches the ID. /v1/document/{id}/page
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Adds a page to a document stored in the Server. /v1/document/{id}/page
Adds a page to a document stored in the Server.
Available from version: 1.0.0
Call Properties
Request |
|
||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Deletes a page from a document. /v1/document/{id}/page/{pageId}
Deletes a page from a document.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Updates a page in a document. /v1/document/{id}/page/{pageId}
Updates a page in a document.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Gets all of the annotations for the document page stored in the Server. /v1/document/{id}/page/{pageId}/annotation
Gets all of the annotations for the document page stored in the Server.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
||||||||
Response |
|
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
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Creates an arrow annotation on a page /v1/document/{id}/page/{pageId}/annotation/ARROW
Creates an arrow annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates an arrow annotation on a page /v1/document/{id}/page/{pageId}/annotation/ARROW/{annotationId}
Updates an arrow annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a check annotation on a page /v1/document/{id}/page/{pageId}/annotation/CHECK
Creates a check annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a check annotation on a page /v1/document/{id}/page/{pageId}/annotation/CHECK/{annotationId}
Updates a check annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a highlight annotation on a page /v1/document/{id}/page/{pageId}/annotation/HIGHLIGHT
Creates a highlight annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a highlight annotation on a page /v1/document/{id}/page/{pageId}/annotation/HIGHLIGHT/{annotationId}
Updates a highlight annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a line annotation on a page /v1/document/{id}/page/{pageId}/annotation/LINE
Creates a line annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a line annotation on a page /v1/document/{id}/page/{pageId}/annotation/LINE/{annotationId}
Updates a line annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates an oval annotation on a page /v1/document/{id}/page/{pageId}/annotation/OVAL
Creates an oval annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
Call Types and Enumerations
location
type
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a oval annotation on a page /v1/document/{id}/page/{pageId}/annotation/OVAL/{annotationId}
Updates a oval annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
Call Types and Enumerations
location
type
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a pen annotation on a page /v1/document/{id}/page/{pageId}/annotation/PEN
Creates a pen annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a pen annotation on a page /v1/document/{id}/page/{pageId}/annotation/PEN/{annotationId}
Updates a pen annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a picture stamp annotation on a page /v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP
Creates a picture stamp annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a picture stamp annotation on a page /v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP/{annotationId}
Updates a picture stamp annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Gets the file associated with an annotation stored in the Server. /v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP/{annotationId}/file
Gets the file associated with an annotation stored in the Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Gets the file info associated with an annotation stored in the Server. /v1/document/{id}/page/{pageId}/annotation/PICTURE_STAMP/{annotationId}/file
Gets the file info associated with an annotation stored in the Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Creates a rectangle annotation on a page /v1/document/{id}/page/{pageId}/annotation/RECTANGLE
Creates a rectangle annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
Call Types and Enumerations
location
type
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a rectangle annotation on a page /v1/document/{id}/page/{pageId}/annotation/RECTANGLE/{annotationId}
Updates a rectangle annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
Call Types and Enumerations
location
type
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a sticky note annotation on a page /v1/document/{id}/page/{pageId}/annotation/STICKY_NOTE
Creates a sticky note annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a sticky note annotation on a page /v1/document/{id}/page/{pageId}/annotation/STICKY_NOTE/{annotationId}
Updates a sticky note annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a text annotation on a page /v1/document/{id}/page/{pageId}/annotation/TEXT
Creates a text annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a text annotation on a page /v1/document/{id}/page/{pageId}/annotation/TEXT/{annotationId}
Updates a text annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a text stamp annotation on a page /v1/document/{id}/page/{pageId}/annotation/TEXT_STAMP
Creates a text stamp annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a text annotation on a page /v1/document/{id}/page/{pageId}/annotation/TEXT_STAMP/{annotationId}
Updates a text annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Creates a URL annotation on a page /v1/document/{id}/page/{pageId}/annotation/URL
Creates a URL annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Updates a URL annotation on a page /v1/document/{id}/page/{pageId}/annotation/URL/{annotationId}
Updates a URL annotation on a page
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - queueId parameter included
Request URL |
|
Request |
|
Deletes an annotation from a page /v1/document/{id}/page/{pageId}/annotation/{type}/{annotationId}
Deletes an annotation from a page
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameter |
|
|||||||
Response |
|
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 |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Converts a page to a PDF, TIFF, or PNG format. To use this call, File Conversion Service is requi... /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 required.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||||||||||
Response |
|
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
Gets the file associated with a page stored in the Server. /v1/document/{id}/page/{pageId}/file
Gets the file associated with a page stored in the Server.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||||||||||
Response |
|
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 |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
Gets the file info associated with a page stored in the Server, including the ID and content-length. /v1/document/{id}/page/{pageId}/file
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 |
|
|||||||||||||||||
Response |
|
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 |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
Replaces a page in a document stored in the Server. /v1/document/{id}/page/{pageId}/file
Replaces a page in a document stored in the Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
||||||||||||||
Request |
|
||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the preview file associated with a page stored in the Server. /v1/document/{id}/page/{pageId}/preview
Gets the preview file associated with a page stored in the Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||||||
Query Parameters |
|
|||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Gets the preview file info associated with a page stored in the Server. /v1/document/{id}/page/{pageId}/preview
Gets the preview file info associated with a page stored in the Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Retrieves a .png rendition of the page specified by pageId from the document specified by id. To ... /v1/document/{id}/page/{pageId}/rendition
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 |
|
|||||||||||||||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Retrieves the properties necessary to access an object directly from the storage solution. /v1/document/{id}/page/{pageId}/retrievalProperties
Retrieves the properties necessary to access an object directly from the storage solution.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Gets the thumbnail file associated with a page stored in the Server. /v1/document/{id}/page/{pageId}/thumbnail
Gets the thumbnail file associated with a page stored in the Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||
Query Parameter |
|
|||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Gets the thumbnail info associated with a page stored in the Server. /v1/document/{id}/page/{pageId}/thumbnail
Gets the thumbnail info associated with a page stored in the Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||||
Query Parameter |
|
|||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Gets the document path stored in the Server that matches the ID. /v1/document/{id}/path
Gets the document path stored in the Server that matches the ID.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - queueId parameter included
Request URL |
|
Response |
|
Sample 3 - When a document is in a drawer
Request URL |
|
Response |
|
XML Samples
Sample 1 - A document named 'FY2017' in nested folders
Request URL |
|
Response |
|
Sample 2 - queueId parameter included
Request URL |
|
Response |
|
Sample 3 - When a document is in a drawer
Request URL |
|
Response |
|
Attaches an external reference object as a page to a document. /v1/document/{id}/referenceObject
Attaches an external reference object as a page to a document.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Gets the thumbnail file associated with a document stored in ImageNow Server. /v1/document/{id}/thumbnail
Gets the thumbnail file associated with a document stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Gets the thumbnail info associated with a document stored in ImageNow Server. /v1/document/{id}/thumbnail
Gets the thumbnail info associated with a document stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Creates a notification that sends a document to a user. /v1/document/{id}/usernotification
Creates a notification that sends a document to a user.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Sample 2 - Send a document to multiple users that will open with the workflow viewer.
Request URL |
|
Request |
|
XML Samples
Sample 1 - Send a document to a user that will open with the document viewer.
Request URL |
|
Request |
|
Sample 2 - Send a document to multiple users that will open with the workflow viewer.
Request URL |
|
Request |
|
Verify the document's phsobs for correctness. /v1/document/{id}/verification
Verify the document's phsobs for correctness.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Retrieves the version history for the given document. /v1/document/{id}/version
Retrieves the version history for the given document.
Available from version: 1.0.0
Call Properties
Path Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Adds a given document to version control. /v1/document/{id}/versionControl/add
Adds a given document to version control.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Will check in a document to version control. /v1/document/{id}/versionControl/checkIn
Will check in a document to version control.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Will check out a document from version control. /v1/document/{id}/versionControl/checkOut
Will check out a document from version control.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Promotes a previous version of the given document from version control to latest. /v1/document/{id}/versionControl/promoteVersion
Promotes a previous version of the given document from version control to latest.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Removes a given document from version control. /v1/document/{id}/versionControl/remove
Removes a given document from version control.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Will undo the previous document checkout. /v1/document/{id}/versionControl/undoCheckOut
Will undo the previous document checkout.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Document (Version 2)
Gets the document information from the server that matches the ID. /v2/document/{id}
Gets the document information from the server that matches the ID.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Updates a page in a document. /v2/document/{id}/page/{pageId}
Updates a page in a document.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Gets all annotations for the document page stored in the server. /v2/document/{id}/page/{pageId}/annotation
Gets all annotations for the document page stored in the server.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
||||||||
Response |
|
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
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Updates a digital signature visual representation on a page /v2/document/{id}/page/{pageId}/annotation/DIGITAL_SIGNATURE/{annotationId}
Updates a digital signature visual representation on a page
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Deletes an annotation from a page /v2/document/{id}/page/{pageId}/annotation/{type}/{annotationId}
Deletes an annotation from a page
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameter |
|
|||||||
Response |
|
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 |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Gets the file associated with a page stored in ImageNow Server. /v2/document/{id}/page/{pageId}/file
Gets the file associated with a page stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||||||||||||
Response |
|
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 |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
Gets the file info associated with a page stored in ImageNow Server, including the ID and content... /v2/document/{id}/page/{pageId}/file
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 |
|
|||||||||||||||||||
Response |
|
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 |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Sample 3 - using inline Content-Disposition
Request URL |
|
Sample 4 - using attachment Content-Disposition
Request URL |
|
Gets the preview file associated with a page stored in the Server. /v2/document/{id}/page/{pageId}/preview
Gets the preview file associated with a page stored in the Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Gets the preview file info associated with a page stored in the Server. /v2/document/{id}/page/{pageId}/preview
Gets the preview file info associated with a page stored in the Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueId parameter included
Request URL |
|
Retrieves a .png rendition of the page specified by pageId from the document specified by id. To ... /v2/document/{id}/page/{pageId}/rendition
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 |
|
|||||||||||||||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - queueIdparameter included
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - queueIdparameter included
Request URL |
|
Document (Version 3)
Store a new document in the server. /v3/document
Store a new document in the server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
||||||||||||
Request |
|
||||||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to replace the existing document with the new document
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to create a document with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to replace the existing document with the new document
Request URL |
|
Request |
|
Gets the document information from the server that matches the ID. /v3/document/{id}
Gets the document information from the server that matches the ID.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Updates the document fields with the provided values. /v3/document/{id}
Updates the document fields with the provided values.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
||||||||
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Document (Version 4)
Gets the document information from the server that matches the ID. /v4/document/{id}
Gets the document information from the server that matches the ID.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Document (Version 5)
Gets the document information from the server that matches the ID. This call now returns creation... /v5/document/{id}
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Document (Version 6)
Gets the document information from the server that matches the ID. This call now returns element ... /v6/document/{id}
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Updates the document properties and custom properties. This call now only updates properties prov... /v6/document/{id}
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 |
|
||||||||
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - Only update field3
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - Only update field3
Request URL |
|
Request |
|
Document (Version 7)
Gets the document information from the server that matches the ID. Includes privilege information... /v7/document/{id}
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Document (Version 8)
Gets the document information from the server that matches the ID. Includes 'Send to ShareBase' p... /v8/document/{id}
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - versionNumber parameter included
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
DocumentType (Version 1)
Gets all document types stored in ImageNow Server. /v1/documentType
Gets all document types stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the document type stored in ImageNow Server that matches the ID. /v1/documentType/{id}
Gets the document type stored in ImageNow Server that matches the ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
DocumentType (Version 2)
Gets all document types stored on the server. /v2/documentType
Gets all document types stored on the server.
Available from version: 4.7.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Retrieve all active and in-active document types using includeInactive query parameter.
Request URL |
|
Response |
|
XML Samples
Sample 1 - Retrieve all active document types.
Request URL |
|
Response |
|
Sample 2 - Retrieve all active and in-active document types using includeInactive query parameter.
Request URL |
|
Response |
|
DocumentTypeList (Version 1)
Gets all the doc type lists in ImageNow Server /v1/documentTypeList
Gets all the doc type lists in ImageNow Server
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the doc type list in ImageNow Server that matches the ID. /v1/documentTypeList/{id}
Gets the doc type list in ImageNow Server that matches the ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Drawer (Version 1)
Gets all drawers stored in ImageNow Server. /v1/drawer
Gets all drawers stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets one drawer stored in ImageNow Server. /v1/drawer/{id}
Gets one drawer stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
This API operation moves a set of existing ImageNow documents, folders, and shortcuts to a drawer... /v1/drawer/{id}/content
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 |
|
||||||||
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to append the document with the naming conflict to the existing document!
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to move with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to append the document with the naming conflict to the existing document!
Request URL |
|
Request |
|
Drawer (Version 2)
Gets all drawers stored in ImageNow Server that the user has some privilege to. /v2/drawer
Gets all drawers stored in ImageNow Server that the user has some privilege to.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets one drawer stored in ImageNow Server. /v2/drawer/{id}
Gets one drawer stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Get the folders and documents contained in the drawer. /v2/drawer/{id}/content
Get the folders and documents contained in the drawer.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
DrawerManagement (Version 1)
Retrieves all drawers owned by a department. /v1/management/drawer
Retrieves all drawers owned by a department.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Creates a drawer /v1/management/drawer
Creates a drawer
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Deletes a drawer /v1/management/drawer/{id}
Deletes a drawer
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Get an individual drawer that includes system information /v1/management/drawer/{id}
Get an individual drawer that includes system information
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Updates a drawer /v1/management/drawer/{id}
Updates a drawer
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Folder (Version 1)
Creates a folder. /v1/folder
Creates a folder.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Searches for folders that satisfy the given criteria. /v1/folder/searchResult
Searches for folders that satisfy the given criteria.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Search a single drawer
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Search all of ImageNow Server
Request URL |
|
Request |
|
Response |
|
Sample 2 - Search a single drawer
Request URL |
|
Request |
|
Response |
|
Deletes a folder. /v1/folder/{id}
Deletes a folder.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the folder and it's contents. /v1/folder/{id}
Gets the folder and it's contents.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - queueId parameter included
Request URL |
|
Response |
|
Updates the name and folder type for a given folder. /v1/folder/{id}
Updates the name and folder type for a given folder.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
This API operation moves a set of existing ImageNow documents, folders, and shortcuts to a folder... /v1/folder/{id}/content
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 |
|
||||||||
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to append the document with the naming conflict to the existing document
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to move with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to append the document with the naming conflict to the existing document
Request URL |
|
Request |
|
Gets associated document types for a folder. Additionally, each document type has a flag to indic... /v1/folder/{id}/documentType
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 |
|
||||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Get the associated document types of a folder with required = true and present = false
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1 - Request all document types associated with the folder
Request URL |
|
Response |
|
Sample 2 - Get the associated document types of a folder with required = true and present = false
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Update the name of a folder stored in ImageNow Server. /v1/folder/{id}/name
Update the name of a folder stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
||||||||
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Request to append the folder with the naming conflict to the existing folder
Request URL |
|
Request |
|
XML Samples
Sample 1 - Request to rename a folder with a response indicating a naming conflict
Request URL |
|
Request |
|
Response |
|
Sample 2 - Request to append the folder with the naming conflict to the existing folder
Request URL |
|
Request |
|
Gets a folder's path. /v1/folder/{id}/path
Gets a folder's path.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2 - queueId parameter included
Request URL |
|
Response |
|
Folder (Version 2)
Gets the folder and it's contents. /v2/folder/{id}
Gets the folder and it's contents.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Updates the name, folder type or properties provided for a given folder. /v2/folder/{id}
Updates the name, folder type or properties provided for a given folder.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Sample 2 - add new array element
Request URL |
|
Request |
|
Sample 3 - update an existing array value
Request URL |
|
Request |
|
Sample 4 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - add new array element
Request URL |
|
Request |
|
Sample 3 - update an existing array value
Request URL |
|
Request |
|
Sample 4 - queueId parameter included
Request URL |
|
Request |
|
Folder (Version 3)
Gets the folder and its contents. Returns associated workflow items. /v3/folder/{id}
Gets the folder and its contents. Returns associated workflow items.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Updates the name, location, folder type or properties provided for a given folder. /v3/folder/{id}
Updates the name, location, folder type or properties provided for a given folder.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Sample 2 - add new array element
Request URL |
|
Request |
|
Sample 3 - update an existing array value
Request URL |
|
Request |
|
Sample 4 - queueId parameter included
Request URL |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Sample 2 - add new array element
Request URL |
|
Request |
|
Sample 3 - update an existing array value
Request URL |
|
Request |
|
Sample 4 - queueId parameter included
Request URL |
|
Request |
|
Folder (Version 4)
Gets the folder and its contents. Returns associated workflow items. /v4/folder/{id}
Gets the folder and its contents. Returns associated workflow items.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
Folder (Version 5)
Gets the folder, its contents, the user's privileges and associated workflow items. /v5/folder/{id}
Gets the folder, its contents, the user's privileges and associated workflow items.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3 - queueId parameter included
Request URL |
|
Response |
|
FolderType (Version 1)
Gets the folder type and related capture profile information stored in the ImageNow server. /v1/folderType
Gets the folder type and related capture profile information stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the folder type and related capture profile information stored in the ImageNow server. /v1/folderType/{id}
Gets the folder type and related capture profile information stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
FolderType (Version 2)
Gets all folder types with privileges stored on the server. /v2/folderType
Gets all folder types with privileges stored on the server.
Available from version: 6.2.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Retrieve all active and inactive folder types.
Request URL |
|
Response |
|
XML Samples
Sample 1 - Retrieve all active folder types.
Request URL |
|
Response |
|
Sample 2 - Retrieve all active and inactive folder types.
Request URL |
|
Response |
|
Gets the folder type and related capture profile information stored in the server. Includes formId. /v2/folderType/{id}
Gets the folder type and related capture profile information stored in the server. Includes formId.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
FolderTypeList (Version 1)
Gets all folder type lists. /v1/folderTypeList
Gets all folder type lists.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the folder type list that matches the given ID. /v1/folderTypeList/{id}
Gets the folder type list that matches the given ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Form (Version 1)
Gets all forms in ImageNow Server. /v1/form
Gets all forms in ImageNow Server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL |
|
Response |
|
XML Samples
Sample 1 - Request without the includeInactive parameter (inactive forms not returned)
Request URL |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL |
|
Response |
|
Gets the form with a given ID from ImageNow Server. /v1/form/{id}
Gets the form with a given ID from ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Deletes the form data associated with a given document version and form. /v1/form/{id}/document/{docId}
Deletes the form data associated with a given document version and form.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameters |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
Gets the form data associated with a given document version and form. /v1/form/{id}/document/{docId}
Gets the form data associated with a given document version and form.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||
Query Parameters |
|
|||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
Store form data to a specific version of a document. /v1/form/{id}/document/{docId}
Store form data to a specific version of a document.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameters |
|
|||||||
Request |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
Deletes the form data associated with the given folder and form. /v1/form/{id}/folder/{folderId}
Deletes the form data associated with the given folder and form.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameter |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
Gets the form data associated with the given folder and form. /v1/form/{id}/folder/{folderId}
Gets the form data associated with the given folder and form.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||
Query Parameter |
|
|||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
Store form data to a folder. /v1/form/{id}/folder/{folderId}
Store form data to a folder.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Sample 2 - with workflow queue id
Request URL |
|
Gets all presentations for the given form in ImageNow Server. /v1/form/{id}/presentation
Gets all presentations for the given form in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the information for all the files for the given presentation of the given form in ImageNow S... /v1/form/{id}/presentation/{presentationId}
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets one physical file for the given presentation of the given form in ImageNow Server. /v1/form/{id}/presentation/{presentationId}/file/{fileId}
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 |
|
|||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
HostedDocument (Version 1)
Retrieves the ImageNow document ID for the document that matches the document properties within t... /v1/hostedDocument/{clientDocumentId}
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 |
|
|||||||
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Retrieves the ImageNow document ID and page ID for the document that matches the document propert... /v1/hostedDocument/{clientDocumentId}/clientLogob/{clientLogobId}
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 |
|
|||||||
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
License (Version 1)
This API call acquires a token for a feature license. The Integration Server response includes th... /v1/license/featureToken
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 |
|
|||||||
Response |
|
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 |
|
XML Samples
Sample 1 - Acquire a token for Perceptive Web Scanner.
Request URL |
|
LicenseGroup (Version 1)
Get the License Group of this ImageNow Server. /v1/licenseGroup
Get the License Group of this ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
OsmReferenceSet (Version 1)
Get all of the system's configured reference sets. /v1/osmReferenceSet
Get all of the system's configured reference sets.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
OutOfOffice (Version 1)
Retrieves all out of office instances for the user. /v1/outOfOffice
Retrieves all out of office instances for the user.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Creates an out of office instance for the user. /v1/outOfOffice
Creates an out of office instance for the user.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Retrieves all out of office reasons. /v1/outOfOffice/reason
Retrieves all out of office reasons.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Disables an out of office instance for the user if it's current or already passed, otherwise dele... /v1/outOfOffice/{outOfOfficeId}
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 |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Retrieves a single out of office instance for the user. /v1/outOfOffice/{outOfOfficeId}
Retrieves a single out of office instance for the user.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
Sample 2 - Without a disabling user
Request URL |
|
Response |
|
XML Samples
Sample 1 - With a disabling user
Request URL |
|
Response |
|
Sample 2 - Without a disabling user
Request URL |
|
Response |
|
Updates an out of office instance for the user. /v1/outOfOffice/{outOfOfficeId}
Updates an out of office instance for the user.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Property (Version 1)
Gets all properties stored in ImageNow Server. /v1/property
Gets all properties stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Get all NUMBER properties
Request URL |
|
Response |
|
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL |
|
Response |
|
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL |
|
Response |
|
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL |
|
Response |
|
XML Samples
Sample 1 - Get all properties
Request URL |
|
Response |
|
Sample 2 - Get all NUMBER properties
Request URL |
|
Response |
|
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL |
|
Response |
|
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL |
|
Response |
|
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL |
|
Response |
|
Gets the property stored in ImageNow Server that matches the ID. /v1/property/{id}
Gets the property stored in ImageNow Server that matches the ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Property (Version 2)
Gets all properties stored in the server. Includes IDs of list candidates. /v2/property
Gets all properties stored in the server. Includes IDs of list candidates.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Get all NUMBER properties
Request URL |
|
Response |
|
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL |
|
Response |
|
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL |
|
Response |
|
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL |
|
Response |
|
XML Samples
Sample 1 - Get all properties
Request URL |
|
Response |
|
Sample 2 - Get all NUMBER properties
Request URL |
|
Response |
|
Sample 3 - Get all properties with a listValuesLimit of ALL
Request URL |
|
Response |
|
Sample 4 - Get all properties with a listValuesLimit of NONE
Request URL |
|
Response |
|
Sample 5 - Get all properties with a listValuesLimit of 3
Request URL |
|
Response |
|
Gets the property stored in the server that matches the ID. Includes IDs of list candidates. /v2/property/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
ReasonList (Version 1)
Gets the reason list stored in the ImageNow server. /v1/reasonList/{id}/reason
Gets the reason list stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Response |
|
Call Types and Enumerations
reason
type
Field Name | Data Type | Expected | Description |
id |
String
|
Yes | |
text |
String
|
Yes |
JSON Samples
Sample 1
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Record (Version 1)
Declares a document as a record with user provided metadata or by using a capture profile. /v1/record
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 |
|
||||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Declare a document as a record using a capture profile.
Request URL |
|
Request |
|
XML Samples
Sample 1 - Declare a document as a record with user provided metadata with a response indicating a naming conflict.
Request URL |
|
Request |
|
Response |
|
Sample 2 - Declare a document as a record using a capture profile.
Request URL |
|
Request |
|
Searches for folders that satisfy the given criteria. /v1/record/searchResult
Searches for folders that satisfy the given criteria.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2
Request URL |
|
Request |
|
Response |
|
Sample 3
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Sample 2
Request URL |
|
Request |
|
Response |
|
Sample 3
Request URL |
|
Request |
|
Response |
|
Delete a record from the server. /v1/record/{id}
Delete a record from the server.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Get record properties. /v1/record/{id}
Get record properties.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Update record properties. Missing information will clear out that portion of the record. /v1/record/{id}
Update record properties. Missing information will clear out that portion of the record.
Available from version: 1.0.0
Call Properties
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Deletes a page from a record. /v1/record/{id}/page/{pageId}
Deletes a page from a record.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the file associated with a page of a record stored in ImageNow Server. /v1/record/{id}/page/{pageId}/file
Gets the file associated with a page of a record stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the preview file associated with a page of a record. /v1/record/{id}/page/{pageId}/preview
Gets the preview file associated with a page of a record.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||||||
Query Parameters |
|
|||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Retrieves a .png rendition of the page specified by pageId from the record specified by id. To us... /v1/record/{id}/page/{pageId}/rendition
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 |
|
|||||||||||||||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the thumbnail file associated with a page stored in the server. /v1/record/{id}/page/{pageId}/thumbnail
Gets the thumbnail file associated with a page stored in the server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Record (Version 2)
Get record properties with page info. /v2/record/{id}
Get record properties with page info.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
RecordCaptureGroup (Version 1)
Creates a capture group that can be used to capture a group of pages into one or more records /v1/recordCaptureGroup/
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 |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Completes the capture process for a captured record group. /v1/recordCaptureGroup/{id}
Completes the capture process for a captured record group.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Captures a page to a capture group /v1/recordCaptureGroup/{id}/page
Captures a page to a capture group
Available from version: 1.0.0
Call Properties
Request |
|
||||||||||||
Multipart Parameters |
|
||||||||||||
Response |
|
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 |
|
||
Multipart Request |
|
||
Response |
|
Sample 2 - With PDF Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 3 - With Photo Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 4 - With Scanned Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 5 - With Web Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 6 - With No Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 7
Request URL |
|
|
Multipart Request |
|
|
Response |
|
Sample 8
Request URL |
|
|
Multipart Request |
|
|
Response |
|
XML Samples
Sample 1 - With Email Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 2 - With PDF Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 3 - With Photo Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 4 - With Scanned Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 5 - With Web Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 6 - With No Metadata
Request URL |
|
||
Multipart Request |
|
||
Response |
|
Sample 7
Request URL |
|
|
Multipart Request |
|
|
Response |
|
Sample 8
Request URL |
|
|
Multipart Request |
|
|
Response |
|
RecordType (Version 1)
Gets all record types stored in ImageNow Server. /v1/recordType
Gets all record types stored in ImageNow Server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the record type stored in ImageNow Server that matches the ID. /v1/recordType/{id}
Gets the record type stored in ImageNow Server that matches the ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the list of picklists available for the record type. /v1/recordType/{id}/picklist
Gets the list of picklists available for the record type.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
RelationshipView (Version 1)
Gets all relationship views in the server that are available to the user. /v1/relationshipView
Gets all relationship views in the server that are available to the user.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets all document relationship views in the server that are available to the user. /v1/relationshipView/document
Gets all document relationship views in the server that are available to the user.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets all folder relationship views in the server that are available to the user. /v1/relationshipView/folder
Gets all folder relationship views in the server that are available to the user.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the relationship view in the server that matches the ID. /v1/relationshipView/{id}
Gets the relationship view in the server that matches the ID.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Run the relationship view with viewId against the document with documentId on the server. /v1/relationshipView/{viewId}/document/{documentId}/result
Run the relationship view with viewId against the document with documentId on the server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
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 |
|
Request |
|
Response |
|
Run the relationship view with viewId against the folder with folderId on the server. /v1/relationshipView/{viewId}/folder/{folderId}/result
Run the relationship view with viewId against the folder with folderId on the server.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
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 |
|
Request |
|
Response |
|
RetentionHold (Version 1)
Gets all retention holds. /v1/retentionhold
Gets all retention holds.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL |
|
Response |
|
XML Samples
Sample 1 - Request without the includeInactive parameter (inactive holds not returned)
Request URL |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL |
|
Response |
|
Gets all direct and inherited retention hold assignments for the given object. /v1/retentionhold/assignment
Gets all direct and inherited retention hold assignments for the given object.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Get hold assignments.
Request URL |
|
Response |
|
XML Samples
Sample 1 - Get hold assignments.
Request URL |
|
Response |
|
Sample 2 - Get hold assignments.
Request URL |
|
Response |
|
Assigns a document, document type, record, or record folder to the given retention hold. /v1/retentionhold/{id}/assignment
Assigns a document, document type, record, or record folder to the given retention hold.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
Sample 2 - Assign a record folder to a retention hold.
Request URL |
|
Request |
|
XML Samples
Sample 1 - Assign a document to a retention hold.
Request URL |
|
Request |
|
Sample 2 - Assign a record folder to a retention hold.
Request URL |
|
Request |
|
Unassigns an object from a retention hold. /v1/retentionhold/{id}/assignment/{assignmentId}
Unassigns an object from a retention hold.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1 - Request to remove a retention hold assignment.
Request URL |
|
XML Samples
Sample 1 - Request to remove a retention hold assignment.
Request URL |
|
RetentionHold (Version 2)
Gets all retention holds. /v2/retentionhold
Gets all retention holds.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL |
|
Response |
|
XML Samples
Sample 1 - Request without the includeInactive parameter (inactive holds not returned)
Request URL |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive holds returned)
Request URL |
|
Response |
|
ServerAction (Version 1)
Runs an iScript on the server /v1/serverAction
Runs an iScript on the server
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
ServerInfo (Version 1)
Gets all server information. /v1/serverInfo
Gets all server information.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
ServerInfo (Version 2)
Gets version information. /v2/serverInfo
Gets version information.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
ServiceStatus (Version 1)
Retrieve state of integration server and its dependent services. /v1/status
Retrieve state of integration server and its dependent services.
Available from version: 1.0.0
Call Properties
Response |
|
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
XML Samples
Sample 1
Request URL |
|
Response |
|
Sample 2
Request URL |
|
Response |
|
Sample 3
Request URL |
|
Response |
|
Sso (Version 1)
A redirection endpoint for the OpenID Connect Authorization Code Flow. /v1/sso/callback/{profileName}
A redirection endpoint for the OpenID Connect Authorization Code Flow.
Available from version: 6.0.0
Call Properties
Path Parameter |
|
||||||||
Query Parameters |
|
||||||||
Response |
|
JSON Samples
Sample 1 - OpenID Connect callback for the query response mode.
Request URL |
|
XML Samples
Sample 1 - OpenID Connect callback for the query response mode.
Request URL |
|
A redirection endpoint for the OpenID Connect Authorization Code Flow. /v1/sso/callback/{profileName}
A redirection endpoint for the OpenID Connect Authorization Code Flow.
Available from version: 6.0.0
Call Properties
Path Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
Form Samples
Sample 1 - OpenID Connect callback for the form_post response mode.
Request URL |
|
Initiates a single sign-on (SSO) flow based on the SSO configuration using the default login prof... /v1/sso/login
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 |
|
|||||||
Response |
|
JSON Samples
Sample 1 - Login endpoint for the default login profile.
Request URL |
|
Sample 2 - Login endpoint with state.
Request URL |
|
XML Samples
Sample 1 - Login endpoint for the default login profile.
Request URL |
|
Sample 2 - Login endpoint with state.
Request URL |
|
Initiates a single sign-on (SSO) flow based on the SSO configuration using the specified login pr... /v1/sso/login/{profileName}
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 |
|
|||||||
Query Parameter |
|
|||||||
Response |
|
JSON Samples
Sample 1 - Login endpoint for a login profile named customapp.
Request URL |
|
Sample 2 - Login endpoint with state for a login profile named customapp.
Request URL |
|
XML Samples
Sample 1 - Login endpoint for a login profile named customapp.
Request URL |
|
Sample 2 - Login endpoint with state for a login profile named customapp.
Request URL |
|
Task (Version 1)
Creates a new task on the specified document or folder. /v1/task
Creates a new task on the specified document or folder.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Deletes a task. /v1/task/{id}
Deletes a task.
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
/v1/task/{id}
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
/v1/task/{id}/comment
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
/v1/task/{id}/comment
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
/v1/task/{id}/completeAction
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
/v1/task/{id}/returnAction
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
/v1/task/{id}/skipAction
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the metadata associated with the visual representation of a task. /v1/task/{id}/visualRepresentation
Gets the metadata associated with the visual representation of a task.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Updates a task visual representation on a page /v1/task/{id}/visualRepresentation
Updates a task visual representation on a page
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Task (Version 2)
This API call requests detailed information about the task in ImageNow Server that matches the gi... /v2/task/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
TaskTemplate (Version 1)
Get all of the task templates available for creating new tasks. /v1/taskTemplate
Get all of the task templates available for creating new tasks.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
This API call requests detailed information about the task template that matches the given ID. /v1/taskTemplate/{id}
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Request with the getAllGroupMembers parameter (groups members included)
Request URL |
|
Response |
|
XML Samples
Sample 1 - Request without the getAllGroupMembers parameter (groups members not included)
Request URL |
|
Response |
|
Sample 2 - Request with the getAllGroupMembers parameter (groups members included)
Request URL |
|
Response |
|
UniqueId (Version 1)
Returns a set of server generated unique IDs. /v1/uniqueId
Returns a set of server generated unique IDs.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
User (Version 1)
Gets a list of all users. /v1/user
Gets a list of all users.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Creates a user. /v1/user
Creates a user.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Gets the list of groups a user belongs to. /v1/user/group
Gets the list of groups a user belongs to.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Deletes an existing user /v1/user/{id}
Deletes an existing user
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets an existing user. /v1/user/{id}
Gets an existing user.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Updates an existing user with new account information /v1/user/{id}/account
Updates an existing user with new account information
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Gets an existing user. /v1/user/{id}/extendedInfo
Gets an existing user.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the list of groups a user belongs to. /v1/user/{id}/group
Gets the list of groups a user belongs to.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Updates an existing user with group membership /v1/user/{id}/group
Updates an existing user with group membership
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Gets the privileges for a user /v1/user/{id}/privilege
Gets the privileges for a user
Available from version: 1.0.0
Call Properties
Query Parameters |
|
||||||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sets the privileges for a user /v1/user/{id}/privilege
Sets the privileges for a user
Available from version: 1.0.0
Call Properties
Request |
|
||||||||
Response |
|
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
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Updates an existing user's profile /v1/user/{id}/profile
Updates an existing user's profile
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
User (Version 2)
Gets a list of all users. /v2/user
Gets a list of all users.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the privileges for a user /v2/user/{id}/privilege
Gets the privileges for a user
Available from version: 1.0.0
Call Properties
Query Parameters |
|
||||||||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sets the privileges for a user /v2/user/{id}/privilege
Sets the privileges for a user
Available from version: 1.0.0
Call Properties
Request |
|
||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
UserGroup (Version 1)
Retrieves all existing userGroups in the department and groups shared with that department /v1/userGroup
Retrieves all existing userGroups in the department and groups shared with that department
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Creates a new user group /v1/userGroup
Creates a new user group
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Deletes an existing user group /v1/userGroup/{id}
Deletes an existing user group
Available from version: 1.0.0
Call Properties
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Retrieves an existing userGroup /v1/userGroup/{id}
Retrieves an existing userGroup
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Updates an existing user group /v1/userGroup/{id}
Updates an existing user group
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
Call Types and Enumerations
membership
type
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Gets the privileges for a user group /v1/userGroup/{id}/privilege
Gets the privileges for a user group
Available from version: 1.0.0
Call Properties
Query Parameters |
|
||||||||||
Response |
|
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
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Sets the privileges for a user group /v1/userGroup/{id}/privilege
Sets the privileges for a user group
Available from version: 1.0.0
Call Properties
Request |
|
||||||||
Response |
|
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
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
UserGroup (Version 2)
Retrieves an existing user group /v2/userGroup/{id}
Retrieves an existing user group
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Executes the list of patch operations and updates the user group accordingly. /v2/userGroup/{id}
Executes the list of patch operations and updates the user group accordingly.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Sample 2 - Remove a user from a user group.
Request URL |
|
Request |
|
Sample 3 - Remove a user from a user group by ID.
Request URL |
|
Request |
|
Sample 4 - Replace a field on the user group with a new value.
Request URL |
|
Request |
|
Sample 5 - Validate existing value is set on a user group.
Request URL |
|
Request |
|
Sample 6 - Copy a value from one field in a user group to another.
Request URL |
|
Request |
|
XML Samples
Sample 1 - Add a user to a user group.
Request URL |
|
Request |
|
Sample 2 - Remove a user from a user group.
Request URL |
|
Request |
|
Sample 3 - Remove a user from a user group by ID.
Request URL |
|
Request |
|
Sample 4 - Replace a field on the user group with a new value.
Request URL |
|
Request |
|
Sample 5 - Validate existing value is set on a user group.
Request URL |
|
Request |
|
Sample 6 - Copy a value from one field in a user group to another.
Request URL |
|
Request |
|
Updates an existing user group. /v2/userGroup/{id}
Updates an existing user group.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Sample 2 - Remove a user from a user group.
Request URL |
|
Request |
|
XML Samples
Sample 1 - Add a user to a user group.
Request URL |
|
Request |
|
Sample 2 - Remove a user from a user group.
Request URL |
|
Request |
|
This API call requests detailed information about the privileges for the user group that matches ... /v2/userGroup/{id}/privilege
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 |
|
||||||||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
This API call modifies the privileges for an existing user group. Integration Server structures t... /v2/userGroup/{id}/privilege
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 |
|
||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
View (Version 1)
Gets all views in the server. /v1/view
Gets all views in the server.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the view in the server that matches the ID. /v1/view/{id}
Gets the view in the server that matches the ID.
Available from version: 1.0.0
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Run view of the given type and context information. /v1/view/{id}/refreshResult
Run view of the given type and context information.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Run view with type and id in the server. /v1/view/{id}/result
Run view with type and id in the server.
Available from version: 1.0.0
Call Properties
Path Parameter |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
Create a private filter on the view. /v1/view/{viewId}/filter
Create a private filter on the view.
Available from version: 4.5.0
Call Properties
Path Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1 (Since 4.5.0)
Request URL |
|
Request |
|
Response |
|
Delete a private filter. /v1/view/{viewId}/filter/{filterId}
Delete a private filter.
Available from version: 4.5.0
Call Properties
Path Parameters |
|
|||||||
Response |
|
JSON Samples
Sample 1 (Since 4.5.0)
Request URL |
|
XML Samples
Sample 1 (Since 4.5.0)
Request URL |
|
Update a private filter. /v1/view/{viewId}/filter/{filterId}
Update a private filter.
Available from version: 4.5.0
Call Properties
Path Parameters |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1 (Since 4.5.0)
Request URL |
|
Request |
|
Response |
|
Run view with type and id in the server and apply the filter to it. /v1/view/{viewId}/filter/{filterId}/result
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 |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Response |
|
View (Version 2)
Gets all views in the server. /v2/view
Gets all views in the server.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the view in the server that matches the ID. /v2/view/{id}
Gets the view in the server that matches the ID.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Run view with ID and type in the server. /v2/view/{id}/result
Run view with ID and type in the server.
Available from version: 1.0.0
Call Properties
Path Parameter |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Returns the specified view columns
Request URL |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
Run view with ID and type in the server and apply the filter to it. /v2/view/{viewId}/filter/{filterId}/result
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 |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Returns the specified view columns
Request URL |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
View (Version 3)
Gets all views in the server. Includes basic filter information. /v3/view
Gets all views in the server. Includes basic filter information.
Available from version: 1.0.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the view in the server that matches the ID. /v3/view/{id}
Gets the view in the server that matches the ID.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Run view with ID and type on the server. This version returns the correct unix timestamp for date... /v3/view/{id}/result
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 |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Returns the specified view columns
Request URL |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
Run view with ID and type on the server and apply the filter to it. This version returns the corr... /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 correct unix timestamp for date custom properties.
Available from version: 1.0.0
Call Properties
Path Parameters |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Returns the specified view columns
Request URL |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
View (Version 4)
Gets all views in the server. Includes user privileges. /v4/view
Gets all views in the server. Includes user privileges.
Available from version: 4.6.0
Call Properties
Query Parameters |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the view in the server that matches the ID. Inclues user privileges /v4/view/{id}
Gets the view in the server that matches the ID. Inclues user privileges
Available from version: 4.6.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Run view with ID and category on the server. This version provides an option to return additional... /v4/view/{id}/result
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 |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Returns the specified view columns
Request URL |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
Run view with ID and category on the server and apply the filter to it. This version provides an ... /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 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 |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Returns the specified view columns
Request URL |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
View (Version 5)
Run view with ID and category on the server and apply the filter to it. This version provides an ... /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 option to override the existing filter rule for the view.
Available from version: 6.4.0
Call Properties
Path Parameters |
|
|||||||
Query Parameter |
|
|||||||
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
XML Samples
Sample 1 - Returns the specified view columns
Request URL |
|
Request |
|
Response |
|
Sample 2 - Returns all view columns
Request URL |
|
Request |
|
Response |
|
WorkflowItem (Version 1)
Adds the document or folder to a workflow /v1/workflowItem/
Adds the document or folder to a workflow
Available from version: 1.0.0
Call Properties
Request |
|
|||||||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Removes an item from workflow, leaving the attached object untouched. /v1/workflowItem/{id}
Removes an item from workflow, leaving the attached object untouched.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
JSON Samples
Sample 1
Request URL |
|
XML Samples
Sample 1
Request URL |
|
Gets the workflow queue item stored in the ImageNow server. /v1/workflowItem/{id}
Gets the workflow queue item stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the back workflow queue route for the workflow item. /v1/workflowItem/{id}/backRoute
Gets the back workflow queue route for the workflow item.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the history for the workflow item /v1/workflowItem/{id}/history
Gets the history for the workflow item
Available from version: 6.5.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Puts a workflow item on hold. /v1/workflowItem/{id}/hold
Puts a workflow item on hold.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Create a routing action for a workflow queue item. /v1/workflowItem/{id}/routingAction
Create a routing action for a workflow queue item.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Updates the state of a workflow queue item stored in the ImageNow server. /v1/workflowItem/{id}/state
Updates the state of a workflow queue item stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
XML Samples
Sample 1
Request URL |
|
Request |
|
Gets the upstream workflow queue routes for the workflow item. /v1/workflowItem/{id}/upstreamRoute
Gets the upstream workflow queue routes for the workflow item.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
WorkflowItem (Version 2)
Create a routing action for a workflow queue item. /v2/workflowItem/{id}/routingAction
Create a routing action for a workflow queue item.
Available from version: 1.0.0
Call Properties
Request |
|
|||||||
Response |
|
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 |
|
Request |
|
Sample 2 - Create a parallel routing action for a workflow queue item.
Request URL |
|
Request |
|
Sample 3 - Create an ad hoc parallel routing action for a workflow queue item.
Request URL |
|
Request |
|
XML Samples
Sample 1 - Create a routing action for a workflow queue item.
Request URL |
|
Request |
|
Sample 2 - Create a parallel routing action for a workflow queue item.
Request URL |
|
Request |
|
Sample 3 - Create an ad hoc parallel routing action for a workflow queue item.
Request URL |
|
Request |
|
WorkflowProcessManagement (Version 1)
Retrieves all workflow processes that the user can manage. /v1/management/workflowProcess
Retrieves all workflow processes that the user can manage.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
WorkflowQueue (Version 1)
Gets the specified set of workflow queues for the user stored in the server. /v1/workflowQueue/
Gets the specified set of workflow queues for the user stored in the server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the workflow queue stored in the ImageNow server. /v1/workflowQueue/{id}
Gets the workflow queue stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets all the available workflow queue routes stored in the server. /v1/workflowQueue/{id}/allRoute
Gets all the available workflow queue routes stored in the server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the workflow queue related forms stored in the ImageNow server. /v1/workflowQueue/{id}/form
Gets the workflow queue related forms stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the workflow queue forward routes stored in the ImageNow server. /v1/workflowQueue/{id}/forwardRoute
Gets the workflow queue forward routes stored in the ImageNow server.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
WorkflowQueue (Version 2)
Gets the specified set of workflow queues for the user stored in the server. This version returns... /v2/workflowQueue/
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 |
|
|||||||
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets properties of the workflow queue stored in the server. This version returns key attributes. /v2/workflowQueue/{id}
Gets properties of the workflow queue stored in the server. This version returns key attributes.
Available from version: 1.0.0
Call Properties
Response |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|
Gets the workflow queue related forms stored in the server. /v2/workflowQueue/{id}/form
Gets the workflow queue related forms stored in the server.
Available from version: 1.0.0
Call Properties
Query Parameter |
|
|||||||
Response |
|
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 |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL |
|
Response |
|
XML Samples
Sample 1 - Request without the includeInactive parameter (inactive forms not returned)
Request URL |
|
Response |
|
Sample 2 - Request with the includeInactive parameter (inactive forms returned)
Request URL |
|
Response |
|
Gets the workflow queue forward routes stored in the server. This version also returns destinatio... /v2/workflowQueue/{id}/forwardRoute
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1 - Gets the workflow queue forward routes stored in the server.
Request URL |
|
Response |
|
WorkflowQueue (Version 3)
Gets properties of the workflow queue stored in the server. This version returns key attributes a... /v3/workflowQueue/{id}
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 |
|
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 |
|
Response |
|
XML Samples
Sample 1
Request URL |
|
Response |
|