REST API Documentation

Introduction

Quickstart

The FileBound Web API let's you create and update data with your FileBound system in a REST-ful manner. Requests and Responses are formatted using JSON. This guide has built-in, working samples that you can play with and test yourself - all the jQuery examples on the right side are fully editable, so you can manipulate the requests to target the data you want.

Each request to the FileBound Web API needs to include an authentication GUID, which is provided by the Login endpoint. The next section, Authentication, shows this in detail. Permissions associated with the user who logs in will be applied to any request that contains their GUID.

Most GET requests accept a custom filter. For example, when searching Documents, a Document Filter can be supplied. You can see the full filter reference here.

Interactive Examples

This guide has built-in, editable examples that you can test and use yourself!

DISCLAIMER: Requests ran in this guide are ran against your live site, so edit and delete data at your own risk!

To use the interactive examples, you first need to click Try it! on one of the authentication examples so the page can store an authentication GUID. Once you've logged in successfully, that GUID will be used in any subsequent example - we add the GUID to the request for you, so they are not required in the examples you run.

Adding Content

Want to add a new file or document? Check out the Empty endpoint. Here you can specify whichever object you want, such as file, for the template property. You can use this to get a blank object with default values specified. Here's how you can get an empty group object - no authentication required on this endpoint.

[GET] http://support.filebound.com/api/empty?template=group

                
             ______ _ _      ____                        _
            |  ____(_) |    |  _ \                      | |
            | |__   _| | ___| |_) | ___  _   _ _ __   __| |
            |  __| | | |/ _ \  _ < / _ \| | | | '_ \ / _` |
            | |    | | |  __/ |_) | (_) | |_| | | | | (_| |
            |_|    |_|_|\___|____/ \___/ \__,_|_| |_|\__,_|
             _____  ______  _____ _______            _____ _____
            |  __ \|  ____|/ ____|__   __|     /\   |  __ \_   _|
            | |__) | |__  | (___    | |       /  \  | |__) || |
            |  _  /|  __|  \___ \   | |      / /\ \ |  ___/ | |
            | | \ \| |____ ____) |  | |     / ____ \| |    _| |_
            |_|  \_\______|_____/   |_|    /_/    \_\_|   |_____|

            v8.2.1.5

                
       
    All of the examples you see below are 100% editable,
    you can even change this text!

                
       
    To use the interactive examples below, provide a 
    username and password of a FileBound User. We'll use
    those credentials to authenticate each request.

                
       
                                    |       
                                    |       
                                    |       
                                    |       
                                    |       
                                    |       
                                    |       
                                    |       
                                    |       
                                    |       
                               \    |    / 
                                \       /
                                 \     / 
                                  \   /
                                   \ /

Authentication

Each request to the FileBound REST API must be authenticated using either a Basic Authentication Authorization header, or by providing an authentication GUID in the guid parameter on the querystring.

Note: An authentication GUID is valid for 24 hours. After that, any request to the API which requires authentication will fail with that GUID and you will get a generic "Login Error" message. If you receive this message, you'll need to re-authenticate to get a new GUID.

Basic Authentication

To use Basic Authentication, you must send an Authorization header specifying basic authentication and providing a base-64 encoded username:password string.

Request Headers

Authorization	string with "Basic " + base-64 encoded username password in the format of username:password Ex) Authorization: "Basic YWRtaW46YWRtaW4="

Username/Password Authentication

To get a Login GUID using Username/password Authentication, you must send a POST request to api/login containing a JSON-formatted object with the username and password of the user you wish to authenticate as. You must also specify application/json as the content-type header.

Request Headers

Content-Type	must be application/json Ex) Content-Type: "application/json"

Your URL:

http://support.filebound.com/api/login

Basic Auth Example

It should be noted here that it is not necessary to make a login request with Basic Authentication. This example is just to demonstrate an example of including the Basic Auth header in a request. Requests authenticated with Basic Authentication do not need a GUID, just the Basic Auth header.

jQuery sample:

var cred = $("#username").val() + ":" + $("#password").val();

$.ajax({
    url: 'login',
    type: 'POST',
    beforeSend: function (request) {
        request.setRequestHeader("Authorization", "Basic " + btoa(cred))            
    },
    success: function (loginGuid) {
        return loginGuid;
    },
    error: function () {
        alert('login failed');
    }
});

Example Response - Basic Auth

38773c81-13de-4a55-8819-e0ea882813fa

Username/Password Auth Example

jQuery sample:

var uname = $("#username").val();
var pwd = $("#password").val();

$.ajax({
    url: 'login',
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({ username: uname, password: pwd }),
    success: function (loginGuid) {
        return loginGuid;
    },
    error: function () {
        alert('login failed');
    }
});

Example Response - Username/Password Auth

38773c81-13de-4a55-8819-e0ea882813fa

Filters

The syntax to add a custom filter to a request is simple. Let's look at a request which will retrieve all documents:

[GET] api/documents

But what if you only want Documents that exist in a divider called Applications? For this we must add a custom filter. The custom filter syntax is:

&filter=property1_value1,property2_value2,...

As you can see, the underscore means equals and the commas separate the list of properties to filter on. So if we look at the Document Filter below, we can see there is a divider property. So, a request filtering on the divider property woud look like:

[GET] api/documents?filter=divider_Applications

Now only documents that exist in the Applications divider will be returned. But what if you also want to specify which separator houses the documents? Easy - just add the separator property onto the current filter:

[GET] api/documents?filter=divider_Applications,separator_HR

See the full filter reference below.

Enums

Some object properties are enumeration types. When you request a file from the API and you see the status property has a value of 1, it may be unclear what that means. Server-side, a file's status property is an enumeration, so the value you get back from the API is the numerical representation of that enumeration. Looking at the file object you can see that the status property is of type FileStatus. Navigating to that property shows that 1 means Active. You can see the full enum reference here.

Common Examples

Here are some common examples to get you started.

Working with Projects

Retrieve a list of all projects in your system:

[GET] http://support.filebound.com/api/projects

Retrieve a single project by name:

[GET] http://support.filebound.com/api/projects?filter=name_Invoices

Try these yourself

Working with Files

Search files with a filter:

[GET] http://support.filebound.com/api/files?filter=ProjectId_{projectId},F2=_{Field 2 value}

Create a new file:

[PUT] http://support.filebound.com/api/files

Update a file:

[POST] http://support.filebound.com/api/files/{fileId}

Try these yourself

Working with Documents

Get documents for a file:

[GET] http://support.filebound.com/api/documents?filter=FileId={fileId}

Create a new document:

[PUT] http://support.filebound.com/api/documents/{fileId}

Update a document's metadata:

[POST] http://support.filebound.com/api/documents/{documentId}?setBinaryData=false

Try these yourself

Working with Workflow

Start document down a workflow process:

[PUT] http://support.filebound.com/api/routes/{routeId}?documentId={documentId}&notes={comment}

Advance a routed item in workflow

[PUT] http://support.filebound.com/api/routes/{routedItemId}?stepNumber={stepNumber}&comment={comment}

Try these yourself

Working with Assignments

Get assignments

[GET] http://support.filebound.com/api/assignments

Try these yourself

Working with Routed Items

Get routed items by ID

[GET] http://support.filebound.com/api/routedItems/{routedItemId}

Get routed items by filter

[GET] http://support.filebound.com/api/routedItems?filter=routedObjectId={documentId},status_1

Try these yourself

Working with RouteStepTasks

Get route step tasks for a route step:

[GET] http://support.filebound.com/api/routeStepTasks?filter=routeStepId_{routeStepId}

Try these yourself

Assignments

Get assignments

[GET] http://support.filebound.com/api/assignments

Returns a list of assignments

Get projects with assignments

[GET] http://support.filebound.com/api/assignments/projects

Retrieves the projects that the authenticated user has assignments within

Get assignments example

jQuery sample:


// will return all assignments

$.ajax({
    url: 'Assignments',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Dividers

Get dividers

[GET] http://support.filebound.com/api/dividers

Returns a list of dividers

Get dividers example

jQuery sample:

// will return all the dividers
    
$.ajax({
    url: 'dividers',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

DocumentBinaryData

Get binary data

[GET] http://support.filebound.com/api/documentBinaryData/{documentId}

Get binary data of the document

Parameters

documentId	Int64	Required

Add/update binary Data

[POST] http://support.filebound.com/api/documentBinaryData/{documentId}

Adds a new document, or updates an existing document if documentid is not 0, with the binary data from the body of the request. If documentId is not 0, fileid is not required and the binary data and extension of the associated document will be updated with the data provided. If documentId is 0, then fileid is required and a new document will be created within that file using the binary data and extension provided.

Parameters

documentId	Int64	Required
extension	String	Required
fileId	Int64	Optional

Add document to indexing queue

[PUT] http://support.filebound.com/api/documentBinaryData

Upload a new document to the indexing queue. The binary data from the body of the request is used to create a document in the indexing queue. The extension parameter is required. The projectId parameter is optional, and can be used to assign to a specific project

Parameters

extension	String	Required
projectId	Int64	Optional

Get binary data example

jQuery sample:

$.ajax({
    url: 'DocumentBinaryData/123',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add/update binary data example

HTML sample:

<form method="POST" enctype="multipart/form-data" action="DocumentBinaryData?guid=9e5a2eb0-130e-412d-aeb9-615b3031baec">
    <!-- document ID -->
    <input type="hidden" name="id" value="123" />
    <!-- document extension -->
    <input type="hidden" name="extension" value="txt" />
    <!-- file ID - only required for NEW documents -->
    <input type="hidden" name="fileId" value="456" />

    <input type="file" name="documentToUpload" />

    <input type="submit" value="Upload" />

</form>

Documents

Get documents

[GET] http://support.filebound.com/api/documents

Returns all documents (binary data not populated)

Get document

[GET] http://support.filebound.com/api/documents/{documentId}

Returns the specified document

Parameters

documentId	Int64	Required
binaryData	Boolean	Optional
includeSignatures	Boolean	Optional
signatureType	DocumentSigType	Optional

Get eformdata for document

[GET] http://support.filebound.com/api/documents/{documentId}/eformdata

Returns the eformdata for the specified document

Parameters

documentId	Int64	Required

Get eformdetail for document

[GET] http://support.filebound.com/api/documents/{documentId}/eformdetail

Returns the eformdetail for the specified document

Parameters

documentId	Int64	Required

Get rendition for document

[GET] http://support.filebound.com/api/documents/{documentId}/rendition

Returns a rendition for the specified document

Parameters

documentId	Int64	Required
page	Int32	Optional

Get Document Signatures for document

[GET] http://support.filebound.com/api/documents/{documentId}/documentsigs

Returns a list of the signatures for the specified document

Parameters

documentId	Int64	Required
signatureType	DocumentSigType	Required

Generate Form and add to File

[POST] http://support.filebound.com/api/documents/{fileId}/generateform/{eformId}

Generates a Form from the Eform template, creates it as a Document, and adds it to the File

Parameters

fileId	Int64	Required
eformId	Int64	Required

Add eformdata for document

[PUT] http://support.filebound.com/api/documents/{documentId}/eformdata

Adds a new eformdata record for the specified document

Parameters

documentId	Int32	Required
BODY eformData	EformData	Required

Add eformdetail for document

[PUT] http://support.filebound.com/api/documents/{documentId}/eformdetail

Adds a new eformdetail record for the specified document

Parameters

documentId	Int32	Required
BODY eformDetail	EformDetail	Required

Update eformdata for document

[POST] http://support.filebound.com/api/documents/{documentId}/eformdata

Updates eformdata based on the documentid provided.The eformdata will be matched on the fieldname property, non-matches will be added as new entries.

Parameters

documentId	Int64	Required
BODY eformData	Array of EformData	Required
deleteNonMatches	Boolean	Optional

Update eformdetail for document

[POST] http://support.filebound.com/api/documents/{documentId}/eformdetail

Updates eformdetail based on the documentid provided. The eformdetail will be matched on the fieldName property, non-matches will be added as new entries.

Parameters

documentId	Int64	Required
BODY eformDetail	Array of EformDetail	Required
deleteNonMatches	Boolean	Optional

Update document

[POST] http://support.filebound.com/api/documents/{documentId}

Updates a document based on the documentid provided

Parameters

documentId	Int64	Required
BODY doc	Document	Required
setBinaryData	Boolean	Optional

Add document

[PUT] http://support.filebound.com/api/documents/{fileId}

Adds a new document to the file with the specified fileid. BinaryData must be a byte array or base64 encoded string.

Parameters

fileId	Int64	Required
BODY document	Document	Required

Delete document

[DELETE] http://support.filebound.com/api/documents/{documentId}

Deletes the specified document

Parameters

documentId	Int32	Required

Get comments for document

[GET] http://support.filebound.com/api/documents/{documentId}/comments

Returns the comments for the specified document

Parameters

documentId	Int64	Required

Add comment to document

[PUT] http://support.filebound.com/api/documents/{documentId}/comments

Adds a comment to the specified document

Parameters

documentId	Int64	Required
BODY documentComment	DocumentComment	Required

Group Documents

[PUT] http://support.filebound.com/api/documents/groupDocuments

Groups a set of Documents

UnGroup Documents

[PUT] http://support.filebound.com/api/documents/ungroupDocuments

UnGroup a set of Documents

Removes Documents from Group

[PUT] http://support.filebound.com/api/documents/RemoveDocumentsFromGroup

Removes Document(s) from a Group

Add Documents to Group

[PUT] http://support.filebound.com/api/documents/AddDocumentsToGroup

Adds Document(s) to a Group

Gets Document Grouping Setting

[GET] http://support.filebound.com/api/documents/documentgrouping

Returns the true/false setting for Document Grouping

Get documents

[GET] http://support.filebound.com/api/documents/getdocumentids

Returns all document ids

Get Document Group Information

[GET] http://support.filebound.com/api/documents/documentgroupinformation

Returns the Document Group Information

Get Documents counts

[GET] http://support.filebound.com/api/documents/count

Returns the Documents counts for all separators/dividers in a specified file

Parameters

fileID	Int32	Required
mode	Int32	Required

Get documents example

jQuery sample:

// the file to get documents for:
var docId = 12;

$.ajax({
    url: 'Documents/' + docId,
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get eform data example

jQuery sample:

// Id of the document to get eformdata
var docId = 65;
                
$.ajax({
    url: 'documents/' + docId +'/eformdata',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add Eform Data Example

jQuery sample:

// the document this eform data will be saved to:
var docId = 68;

// the eform object:
var eformdata = {
    "documentID": docId,
    "EformDataId": 0,
    "FieldName": "testfieldname",
    "FieldValue": "test"
                       
};
$.ajax({
    url: 'Documents/' + docId + '/eformdata',
    type: 'PUT',
    contentType: 'application/json',
    data: JSON.stringify(eformdata),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get rendition Example

jQuery sample:

// Id of the document to get rendition
var docId = 1;
                  
$.ajax({
    url: 'documents/' + docId +'/rendition',
    type: 'GET',
    contentType: "image/png",
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Create Document Example

jQuery sample:


// the file this document will be saved to:
var fileId = 293;

// the document object:
var document = {
    "documentID": 0,
    "fileId": fileId,
    "divider": "Example",
    "status": 1,
    "extension": "txt",
    "name": "Example.txt",
    "allowSaveBinaryData": true,
    "binaryData" : "VGhlIGNvbnRlbnQgZm9yIHRoaXMgdGVzdCBwYWdl"      
};

$.ajax({
    url: 'Documents/' + fileId,
    type: 'PUT',
    contentType: 'application/json',
    data: JSON.stringify(document),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Update Document (metadata only) Example

jQuery sample:


// the document to update:
var documentId = 4966;

// the document object:
var document = {
    "fileId": 293,
    "divider": "Example",
    "status": 1,
    "extension": "txt",
    "name": "somethingElse",
    "allowSaveBinaryData": true,
    "notes": "updating notes",
    "binaryData" : null      
};

$.ajax({
    url: 'Documents/' + documentId + '?setBinaryData=false', // < important
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify(document),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

DocumentUpload

Add document(s)

[POST] http://support.filebound.com/api/documentUpload

Allows a form to be posted with multiple files. Document properties will be looked for in hidden fields of the form, such as fileid and status.

EformData

Get all or filtered list of eformdata records

[GET] http://support.filebound.com/api/eformdata

Returns all eformdata

Get eform data example

jQuery sample:

// will return all eformdata

$.ajax({
    url: 'eformdata',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

EformDetail

Get all eformdetail records

[GET] http://support.filebound.com/api/eformDetail

Returns all eformdetail

Get eform detail example

jQuery sample:

// will return all eform detail

$.ajax({
    url: 'eformdetail',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Eforms

Get eforms

[GET] http://support.filebound.com/api/eforms

Gets a collection of eform

Get eform

[GET] http://support.filebound.com/api/eforms/{eformId}

Gets specific eform

Parameters

eformId	Int64	Required

Add eform

[PUT] http://support.filebound.com/api/eforms/{projectId}

Adds a new eform

Parameters

projectId	Int32	Required
BODY eform	Eform	Required

Update structured eform

[POST] http://support.filebound.com/api/eforms/{projectId}

Update a existing structured eform

Parameters

projectId	Int32	Required
BODY eform	Eform	Required
setBinaryData	Boolean	Optional

Get eforms example

jQuery sample:

// will return all eforms

$.ajax({
    url: 'eforms',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Empty

Get json template for object

[GET] http://support.filebound.com/api/empty

Returns a json-formatted string for a given object name (project, file, document, divider)

Parameters

template	String	Optional

Get json template for object example:

jQuery sample:

$.ajax({
    url: 'empty?template=Project',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Files

Get files

[GET] http://support.filebound.com/api/files

Returns all files

Parameters

lineItems	Boolean	Optional

Get files keys only

[GET] http://support.filebound.com/api/files/keysonly

Returns all files keys only

Parameters

lineItems	Boolean	Optional

Get file

[GET] http://support.filebound.com/api/files/{fileId}

Returns the specified file and optionally includes line items

Parameters

fileId	Int32	Required
lineItems	Boolean	Optional

Get all documents in file

[GET] http://support.filebound.com/api/files/{fileId}/documents

Returns a list of documents that exist in the specified file

Parameters

fileId	Int64	Required
binaryData	Boolean	Optional

Get all extra data in file

[GET] http://support.filebound.com/api/files/{fileId}/extradata

Returns a list of extra data that exist in the specified file

Parameters

fileId	Int64	Required

Gets fileid by key value

[GET] http://support.filebound.com/api/files/{projectId}/ByKeyValue

Returns id of the file using key value

Parameters

projectId	Int64	Required
value	String	Required

Update file

[POST] http://support.filebound.com/api/files/{fileId}

Updates the file based on the parameters provided

Parameters

fileId	Int64	Required
BODY file	File	Required

Add file

[PUT] http://support.filebound.com/api/files

Adds a new file

Parameters

BODY file	File	Required

Update file by key value

[POST] http://support.filebound.com/api/files/{projectId}/ByKeyValue

Updates the file based on key value

Parameters

projectId	Int64	Required
BODY file	File	Required

Delete file

[DELETE] http://support.filebound.com/api/files/{fileId}

Deletes the specified file

Parameters

fileId	Int32	Required

Share File Externally

[PUT] http://support.filebound.com/api/files/{fileId}/share

Share File Externally

Parameters

fileId	Int64	Required
expireDate	DateTime	Required

List of File Shares Externally

[GET] http://support.filebound.com/api/files/{fileId}/share

List of File Shares Externally

Parameters

fileId	Int64	Required

Delete File Share Externally

[DELETE] http://support.filebound.com/api/files/{token}/share

Delete File Share Externally

Parameters

token	String	Required

Get all comments in file

[GET] http://support.filebound.com/api/files/{fileId}/comments

Returns a list of comments that exist in the specified file

Parameters

fileId	Int64	Required

Add comment for File

[PUT] http://support.filebound.com/api/files/{fileId}/comments

Adds a new comment for the specified File

Parameters

fileId	Int32	Required
BODY fileComment	FileComment	Required

Search files by filter example

jQuery sample:


$.ajax({
    url: 'Files?filter=ProjectId_1,F2_Test Value',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get all documents in file

jQuery sample:


$.ajax({
    url: 'files/1/documents',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get id of the file by key value

jQuery sample:


$.ajax({
    url: 'files/?filter=1_345',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add file example

jQuery sample:


$.ajax({
    url: 'Files',
    type: 'PUT',
    contentType: 'application/json',
    data: JSON.stringify({ "field": ["not used - ignore", "123", "FileBound Rocks!", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", ""], "notes": "new file added from rest api", projectId: 1}),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Update file example

jQuery sample:



// NOTE:
// when updating files, it'd be safer to GET the file you want, update the appropriate properties,
// and send that file object in the POST - otherwise blank properties will overwrite others if not specified

var fileId = 293; // the file to update

$.ajax({
    url: 'Files/' + fileId,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({ "field": ["not used - ignore", "123456", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", ""], "notes": "notes updated", "projectId": 1 }),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Delete file example

jQuery sample:


    
// the file to be deleted
var fileId = 18; 

$.ajax({
    url: 'Files/' + fileId,
    type: 'DELETE',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Groups

Get groups

[GET] http://support.filebound.com/api/groups

Returns all groups

Get group

[GET] http://support.filebound.com/api/groups/{groupId}

Returns the specified group

Parameters

groupId	Int64	Required

Get projects for group

[GET] http://support.filebound.com/api/groups/{groupId}/projects

Returns all projects associated with the specified group

Parameters

groupId	Int64	Required

Get users for group

[GET] http://support.filebound.com/api/groups/{groupId}/users

Returns all users associated with the specified group

Parameters

groupId	Int64	Required

Get the applied group for the logged in user for supplied ProjectID

[GET] http://support.filebound.com/api/groups/appliedgroup/{projectId}

Returns a group with the merged groups properties of the Logged In User and Project provided

Parameters

projectId	Int64	Required

Add group

[PUT] http://support.filebound.com/api/groups

Adds a new group into the system

Parameters

BODY group	Group	Required

Update group

[POST] http://support.filebound.com/api/groups/{groupId}

Updates the specified group with the group object provided

Parameters

groupId	Int64	Required
BODY group	Group	Required

Delete group

[DELETE] http://support.filebound.com/api/groups/{groupId}

Deletes the specified group

Parameters

groupId	Int32	Required

Add user to group

[PUT] http://support.filebound.com/api/groups/{groupId}/addUser

Adds the specified user to the specified group

Parameters

groupId	Int64	Required
userId	Int64	Required

Removes user from the group

[DELETE] http://support.filebound.com/api/groups/{groupId}/user/{userId}

Removes the specified user from the specified group

Parameters

groupId	Int64	Required
userId	Int64	Required

Search group by filter example

jQuery sample:


// group Id to search for
var groupId = 2;

$.ajax({
    url: 'Groups?filter=GroupId_' + groupId,
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get projects for group example

jQuery sample:


// group Id to get projects assigned to it
var groupId = 2

$.ajax({
    url: 'Groups/'+ groupId +'/Projects',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get users for group example

jQuery sample:


// group Id to get Users belong to this group
var groupId = 2               

$.ajax({
    url: 'Groups/' + groupId + '/Users',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add group example

jQuery sample:


var group = {
        "GroupId": 0,
        "Name": "TestGroup",
        "FileEntry": true,
        "FileEdit": true,
        "FileSearch": true,
        "Status": 1
}; 

$.ajax({
    url: 'groups',
    type: 'PUT',
    contentType: 'application/json',
    data: JSON.stringify(group),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add user example

jQuery sample:


// group Id to add user
var groupId = 8;
    
/ /user to be added to the group
var userId = 2

$.ajax({
    url: 'groups/'+ groupId +'/AddUser?UserId=' + userId,
    type: 'PUT',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Remove user from the group example

jQuery sample:


// group Id to remove user from
var groupId = 8;
    
// user id being removed
var userId = 2

$.ajax({
    url: 'groups/'+ groupId +'/User/' + userId,
    type: 'DELETE',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Login

[POST] http://support.filebound.com/api/login

Login to the system using username and password

Parameters

login	Login	Required

Verify user

[GET] http://support.filebound.com/api/verify

Verifies user

Parameters

userName	String	Required
password	String	Required
extraParams	String	Optional

ProcessRouteRevisions

Get processrouterevisions

[GET] http://support.filebound.com/api/processrouterevisions

Returns all processrouterevisions

Get processrouterevision by publishedrouteid

[GET] http://support.filebound.com/api/processrouterevisions/{publishedRouteId}

Returns the processrouterevision for the specified publishedrouteid

Parameters

publishedRouteId	Int64	Required

Get process route revision example

jQuery sample:


// will return revision of specific published route
var publishedrouteid = 8;

$.ajax({
    url: 'processrouterevisions/' + publishedrouteid,
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Projects

Get projects

[GET] http://support.filebound.com/api/projects

Returns all projects

Get project

[GET] http://support.filebound.com/api/projects/{projectId}

Returns the specified project

Parameters

projectId	String	Required

Get index fields for project

[GET] http://support.filebound.com/api/projects/{projectId}/fields

Returns the list of index fields for the specified project

Parameters

projectId	Int64	Required
includeProjectLinkOptions	Boolean	Optional
includeHidden	Boolean	Optional

Get files for project

[GET] http://support.filebound.com/api/projects/{projectId}/files

Returns the list of files for the specified project

Parameters

projectId	Int64	Required

Get groups for project

[GET] http://support.filebound.com/api/projects/{projectId}/groups

Returns all groups for the specified project

Parameters

projectId	Int64	Required

Get dividers for project

[GET] http://support.filebound.com/api/projects/{projectId}/dividers

Returns a list of dividers for the specified project

Parameters

projectId	Int64	Required

Get routeditems for project

[GET] http://support.filebound.com/api/projects/{projectId}/routeditems

Returns a list of routeditems for the specified project and/or user.

Parameters

projectId	Int64	Required
userId	Int64	Optional
type	Int32	Optional

Get separators for project

[GET] http://support.filebound.com/api/projects/{projectId}/separators

Returns the separator collection for the specified project

Parameters

projectId	Int64	Required

Get assignments for project

[GET] http://support.filebound.com/api/projects/{projectId}/assignments

Returns assignments for the specified project

Parameters

projectId	Int64	Required

Get routes for project

[GET] http://support.filebound.com/api/projects/{projectId}/routes

Returns the route collection for the specified project

Parameters

projectId	Int64	Required
xml	Boolean	Optional
hiddenRoutes	Boolean	Optional

Get file relationships for project

[GET] http://support.filebound.com/api/projects/{projectId}/filerelationships

Returns the file relationships collection for the specified project

Parameters

projectId	Int64	Required

Get distinct extradata for project

[GET] http://support.filebound.com/api/projects/{projectId}/extradata

Returns the extradata collection for the specified project

Parameters

projectId	Int64	Required

Add project

[PUT] http://support.filebound.com/api/projects

Adds a new project

Parameters

BODY project	Project	Required

Add divider to project

[PUT] http://support.filebound.com/api/projects/{projectId}/dividers

Adds a new divider to the specified project

Parameters

projectId	Int64	Required
BODY divider	Divider	Required

Add separator to project

[PUT] http://support.filebound.com/api/projects/{projectId}/separators

Adds a new separator to the specified project (if Separators are enabled)

Parameters

projectId	Int64	Required
BODY separator	Separator	Required

Add file to project

[PUT] http://support.filebound.com/api/projects/{projectId}/files

Adds a new file to the specified project

Parameters

projectId	Int32	Required
BODY file	File	Required

Add files to project

[PUT] http://support.filebound.com/api/projects/{projectId}/listfiles

Adds a new files to the specified project

Parameters

projectId	Int64	Required
BODY files	Array of File	Required

Get Projects Example

jQuery sample:


$.ajax({
    url: 'Projects',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get Project By Name Example

jQuery sample:


$.ajax({
    url: 'Projects?filter=Name_Project 1',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get index field of the project example

jQuery sample:


var projectid = 1;
                    
$.ajax({
    url: 'projects/' + projectid + '/fields',
    type: 'GET',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get groups of the project example

jQuery sample:


var projectid = 1;
                    
$.ajax({
    url: 'projects/'+ projectid +'/groups',
    type: 'GET',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get dividers of the project example

jQuery sample:


var projectid = 1;
                    
$.ajax({
    url: 'projects/'+ projectid +'/dividers',
    type: 'GET',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add project example

jQuery sample:


var project = {
    ProjectId : 0,
    Name : "Test Project",
    ProjectType: "Accounts Payable"
};
                    
$.ajax({
    url: 'projects',
    type: 'PUT',
    contentType: 'application/json',
    data: JSON.stringify(project),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add divider to project Example

jQuery sample:


var projectid = 2;
        
var divider = {
    "dividerId" : 0,
    "name" : "Invoices"
};
                    
$.ajax({
    url: 'projects/' + projectid + '/dividers',
    type: 'PUT',
    contentType: 'application/json',
    data: JSON.stringify(divider),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

ProjectLinks

Get all project links in project

[GET] http://support.filebound.com/api/projectlinks/{projectId}

Accepts RangeBegin and RangeLength

Parameters

projectId	Int64	Required
rangeBegin	Int64	Optional
rangeLength	Int64	Optional

Get project links for project using key(s) exact match

[GET] http://support.filebound.com/api/projectlinks/{projectId}/ByKey

'|' separated for mulitple keys: Accepts RangeBegin and RangeLength

Parameters

projectId	Int64	Required
keys	String	Required
rangeBegin	Int64	Optional
rangeLength	Int64	Optional

Get project links for projects matching searchTerm anywhere in the value

[GET] http://support.filebound.com/api/projectlinks/{projectId}/BySearchTerm

Accepts RangeBegin and RangeLength

Parameters

projectId	Int64	Required
searchTerm	String	Required
rangeBegin	Int64	Optional
rangeLength	Int64	Optional

Get Project Links Example

jQuery sample:

var projectid = 1;

$.ajax({
    url: 'projectlinks/' + projectid + '?RangeBegin=1&RangeLength=10',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get Project Links By Key Example

jQuery sample:

var projectid = 1;

$.ajax({
    url: 'projectlinks/' + projectid + '/bykey?Keys=V001|V974|V835',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get ProjectLinks By Search Term Example

jQuery sample:

var projectid = 1;

$.ajax({
    url: 'projectlinks/' + projectid + '/BySearchTerm?SearchTerm=A198&RangeBegin=3&RangeLength=10',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Query

Custom query

[GET] http://support.filebound.com/api/query/{projectsQuery?}/{filesQuery?}/{documentsQuery?}/{function?}

Returns a collection of projects, files, and documents. Can be used to open a filebound viewer, retrieve binary data, etc.

Parameters

projectsQuery	String	Optional
filesQuery	String	Optional
documentsQuery	String	Optional
function	String	Optional

Custom query example

jQuery sample:


// query/{projectsQuery}/{filesQuery}/{documentsQuery}/{function}
// projectsQuery : A comma-separated query used to filter down Projects. Pass 'all' to get all Projects with no filter." required="yes" default=""
// filesQuery : A comma-separated query used to filter down Files. Pass 'all' to get all Files with no filter." required="yes" default=""
// documentsQuery : A comma-separated query used to filter down Documents. Pass 'all' to get all Documents with no filter." required="yes" default=""
// function : Determines the data returned. See the 'More Info' note below." required="no" default=""                 
                        
var projectFilter = "name_Appeals"; // project name
var fileFilter = "status_1"; //Staus = 1 active files only
var docFilter = "divider_Education"; // filter document by divider name

$.ajax({
    url: 'Query/' + projectFilter + '/' + fileFilter + '/' + docFilter,
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Reports

Get reports

[GET] http://support.filebound.com/api/reports

Returns all reports

Get parameters for report

[GET] http://support.filebound.com/api/reports/{reportId}/parameters

Returns the parameters for a given reportid

Parameters

reportId	Int64	Required

Get parameter for cascade field value

[GET] http://support.filebound.com/api/reports/{projectId}/{fieldNumber}

Returns the cascade field value

Parameters

projectId	Int32	Required
fieldNumber	Int32	Required
cascadeLevel1	String	Optional
cascadeLevel2	String	Optional
cascadeLevel3	String	Optional
cascadeLevel4	String	Optional

Run report

[POST] http://support.filebound.com/api/reports/{reportId}

Runs the specified report with the given list of report parameters

Parameters

reportId	String	Required
BODY paramList	Array of ReportParm	Required

Get reports example

jQuery sample:


         
$.ajax({
    url: 'reports',
    type: 'GET',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Run report example

jQuery sample:


var reportparms = new Array();
reportparms["Name"] = "System Usage";
reportparms["Source"] = "FBReport_SystemUsage";

var reportid = 617;
         
$.ajax({
    url: 'reports/' + reportid,
    type: 'POST',
    contentType: 'application/json',
    data : JSON.stringify(reportparms),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RoutedItems

Get routeditems

[GET] http://support.filebound.com/api/routeditems

Returns all(active) routedItems

Get routeditem

[GET] http://support.filebound.com/api/routeditems/{routedItemId}

Returns a routeditem for the specified routeditemid. If localtreeonly is true, a collection of routed items will be returned for routed items in the local tree, starting with this routeditemid.

Parameters

routedItemId	Int64	Required
localTreeOnly	Boolean	Optional
visualWorkflow	Boolean	Optional

Update routeditem

[POST] http://support.filebound.com/api/routeditems/{routedItemId}

Updates a routeditem based on the routeditemid provided

Parameters

routedItemId	Int64	Required
BODY routedItem	RoutedItem	Required

Completes routed item to another step

[PUT] http://support.filebound.com/api/routeditems/{routedItemId}/complete

Returns the list of tasks for the specified route step

Parameters

routedItemId	Int64	Required
login	Login	Required
stepNumber	Int32	Optional
stepCaption	String	Optional
comment	String	Optional
duedate	DateTime	Optional
userid	Int64	Optional
checklistdata	String	Optional
routeStepId	Int64	Optional
routeStepTaskId	Int64	Optional

Get routed item by id example

jQuery sample:



// the id of the routed item:
var routedItemId = 1032;

$.ajax({
    url: 'RoutedItems/' + routedItemId,
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get Routed Items by Filter Example

jQuery sample:



// This example will return all routed items for the specified document

// the ID of the document to get routed items for
var documentId = 4967;

$.ajax({
    url: 'RoutedItems?filter=routedObjectId_' + documentId + ',status_1',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Routes

Get Routes

[GET] http://support.filebound.com/api/routes

Returns all routes

Parameters

xml	Boolean	Optional
routeId	Int64	Optional
hiddenRoutes	Boolean	Optional

Get route XML

[GET] http://support.filebound.com/api/routes/{routeId}/xml

Return the XML representation of the route specified

Parameters

routeId	Int64	Required

Route document

[PUT] http://support.filebound.com/api/routes/{routeId}

Starts a document down the specified workflow route and returns the routeditem

Parameters

routeId	Int64	Required
documentId	Int64	Required
notes	String	Optional

Route document

[PUT] http://support.filebound.com/api/routes/{documentId}

Routes the specified document to the specified step.

Parameters

documentId	Int64	Required
stepNumber	Int32	Required
password	String	Optional
comment	String	Optional
duedate	DateTime	Optional
userid	Int64	Optional
checklistdata	String	Optional
routeStepId	Int64	Optional
routeStepTaskId	Int64	Optional
selectedList	String	Optional

Route ad-hoc document

[PUT] http://support.filebound.com/api/routes

Routes the specified document to the specified user.

Parameters

documentId	Int64	Required
userId	Int64	Required
routeBack	Boolean	Required
dueDate	DateTime	Required

Start document down workflow example

jQuery sample:



// the ID of the WF process:
var routeId = 7;

// the ID of the document to route:
var documentId = 4967;

// an optional comment to include:
var comment = "starting from rest api";

$.ajax({
    url: 'Routes/' + routeId + '?documentId=' + documentId + '&notes=' + comment,
    type: 'PUT',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Advance a routed item in workflow example

jQuery sample:


// the ID of the routedItem to advance:
var routedItemId = 1034;

// the stepNumber to advance this routedItem to:
var stepNumber = 3;

// an optional comment to include:
var comment = "advancing routed item";

$.ajax({
    url: 'Routes/' + routedItemId + '?stepNumber=' + stepNumber + '&comment=' + comment,
    type: 'PUT',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RouteSteps

Get routesteps

[GET] http://support.filebound.com/api/routesteps

Returns all routesteps

Get routestep

[GET] http://support.filebound.com/api/routesteps/{routeStepId}

Returns the specified routestep

Parameters

routeStepId	Int64	Required

Get tasks for specific step

[GET] http://support.filebound.com/api/routesteps/{routeStepId}/tasks

Returns the list of tasks for the specified route step

Parameters

routeStepId	Int64	Required
firstTaskOnly	Boolean	Optional
routedItemID	Int64	Optional

Get route steps example

jQuery sample:

         
$.ajax({
    url: 'routesteps',
    type: 'GET',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get tasks for specific route step example

jQuery sample:


var routestepid = 100;

$.ajax({
    url: 'routesteps/' + routestepid + '/tasks',
    type: 'GET',
    contentType: 'application/json',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RouteStepTasks

Get routesteptasks

[GET] http://support.filebound.com/api/routesteptasks

Returns all routesteptasks

Get routesteptask

[GET] http://support.filebound.com/api/routesteptasks/{routeStepTaskId}

Returns the specified routesteptask

Parameters

routeStepTaskId	Int64	Required

Get route step tasks example

jQuery sample:


$.ajax({
    url: 'RouteStepTasks',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Search

Key field search

[GET] http://support.filebound.com/api/search

Search through all projects to find matching key fields of files

Parameters

query	String	Required

Key field search example

jQuery sample:


var keyvalue = '345';

$.ajax({
    url: 'search?Query=' + keyvalue,
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Separators

Get separators

[GET] http://support.filebound.com/api/separators

Returns all separators

Get separators example

jQuery sample:

         
$.ajax({
    url: 'separators',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Users

Get users

[GET] http://support.filebound.com/api/users

Returns all users

Get user

[GET] http://support.filebound.com/api/users/{userId}

Returns the specified user

Parameters

userId	Int64	Required

Get user by fbguid

[GET] http://support.filebound.com/api/users

Returns the specified user

Parameters

fbguid	String	Required

Get groups for user

[GET] http://support.filebound.com/api/users/{userId}/groups

Returns all groups for the specified user

Parameters

userId	Int64	Required

Get routeditems for user

[GET] http://support.filebound.com/api/users/{userId}/routeditems

Returns all routeditems for the specified user

Parameters

userId	Int64	Required

Get assignments for user

[GET] http://support.filebound.com/api/users/{userId}/assignments

Returns assignments for the specified user

Parameters

userId	Int64	Required

Update user

[POST] http://support.filebound.com/api/users/{userId}

Updates the existing user

Parameters

userId	Int64	Required
BODY user	User	Required
groups	String	Optional

Add user

[PUT] http://support.filebound.com/api/users

Adds a new user

Parameters

BODY user	User	Required
groups	String	Optional

Get user by id example

jQuery sample:


var userid = 2;

$.ajax({
    url: 'Users/' + userid,
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get routed items for user example

jQuery sample:


var userid = 2;

$.ajax({
    url: 'Users/' + userid + '/routeditems',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Add user example

jQuery sample:


var user = {
    "userId" : 0,
    "Name" : "TestUser",
    "password" : "testuser",
    "Email" : "testuser@gmail.com"
};

$.ajax({
    url: 'Users',
    type: 'PUT',
    contentType: 'application/json',
    data : JSON.stringify(user),
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Version

Get filebound version

[GET] http://support.filebound.com/api/version

Returns the current version information about this filebound system

Get filebound's database version

[GET] http://support.filebound.com/api/version/GetDatabaseCulture

Returns the current version information about this filebound system

Get filebound's database version

[GET] http://support.filebound.com/api/version/GetServerTimeZone

Returns the current version information about this filebound system

Get filebound version example

jQuery sample:


$.ajax({
    url: 'version',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Workflow

Get workflow task buttons

[GET] http://support.filebound.com/api/workflow/{routedItemId}/buttons

Returns styled and functional buttons (as html) for a given assignment. Includes the required javascript but you can specify whether or not jquery/jquery ui get included as well.

Parameters

routedItemId	Int64	Required
includeJquery	Boolean	Optional
includeJqueryUI	Boolean	Optional
callback	String	Optional

Get workflow buttons example

jQuery sample:


var routeditemid = 1238;

$.ajax({
    url: 'workflow/' + routeditemid + '/buttons',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Assignment

TaskId Int64	Id of the task
Fields List`1	List of index fields
Tasks List`1	List of assignment tasks
ProjectName String	Name of the project
Url String	Site url
FileId Int64	Id of the file
ProjectId Int64	Id of the project

AssignmentAction

Icon String	Icon of the action
Caption String	Caption for the assignment action
Action AssignmentActionType	Type of the action
Browseable Boolean	Flag which denotes that action is browseable or not
RouteStepId Int64	Id of the Route Step
Authenticate Boolean	Flag which defines authentication
Notes Boolean	Notes for assignment action
Prompt String	Prompt for action
ChecklistRouteStepTaskId Int64	Id of checklistroutesteptask
ActionLink String	Link of the action

Divider

AliasName String	Alias name of the divider
CustomSort String	Sorts items in collection based on the property defined as a custom sort
DividerId Int64	Id of the divider
ExtendedProperties FBCollection	Extended properties of the divider
IsDefault Boolean	Is divider is selected as default
Id Int64	Id of the divider
MasterSheet Boolean	Mastersheet is enabled or not
MasterSheetEntry String	Entry of master sheet
MasterSheetFooter String	Footer of master sheet
MasterSheetHeader String	Header of master sheet
Name String	Divider name
NormalizedName String	Normalized name of the divider
ObjectType Int32 (ReadOnly)	Type of the object
OriginalName String (ReadOnly)	Original name
ProjectId Int64	Id of the project associated with this divider
Required Boolean	Is divider is required or not
Separator String	Separator associated with this divider
SortOrder Int64	Sort Order for the divider
Status Int32	Status of the divider
SyncFlag ObjectSyncFlag	Sync flag for the divider
ViewerContext ViewerContextType	Context of the viewer
Access AccessRights	Access rights of the divider
TotalCount Int64	Total count of the dividers

Document

AllowSaveBinaryData Boolean	Allows to save binary date or not
AnnotationSize Int64	Size of annotation(s) applied on the document
Archive String	Name of the archive in which this document resides
ArchiveId Int64	Id of the archive in which this document resides
BatchDate DateTime	Date of the batch to which this document belongs.
BinaryData Byte[]	Binary data of the document itself
CanSave Boolean	Flag that denotes whether or not this document can be saved using the normal save method
ChangedSinceLastArchive TriState	State of the document it changed since last archive
ChunkSize Int32	Size of the chunk in KB. Used while uploading the document in chunks
Cleaned Boolean	Flag denoting whether or not the server has cleaned up the document from the drive if deleted
CustomSort String	Custom sort order of the documents
DateCreated DateTime	Date the document was created
DateCreatedFrom DateTime	The date from value to use for searching based on when the document was created.
DateCreatedString String	The date from value to use for searching based on when the document was created
DateCreatedTo DateTime	The date to value to use for searching based on when the document was created.
DateFiled DateTime	Date on which document was filed.
DateFiledFrom DateTime	The date from value to use for searching based on when the document was filed
DateFiledTo DateTime	The date to value to use for searching based on when the document was filed.
DateFiledString String	Date on which document was filed
Description String	Description for the document
Divider String	Divider in which document resides
DocPtr Int64	Id of document for which these documents are a pointer
DocSetCount Int64	Count of document set
DocSetGUID Guid	Guid of the document set
DocSetRole DocSetRole	Role of the particular document in a document set
DocumentDate DateTime	Date of the document
DocumentId Int64	Id of the document
DocumentGroupId Int64	Id of the group of documents
DocumentRevId Int64	Document revision id
DocumentSigs FBCollection	Signature(s) of the document
DocumentSize Int64	Size of the document
EformComplete DateTime	Completion date of the eform
EformDue DateTime	Due date of eform
EformId Int64	Id of the eform
Encrypted Boolean	Flag for document is encrypted or not
ExtendedProperties FBCollection	Extendedproperties of the document
Extension String	Extension of the document which defines type of the document
FileId Int64	Id of the file in which document resides
FullText String	Full text (OCR content) of the document
Id Int64	Id of the document
IsAutoIndexable Boolean	Flag for document is auto indexable or not
IsImage Boolean	Whether document is type of image or not
IsIndexing Boolean	Flag that denotes whether or not this document is in the indexing queue
IsMasterSheet Boolean	Whether or not to include master sheets in the document list
IsMultimedia Boolean	Flag that denotes whether or not this document is a multimedia document (WMA, WMV, MPEG, etc)
IsMultipageImage Boolean	Flag that denotes whether or not this document is an image and is multi-page.
IsText Boolean	Flag that denotes whether or not this document is a text file (TXT)
IsTIFF Boolean	Flag that denotes whether or not this document is a TIF image
IsWeb Boolean	Flag that denotes whether or not this document is a web page (HTM, HTML, etc)
IsWebEform Boolean	Flag that denotes whether or not this document is an HTML Form
IsRecordDeclared Int32	Flag that denotes whether or not this document is declared as a record
LastView DateTime	Date this document was last viewed
LastViewFrom DateTime	From date this document was last viewed
LastViewTo DateTime	To date this document was last viewed
LockedBy Int64	User who has locked this document. 0 if none.
LockedByUserId Int64	Id of the user who has locked this document. 0 if none.
Name String	Name of the document
Notes String	Document notes
NotRoutedBy String	Routeid by which the document(s) have not been routed.
ObjectType Int32 (ReadOnly)	Type of object
Pages Int64	Number of pages contained in this document
Path String	Path this document was read from.
PhysicalLocation String	Physical location of the document
PopulateBinary String	Whether or not to populate the binary data when filling the collections.
ProcessStepId Int64	Id of the process step the document(form) was generated from
ProgressPercentage Int32	Gets the progress percentage while async document upload/download
ProgressState String	Gets the state of the progress while async document upload/download
RelProjectId Int64	Id of the project in which this document is queued up for indexing(only for un-indexed documents)
RelProjectName String	Name of the project in which this document is queued up for indexing(only for un-indexed documents)
RemoteID Int64	Remote id of this document
ReportText String	The text value to search for in searching when reportfieldtype is a text field
ReportNumericFrom Single	The numeric FORM value to search for in searching when reportfieldtype is a number field.
ReportNumericTo Single	The numeric TO value to search for in searching when reportfieldtype is a number field.
ReportDateFrom DateTime	The date FROM value to search for in searching when reportfieldtype is a date field.
ReportDateTo DateTime	The date TO value to search for in searching when reportfieldtype is a date field.
ReportColumnFrom Int32	The column FROM which to begin searching for values when using searching.
ReportColumnTo Int32	The column TO which to begin searching for values when using searching.
ReportFieldType FieldType	The type of search to use (text, number or date)
RevDocumentId Int64	The document id this document is a revision of.
SaveNotesOnly Boolean	Flag that specifies whether or not to save only the notes
SaveStyle DocumentSaveStyle	How the document will be saved
Secured Boolean	Flag that speifies whether or not this document is secured
Separator String	Separator in which this document resides
SortOrder Int64	Order in which this page is shown in the file/separator/divider
Status DocumentStatus	Status of the document
StreamingMode Boolean	Streaming mode of the document
SupportsAnnotations Boolean	Flag that denotes whether or not this document supports annotations
SyncFlag ObjectSyncFlag	Sync flag for document
UserCreated Int64	Id of user who created this document
UserFiled Int64	Id of user who last saved this document
UserNameCreated String	Name of user who created this document
UserNameFiled String	Name of user who last saved this document
ViewerContext ViewerContextType	Type of viewer context
WithoutEformId Int64	Without eform id
TotalCount Int64 (ReadOnly)	Total count of items in document collection

DocumentComment

CustomSort String	Sorts items in collection based on the property defined as a custom sort
DocumentCommentId Int64	Id of the document comment with which this data is associated
DocumentId Int64	Id of the document with which this data is associated
UserId Int64	Id of user who made the comment
UserDisplayName String	Display Name of user who made the comment
CommentDate DateTime	Date comment was made
CommentText String	The actual comment
ExtendedProperties FBCollection	Extended properties of the eform data
Id Int64	Id of the document comment
SyncFlag ObjectSyncFlag	Sync flag for eform data
ViewerContext ViewerContextType	Viewer context
TotalCount Int64 (ReadOnly)	Total count of the items in eform data collection
ObjectType Int32 (ReadOnly)	Type of the object

Eform

BinaryData Byte[]	Binary data that is the actual Form template (Word Document, HTML Page, etc)
CreateFileOnly Boolean	Whether or not this Eform creates ONLY a File (no document) on submission
CustomSort String	Sorts items in collection based on the property defined as a custom sort
DateChanged DateTime	Date this Form was last changed
DetailEformId Int64	Id of the form to use as form's detail form
DetailEformName String	Detail form name
Divider String	Divider in which this eform resides
EformId Int64	Id of the eform
ExtendedProperties FBCollection	Extended properties of the eform
Extension String	Extension of the eform
ExtraData String	Extra data of the eform
Hidden Boolean	Whether or not this eform is to be hidden
Id Int64	Id of the eform
InFormsMenu Boolean	Whether or not this eform is to be added in Forms menu
IsWeb Boolean (ReadOnly)	Flag that denotes whether or not this form is a web page (HTM, HTML, etc)
Name String	Name of the eform
OfflineEnabled Boolean	Whether or not this eform is available to download for offline use on the forms portal
ObjectType Int32 (ReadOnly)	Type of object
Portal Boolean	Whether or not this eform should appear in the portal
ProjectId Int64	Id of the project in which contains this form
RelSubmissionFormId Int32	Id of a submission form that this form is tied to.
SecurityMode PortalSecurityMode	Security mode for the eform
Separator String	Separator in which to file documents generated via this form
ShareData Boolean	Whether or not this eform shares its data with other eforms in the same file
SyncFlag ObjectSyncFlag	Sync flag for this eform
Type EformType	The type of eform, will either be web or structured. Older forms are considered structured
UsageType EformUsageType	Usage type for the eform (will either be submission or view/edit)
UseEformName Boolean	Whether or not this eform name is to be used for display in viewers.
ViewerContext ViewerContextType	Type of viewer context
WebLayout EformWebLayout	Web layout for eforms (notchoosenyet/responsive/regular)
TotalCount Int64 (ReadOnly)	Total count of the items in eform collection
InCategory Boolean	Category in which eform resides
Status EformStatus	Status of the Eform
MajorVersion Int32	Major Version of the eform
MinorVersion Int32	Minor Version of the eform
RevisionParentID Int64	The ID of the Parent eform of this Revision
Published Int32	Whether or not this eform is Published in the system.
IsFileBoundUser Boolean	Whether or not this eform filebound user or not.

EformData

CustomSort String	Sorts items in collection based on the property defined as a custom sort
DocumentId Int64	Id of the document with which this data is associated
EformDataId Int64	Id of the eform data
ExtendedProperties FBCollection	Extended properties of the eform data
FilledDate DateTime	Date this data was filled
FieldName String	Name of the field (variable)
FieldValue String	Value of the field (variable)
Id Int64	Id of the eform
LastUpdated DateTime	The last time this eformdata was updated
LastUpdatedBy Int64	The last user to have updated this eformdata
ProcessId Int64	Id of the process by which this data was generated
Separator String	Separator with which this eform data is associated
SyncFlag ObjectSyncFlag	Sync flag for eform data
ViewerContext ViewerContextType	Viewer context
TotalCount Int64 (ReadOnly)	Total count of the items in eform data collection
ObjectType Int32 (ReadOnly)	Type of the object

EformDetail

CustomSort String	Sorts items in collection based on the property defined as a custom sort
EformDetailId Int64	Id of the eform detail
DocumentId Int64	Id of the document with which this detail is associated
ExtendedProperties FBCollection	Extended properties of the eform detail
FilledDate DateTime	Date this detail was filled
FieldName String	Name of the field (variable)
FieldValue String	Value of the field (variable)
Id Int64	Id of the eform
Row Int64	Row number in the detail form in which this data resides
LastUpdated DateTime	The last time this eformdetail was updated
LastUpdatedBy Int64	The last user to have updated this eformdata
SyncFlag ObjectSyncFlag	Sync flag for the eform detail
ViewerContext ViewerContextType	Viewer context
TotalCount Int64 (ReadOnly)	Total count of items in eform detail collection
ObjectType Int32 (ReadOnly)	Type of the object

FBCollection

TotalCount Int64 (ReadOnly)	The total count of records in this collection
Collection Object	The collection

Field

CustomSort String	Sorts items in collection based on the property defined as a custom sort
DefaultValue String	The default value this field will have on new file entry
Display Boolean	Flag that determines whether or not to display the field in lists
DoubleEnter Boolean	Flag that determines whether or not this field will need to be entered twice for confirmation
EnableFBDrive Boolean	True/false if this field is used in the fbdrive configuration
ExtendedProperties FBCollection	Extened properties of the field collection
FbDriveSortOrder Int32	Zero-based index of where this field is in the filebound drive configuration
FieldId Int64	Id of the field
FieldOptions ArrayList	List of options that this field has available (option list fields only)
FieldAccessSecurity String	Security to access this field
FieldValue String	Value in this field
Id Int64	Id of the field
KeyField Boolean	Flag that denotates whether this field is configured as a key field or not
KeyVisualField Boolean	Flag that denotates whether this field is configured as a key visual field or not
KeyVisualMask String	Mask applied on key visual field
Mask String	Mask applied on this field
MaxLen Int64	The maximum acceptable length for the value in this field. 0 = no limit
MinLen Int64	The minimum acceptable length for the value in this field.
Name String	Name of the field
Number Int32	Number of the field
Order Int64	Order of the field
ObjectType Int32 (ReadOnly)	Type of the object
ProjectId Int64	Id of the project which contains this field
ProjectLinkId Int64	The id of the project this field is a projectlink to
ProjectLinkData List`1	List of project link data
RemoteId Int64	Remote id of this field
Required Boolean	Flag that determines whether or not this field is required on entry
SepRelation Boolean	Flag that determines whether or not this field is related to separator selections
ShowOnHomePage Boolean	Flag that determines whether or not this field will show on the home page for routed items
SortField Boolean	Flag that determines whether or not this field is the main sort field in this project
StorePLinkDataset Boolean	Store temporary project link dataset until object reset.
Type FieldType	Type of the field
Unique Boolean	Flag that determines whether or not the values in this field are to be unique
SyncFlag ObjectSyncFlag	Sync flag for field
Tag Object	Tag for field
ViewerContext ViewerContextType	Viewer context
TotalCount Int64 (ReadOnly)	Total number of items available in the field collection
Value String	Value of the field (used by OEM only)
CascadeOptProjectId Int64	[no description available]
CascadeParentField Int32	[no description available]
CascadeFieldData List`1	[no description available]
RelatedProject Int32	[no description available]
RelatedKeyField Int32	[no description available]
RelatedKeyVisualField Int32	[no description available]
CascadeLevel Int32	[no description available]
ProjectLinkHasMask Boolean	[no description available]
CalculationFormula String	[no description available]
LineItemSumField Int64	[no description available]
MinimumValue Nullable`1	[no description available]
MaximumValue Nullable`1	[no description available]
DisplayLeadingZero Boolean	[no description available]
DecimalSeparator String	[no description available]
ThousandthsSeparator String	[no description available]
LabelCharacter String	[no description available]
TrailingLabelCharacter String	[no description available]
DecimalDigits Int32	[no description available]
DecimalRounding Int32	[no description available]

FieldSecurity

AccessRights Int64	The Access restrictions for the field security
CustomSort String	Sorts items in collection based on the property defined as a custom sort
ExtendedProperties FBCollection	Extened properties of the field collection
FieldNumber Int64	The number of the field associated with the field security
FieldSecurityId Int64	Id of the fieldsecurity
GroupId Int64	Id of the group associated with the field security
Id Int64	Id of the field security
ProjectId Int64	Id of the project associated with the field security
SyncFlag ObjectSyncFlag	Sync flag of the field security
ViewerContext ViewerContextType	Viewer context
TotalCount Int64 (ReadOnly)	Total items in the collection
ObjectType Int32 (ReadOnly)	Type of the object

File

BoxId Int64	Id of the box associated with file
ChangedBy Int64	Id of the user who have changed file
CustomSort String	Sorts items in collection based on the property defined as a custom sort
DateChanged DateTime	Date changed of the file
DateStarted DateTime	Started date of the file
Destruction DateTime	Destruction date of the file
DocumentCount Int64	Number of documents available in this file
Documents FBCollection	Document collection available in this file
ExtraData FBCollection	Extra data collection of the file
ExtendedProperties FBCollection	Extended properties of the file
FieldDefs FBCollection	Defination of the fields associated with this file
Field String[]	Array of field having index values of this file
FormattedField String[]	Array of field formatted for numbers having index values of this file
FileId Int64	Id of the file
FilePtr Int64	File pointer
FileVerifyLevels Int64	File verification levels
Id Int64	Id of the file
IsIndexed Boolean	Flag to determine whether the file is indexed or not
IsPartialIndexed Boolean	Flag to determine whether the file is partially indexed or not
KeyValue String	Value of key field
KeyVisualValue String	Value of key visual field
LabelPrinted DateTime	Date and time of label printed for this file
LineItems FBCollection	Line items associated with this file
Notes String	Notes of this file
ObjectType Int32 (ReadOnly)	Type of object
ProjectId Int64	Id of the project which contains this file
ProjectName String	Name of the project which contains this file
Project Project	Project which contains this file
RouteInfo RoutedItem	Routed Item information
RoutingDoc Document	Document of the file which is getting routed
RemoteId Int64	Remote id of the file
SaveNotesOnly Boolean	Flag to save only notes for this file
EnableAdhocRouting Boolean	Whether Adhoc Routing is enabled or not
SaveStyle FileSaveStyle	Save style of this file
Status FileStatus	Status of this file
SyncFlag ObjectSyncFlag	Sync flag of this file
TotalDocumentCount Int64	Total number of documents in this file
ViewerContext ViewerContextType	Viewer context
TotalCount Int64 (ReadOnly)	Total number of files in file collection
LockedBy Int64	Id of the user who has locked this file
FileFieldValues FBCollection	FileFieldValue collection for Additional Fields in this file

FileComment

CustomSort String	Custom Sort for Filter
Id Int64	Id of the File Comment
SyncFlag ObjectSyncFlag	Sync flag of this File Comment
ViewerContext ViewerContextType	Viewer context
ExtendedProperties FBCollection	Extended properties of the File Comment
TotalCount Int64 (ReadOnly)	Total number of files in File Comment Collection
ObjectType Int32 (ReadOnly)	Type of object
FileID Int64	Id of the File
FileCommentID Int64	Id of the File Comment
UserID Int64	Id of the User
UserDisplayName String	Display Name of the User
CommentDate DateTime	Date Comment was made
CommentText String	Text of the Comment

FileRelation

ObjectType Int32 (ReadOnly)	Type of the object
TotalCount Int64 (ReadOnly)	Total count for this File Relationship
ExtendedProperties FBCollection	Extended properties collection of File Relationship
ViewerContext ViewerContextType	Context of the viewer
ProjectId Int64	Id of the project which contains this File Relationship
Id Int64	Id of the File Relationship
Status Status	Status of this File Relationship
SyncFlag ObjectSyncFlag	Sync flag of the File Relationship
CustomSort String	Sorts items in collection based on the property defined as a custom sort
RelatedProjectID Int64	ID of Related Project for this File Relationship
IsDeleteRelatedFiles Boolean	Delete Related Files When Parent File is Deleted
ImportMode ImportMode	Import Mode of Relationship
MainProjectField Int64	Mapped Field in Main Project
RelatedProjectField Int64	Mapped Field in Related Project
MainTotalField Int64	Total Field in Main Project to compare to sum
RelatedTotalField Int64	Total Field in Related Project to sum
LineQuantityField Int64	Line Item File Quantity Field
LineAmountField Int64	Line Item File Amount Field
LineTotalField Int64	Line Item File Total Field
IsAdvanceMode Boolean	Enable Advanced Indexing Mode
OpenFileViewer Boolean	Allow User To Open Up Related File In Viewer
GLProjectID Int64	GL Code Project ID
GLKeyField Int64	GL Code Project Key Field
GLKeyVisualField Int64	GL Code Project Key Visual Field
LookupProjectID Int64	On Upload - Lookup Project ID
LookupFields String	On Upload - Lookup Fields Mapping
UpdateProjectID Int64	On Upload - Update Project ID
UpdateFields String	On Upload - Update Fields Mapping
Rights Rights	All User, Admin Only, or Group Security Flag
ExtraData String
ProjectName String	Main Project Name
RelatedProjectName String	Related Project Name
FileRelationshipName String	File Relationship Name
DateCreated DateTime	Date Relationship created
UserCreated Int64	User who created the Relationship
LastModifiedDate DateTime	Date of last modification of the Relationship
LastModifiedUser Int64	User who last modified the Relationship

FileSecurity

CustomSort String	Sorts items in collection based on the property defined as a custom sort
ExtendedProperties FBCollection	Extended properties of the file security
FieldNumber Int64	Find an item in the collection by field number
FileSecurityId Int64	Id of the file security
GroupId Int64	The id of the group associated with the file security
Id Int64	Id of the file security
Indexes String	The Index restrictions for the file security
ProjectId Int64	The id of the project associated with the file security
SyncFlag ObjectSyncFlag	Sync flag of the file security
ViewerContext ViewerContextType	Context of the viewer
TotalCount Int64 (ReadOnly)	Total number of file securities
ObjectType Int32 (ReadOnly)	Object type

Group

AccessServerTemplates Boolean	Whether or not users in this group get access server templates rights
AddNewFilesToClipboard Boolean	Whether or not users in this group have their newly entered files placed on their clipboard
EditAndDeleteAnnotations EditDeleteAnnotationRights	Whether or not users in this group can access all/own annotations
AddAndSaveAnnotations Boolean	Whether or not users in this group can add and save annotations
BurnInAnnotations Boolean	Whether or not users in this group can burn in annotations
ShowHideAnnotations Boolean	Whether or not users in this group get the ability to manage unindexed documents.
AllowTemporaryAnnotations Boolean	Whether or not users in this group can draw annotations on a document for that session
CustomSort String	Sorts items in collection based on the property defined as a custom sort
DataManager Boolean	Whether or not users in this group get rights to use standard scanning applications
Dividers FBCollection	Dividers associated with this group
DisplayIndexingQueueDocs IndexingQueueDocs	Property to show up diplaying of indexing queue docs whether to all users or global indexing user only.
DocDelete Boolean	Whether or not users in this group get document delete rights
DocRecycle Boolean	Whether or not users in this group get document recycle rights
DocEdit Boolean	Whether or not users in this group get document save rights
DocEditOcr Boolean	Whether or not users in this group get the ability to alter OCR text
DocManageUnindexed Boolean	Whether or not users in this group get the ability to manage unindexed Documents
DocExport Boolean	Whether or not users in this group get document export rights
DocPrint Boolean	Whether or not users in this group get document print rights
DocSecure Boolean	Whether or not users in this group get document secure rights
DocSend Boolean	Whether or not users in this group get document send (email) rights
DocSign Boolean	Whether or not users in this group get document signing rights
DocUnsecure Boolean	Whether or not users in this group get document un-secure rights
DocView Boolean	Whether or not users in this group get document view rights
ExtendedProperties FBCollection	Extended propery collection for group
GroupId Int64	The id of this group
Id Int64	Id of the group
IntegrationKit Boolean	Whether or not users in this group get integration kit rights
Mass Boolean	Whether or not users in this group get mass entry rights
Name String	Name of the group
ObjectType Int32	Type of object
ProjectAdmin Boolean	Whether or not users in this group get project admin rights
Reporting Boolean	Whether or not users in this group get reporting rights
FieldSecurities FBCollection	Field securities collection of this group
FileDelete Boolean	File deletion rights
FileRecycle Boolean	File recycle rights
FileEdit Boolean	Whether or not users in this group get file edit (edit only) rights
FileEntry Boolean	Whether or not users in this group get file entry (add/edit) rights
FileTracking Boolean	Whether or not users in this group get file tracking (ability to check files in and out) rights
FileTransfer Boolean	Whether or not users in this group get file transfer (transfer checkout from one user to another) rights
FileSearch Boolean	Whether or not users in this group get file view rights
FileSecurities FBCollection	file securities collection
LastUpdated DateTime	Date this Group was last saved
LastUpdatedBy Int64	By whom this Group was last saved
Projects FBCollection	Projects assigned to this group
QcFiles Boolean	Whether or not users in this group get the ability to manage unindexed Documents.
SaveTemplatesToServer Boolean	Whether or not users in this group get save templates to server rights
Status Int32	Status of the group
Tag Object	Tag for the group
WorkflowInit Boolean	Whether or not users in this group get workflow initiation rights
WorkflowManage Boolean	Whether or not users in this group get workflow management rights
WorkflowAssignmentManagement Boolean	Whether or not users in this group get workflow assignment management rights
WorkflowReporting Boolean	Whether or not users in this group get workflow reporting rights
LockingRights Boolean	Whether or not users in this group get locking rights
SyncFlag ObjectSyncFlag	Sync flag for the group
ViewerContext ViewerContextType	Context of the viewer
FileShareExternally Boolean	Whether or not users in this group can share file externally
DocumentShareExternally Boolean	Whether or not users in this group can share document externally
TotalCount Int64 (ReadOnly)	Total count of items available in group collection

Login

UserName String	User name to login
Password String	Password to login
RememberMe Boolean	Flag for rememering me for next time login

ProcessRouteRevision

Created DateTime	Date and time revision Created
CreatedByUserId Int64	Id of the user who created this revision
CreatedByUserName String	Name of the user who created this revision
CustomSort String	Sorts items in collection based on the property defined as a custom sort
Diagram String	Stored XML representation of this revision's diagram
DisplayName String	The display name of the revision parent route
DocumentsInProcess Int64	Number of documents currently in this process route
ExtendedProperties FBCollection	Extended properties collection for process route revisions
FullVersion String (ReadOnly)	Full version of the process route revision
Hidden Boolean	Determines whether the process route revision is hidden or not
Id Int64	Id of the process route revision
LoadDiagram Boolean	Include loading of the revision's diagram XML from the database.
Major Int32	Major version of the revision
Minor Int32	Minor version of the revision
Notes String	Notes for this Revision
ObjectType Int32 (ReadOnly)	Type of object
ParentRouteId Int64	Id of the parent route
ParentRouteName String	Name of the parent route
ParentRouteType RouteType	Type of the parent route
ProcessRouteRevisionId Int64	Id of the process route revision
Published Boolean	Whether or not this revision was published to a process route
PublishedRouteId Int64	Id of the published route
RouteId Int64	Id of the route
SyncFlag ObjectSyncFlag	Sync flag
ViewerContext ViewerContextType	Context of the viewer
TotalCount Int64 (ReadOnly)	Total number of process route revisions

Project

AdminOnly Boolean	Flag that denotes admin only rights
AllowManualDeclaration Int32	Allow manual declaration for records
AllowUnsign Boolean	Whether or not to allow users to un-sign a documens once it is signed
CustomSort String	Sorts items in collection based on the property defined as a custom sort
BatchEmails String	Email address for sending batch upload notifications
DividerLabel String	Specifies the text to use for divider labels
Dividers FBCollection	Divider collection of this project
DocuSignEnabled Boolean	Whether or not the docusign integration is enabled for this project
EnableBoxes Boolean	Whether or not to enable box tracking functions in interface
EnableCAR Boolean	CAR functionis enable or not
EnableDividerMemory Boolean	Whether or not to remember dividers added to this project
EnableDividerSecurity Boolean	Divider security is enabled or not for this project
EnableFBDrive Boolean	FBDrive component (WebDAV) is enabled or not for this project
EnableFieldSecurity Boolean	Field security is enabled or not for this project
EnableFileTracking Boolean	File tracking is enabled or not for this project
EnableFullText Boolean	Full text is enabled or not for this project
EnableInteractiveRevisions Boolean	Whether or not to allow users who have document edit rights to edit document information on revisions
EnableManualDividerEntry Boolean	Whether or not to allow manual entry of dividers in this project
EnableManualSeparatorEntry Boolean	Whether or not to allow manual entry of separators in this project
EnableMultiKeySearch Boolean	Whether or not to enable multi-key text searching for this project
EnableRevisions Boolean	Whether or not to enable document revisioning for this project
EnableSeparatorMemory Boolean	Whether or not to remember separators added to this project
EnableSeparators Boolean	Whether or not to enable multi-level indexing
EnableSeparatorSecurity Boolean	Whether or not to enable separator security for this project
EnableTaskManager Boolean	Whether or not to enable task manager functions for this project
EnableWFQueueSelection Boolean	Whether or not to allow users to select the workflow queue to work on
ExtendedProperties FBCollection	Extended properties collection of project
FBDriveShowAllSeparatorsAndDividers Boolean	Indicator for FBDrive to show all Separtors and Dividers for this Project
Fields FBCollection	Collection of fields associated to this project
Files FBCollection	Collection of files created under this project
FileRoomEmails String	Email address for sending file room checkout request emails
GroupId Int64	Id of the group whose user has rights of this project
Hidden Boolean	Whether or not this project is to be hidden in the standard Web interface
Id Int64	Id of the project
Imaging Boolean	Whether or not this project is to be set to an imaging project
KeyField Int32	Key field for this project
KeyVisualField Int32	Key visual field for this project
LastUpdated DateTime	Date this project was last saved
LastUpdatedBy Int64	By whom this project was last saved
LockingRights LockingRights	Locking rights selected for this project
Name String	Name of the project
NewDocRoute Int64	Route down which to send newly uploaded documents
NewDocRouteAction DocumentRouteAction	Which newly uploaded documents to route
NumRevisions Int32	The number of revisions to show for any given document
ProjectId Int64	Id of the project
RememberBox Boolean	Whether or not to remember the box number for a file that is checked in from a box
RemoteId Int64	Remote id of the project
RenditionAction RenditionAction	The type of rendition action that will be performed
RenditionMaximumDimension Int32	Whether or not to require box number when performing checkouts
RenditionPerformed RenditionPerformed	When the renditions will be performed
ReportViewer Boolean	Whether or not this project is to be set use the report viewer
RequireBox Boolean	Whether or not to require box number when performing checkouts
SaveStyle FileSaveStyle	How the file will be saved
SearchPortalSecurityMode PortalSecurityMode	Specifies the search portal security mode
Separators FBCollection	List of separators created under this project
SeparatorLabel String	Specifies the text to use for separator labels
SubDividerLabel String	Specifies the text to use for subdivider labels
ServerId Int64	Id of the server this project resides on
ServerOCRSkipExtensions String	The extensions to skip during server OCR for this project
ServerOCRType ServerOCRType	The type of server OCR desired at the project level
ShowChangeDate Boolean	Whether or not to show the change date field in search results
SortDividers SortOrder	Specifies which direction to sort the dividers
SortSeparators SortOrder	Specifies which direction to sort the separators
Status Int32	Status of the project
ProjectType String	Type of project
Types List`1 (ReadOnly)	List of project types
UserId Int64	User id to fileter the project collection
VisibleOnly Boolean	Falg to show projects which are not marked as hidden
WfShowAssignedBy Boolean	Whether to show the assigned by on the workflow status screens (home)
WfShowBatchDate Boolean	Whether to show batch date on the workflow status screens (home)
WfShowDivider Boolean	Whether to show the Divider on the workflow status screens (home)
WfShowDueDate Boolean	Whether to show due date on the workflow status screens (home)
WfShowStartDate Boolean	Whether to show start date on the workflow status screens (home)
EnableAdhocRouting Boolean	Flag that indicates whether the Ad-hoc routing is enabled or not
ShareDocumentsExternally Boolean	Flag that indicates whether the Documents can be shared externally is enabled or not
EnableAddContent Boolean	Enable Add Content for this project
EnableSingleFileViewing Boolean	Enable Single File Viewing for this project
DividerRequired Boolean	Require Divider for this project
SeparatorRequired Boolean	Require Separator for this project
ProjectSearchFormat ProjectSearchFormat	Default Search Format for this project
DocumentExportFormat String	Document Export Format for this project
IncludeLineItemSearch Boolean	Include LineItems Fields on Search Page
TotalFileCount Int64	Total number of files contained by this project
SyncFlag ObjectSyncFlag	Sync flag for the project
ViewerContext ViewerContextType	Context of the viewer
TotalCount Int64 (ReadOnly)	Total count for the project
ObjectType Int32 (ReadOnly)	Type of the object

ProjectLinkField

KeyValue String	Key field value
KeyVisualValue String	Key visual field value

Report

CustomSort String	Sorts items in collection based on the property defined as a custom sort
DataSet DataSet (ReadOnly)	Dataset of the resulting report
ExtendedProperties FBCollection	Extended properties collection of report
GroupId Int64	Id of the group which can be used to limit data
Id Int64	Id of the report
ItemLink String	The url/link to use for the lines in the report
Level ReportLevel	The level in which the report is visible (global, project, custom, etc)
Name String	Name of the report
Source String	Source of the report
Sort String	Sort order for report
RangeBegin Int64	Starting row number for report
RangeLength Int64	Number of rows to return
ReportCategoryId Int32	Id of the category under which this report falls
ReportId Int64	Id of the report
StandardReportType ReportStandard	Type of the standard report
Type CommandType	Type of report (stored procedure, inline sql or table direct)
SyncFlag ObjectSyncFlag	Sync flag of the report
ViewerContext ViewerContextType	Context of the viewer
TotalCount Int64 (ReadOnly)	Total count of the report
ObjectType Int32 (ReadOnly)	Type of the object

ReportParm

CustomSort String	Email address for sending batch upload notifications
Description String	Description of this reportparm
ExtendedProperties FBCollection	Extended properties for reportparm
Id Int64	Id of the reportparm
Name String	Name of the reportparm
Type ReportParmType	Type of the reportparm
Value String	Value of the reportparm
Size Int32	Maximum size of variable expected for this reportparm. Only valid for text reportparms.
Hidden Boolean	Whether or not the parameter is hidden when building report entry screen
ReportId Int64	Id of the report which contains this reportparm
ReportParmId Int64	Id of the report parameter
SortOrder Int32	Sets the order in which this parameter shows up in the report search screen
ToParmName String	Name of this reportparm's to property for range searches of numeric and date types
ToParmValue String	Value of this reportparm's to property for range searches of numeric and date types
FieldOptions List`1	List of options that this paramter has available
SyncFlag ObjectSyncFlag	Sync flag for report parameter
ViewerContext ViewerContextType	Context of the viewer
TotalCount Int64 (ReadOnly)	Total count for report parm
ObjectType Int32 (ReadOnly)	Type of object

Route

BusinessDays Boolean	Idicates whether or not to use only business days in due date calculations
CustomSort String	Sorts items in collection based on the property defined as a custom sort
DisplayName String	Display name of the route
ExceptionStepUserId Int64	Id of the route's exception steps user
ExtendedProperties FBCollection	Extended properties collection of route
Hidden Boolean	Whether or not this route is hidden
Id Int64	Id of the route
IsAutomationProcess Boolean (ReadOnly)	Whether this process is automation process
LastRunDate String	The last run date for automation proces
Name String	Name of the route
NextRunDate String	Next run date for automation process
ObjectType Int32 (ReadOnly)	Type of the object
ParentRouteId Int64	The route id of the parent process
ParentRouteName String	Name of the parent route
ParentRouteType RouteType	Type of the parent route
ProcessId Int64	Id of the process
ProjectId Int64	Id of the project which contains this route
Revisions FBCollection	Revisions of the route
RoutedItems FBCollection	Routed item collection for this route
RouteId Int64	Id of the route
RouteType RouteType	Type of the route
Scheduled Boolean	Indicates whether the item is scheduled or not, specifically for automation
SyncFlag ObjectSyncFlag	Sync flag of the route
Type RouteType	Type of the route
ViewerContext ViewerContextType	Context of the viewer
Visible Boolean	Flag for visibility of this route
Xml String	XML content for this route
TotalCount Int64 (ReadOnly)	Total count for this route

RoutedItem

Authenticate Boolean	Flag as to whether or not to use password authentication when step is processed
BatchDate DateTime	BatchDate for the routed item
ByUserId Int64	Id of the user who routed this item
ByUserName String	Name of the user who routed this item
CallingRoutedItemId Int64	Id of the calling route
Comment String	Comment about this routed item
Completed DateTime	Date/time this item was completed
CustomSort String	Sorts items in collection based on the property defined as a custom sort
Direction RoutedItemDirection	The direction this route is going
Divider String	Divider for the routed item
DueDate DateTime	The date/time this item is due to be completed
ExtendedProperties FBCollection	Extended properties collection for this route
Extension String	Extesion for this routed item
Field String[]	Find all files that match these field values.For range searches (numeric and date) this holds the FROM value.
FinalStep Boolean	Whether or not this was the final step in the workflow
Id Int64	Id of the routed item
IdCode String	Idcode of this routed item
LocalTreeOnly Boolean	Find items in local tree starting with routeditemid
ObjectType Int32 (ReadOnly)	Type of object
Overdue TriState	Whether or not to look for overdue or active items
OriginatorId Int64	Id of the user who originated this workflow
ParentRoutedItemId Int64	Id of the parent routed item
ProcessDate DateTime	Date/time this item was processed by the server monitor
ProcessFlag Int64	Whether or not this item was processed by the server monitor
ProjectId Int64	Id of the process
PromptComplete String	Prompt to show the user when attempting to complete the step
PromptReject String	Prompt to show the user when attempting to reject the step
PromptUser Boolean	Flag as to whether or not to prompt for notes when completing a step
QueuedItems Boolean	Find routeditems waiting in a queue step
RelBoxId Int64	Id of the box that this routeditem is related to
RelFileId Int64	Id of the file that this routeditem is related to
RoutedItemId Int64	Id of the routed item
RoutedObjectId Int64	Id of the object being routed
RoutedObjectType ObjectType	Type of object being routed
RouteId Int64	The id of the route in which this item is being routed
RouteName String	The name of the route in which this item is being routed
RoutePathId Int64	The id of the routepath of this document on this route
RouteStepDescription String	Description of the rote step this item is on
RouteStepId Int64	Id of the route step this item is on
RouteStepName String	Name of the route step this item is on
RouteWait RouteWaitState	Whether or not to wait for this step to complete before moving on
Separator String	Separator for the routed item
ShowButtonComplete Boolean	Flag as to whether or not to show the complete button
ShowButtonReassign Boolean	Flag as to whether or not to show the reassign button
ShowButtonAssignToMe Boolean	Flag as to whether or not to assign to logged in user
ShowButtonReturnToAll Boolean	Flag as to whether or not to return to all users
ShowButtonReject Boolean	Flag as to whether or not to show the reject button
SiblingRoutedItemId Int64	The id of the routeditem that was called by this routeditem
StartDate DateTime	The date/time this item was started
Status RoutedItemStatus	The status of the routed item
StatusFlag RouteStepStatusFlag	Sync flag for routed item
StepName String	The step name at which this item is
StepNumber Int64	The step number at which this item is
SyncFlag ObjectSyncFlag	Sync flag for this routed item
VisualWorkflowThumbnailView Boolean	Visual workflow thumbnail view of this routed item
UserId Int64	Id of the user to whom this item is routed
UserName String	Name of the user to whom this item is routed
ViewerContext ViewerContextType	Context of the viewer
TotalCount Int64 (ReadOnly)	Total count for this routed item

RouteStep

Authenticate Boolean	Whether or not to verify the user completing it with their password
CustomSort String	Sorts items in collection based on the property defined as a custom sort
Description String	An in-depth description of the actions which should be taken at this Step
DueDays Int64	The number of days in which this step is due
DueField Int64	Sets the due date of this step to the date in the field specified
DueHours Int64	The number of hours in which this step is due
ExtendedProperties FBCollection	Extended properties for this route step
FieldNumber Int64	The field number to compare to see whether or not to execute
FieldValue String	The field value to compare the field value to in deciding whether or not to execute
GroupNameList String	The list of group names responsible for this step if multi-step
Id Int64	Id of the route step
IdCode String	Idcode if the route step
Name String	Name of the route step
NextRouteId Int64	The route id to process (child route) when this step is executed
NotifyEmail Boolean	Whether or not to notify users via email
NumProcessed Int64	The number of times this step has been executed
ObjectType Int32 (ReadOnly)	Type of the object
Parent Object	Parent of the route step
PromptComplete String	The prompt to show users when they complete this step
PromptReject String	The prompt to show users when they reject this step
PromptUser Boolean	Whether or not to prompt the user for notes when completing this step
RejectToStep Int64	When rejected, this step will move the workflow back to the step specified
RouteDirection RouteDirection	Direction of workflow to execute on
RoutedItems FBCollection	Routed items for this route step
RouteId Int64	The id of the route this route step is in
RouteStepId Int64	Id of this route step
RouteStepTasks FBCollection	The tasks set up for this routestep
RouteWait Boolean	Whether or not to wait for this step to complete in order to move on to the next step
SetNextDueDate Boolean	Flag to decide whether or not the user sets the next step's due date
ShowButtonComplete Boolean	Whether or not to show the complete button
ShowButtonReassign Boolean	Whether or not to show the reassign button
ShowButtonReject Boolean	Whether or not to show the reject button
ShowHiddenSteps Boolean	Whether or not to show the hidden steps
StatusFlag RouteStepStatusFlag	The colored flag to show in the interface for this step
StepNumber Int64	Number of this route step
StepPercent Int32	The percentage of the time this step is executed
StepType RouteStepType	Type of the step
SyncFlag ObjectSyncFlag	Sync flag for this route step
Tag Object	Tag property for this route step
UpdateFieldNumber Int64	The field number to update when this step is completed
UpdateFieldValue String	The value to update the field when this step is completed
UpdateFieldValueOld String	Old update field value property. Backward compatibility only!
UserId Int64	The id of the user to which this step is assigned is standard step
UserList String	The list of userids and groupids responsible for this step if multi-step
UserName String	Name of the user configured for this step
UserNameList String	List of usernames configured for this step
ViewerContext ViewerContextType	Context of the viewer
VotePercent Int32	What percentage of the users in a vote step need to complete it for the step to complete
VoteWaitForAll Boolean	Whether or not a multi-vote step should collect all votes before moving on
TotalCount Int64 (ReadOnly)	Total count for this route step

RouteStepChecklist

ChecklistOrder Int64	The order of the checklist item
CreatedBy Int64	The userid of the user who checked the checklist item
CreatedTime DateTime	The datetime of when the user checked the checklist item
CustomSort String	Sorts items in collection based on the property defined as a custom sort
Description String	The long description of this route step checklist
ExtendedProperties FBCollection	Extended properties for route step checklist
Id Int64	Id of the route step checklist
IsChecked Boolean	Whether this step is checked or not
Name String	Name of the route step checklist
ObjectType Int32 (ReadOnly)	Type of the object
Required Boolean	Stores if this checklist item is required or not
RoutedItemId Int64	The id of the routeditem which have a checklist item completed
RouteStepChecklistId Int64	Find an item in the collection by id
RouteStepId Int64	The id of the route step this checklist relates to leave 0 if not applied to route step
RouteStepTaskId Int64	The id of the route step task this checklist relates to, leave 0 if not applied to route step task
SyncFlag ObjectSyncFlag	Sync flag for this route step checklist
ViewerContext ViewerContextType	Context of the viewer
TotalCount Int64 (ReadOnly)	Total count for this route step

RouteStepTask

ActionNum Int64	Action number
ActionType RouteStepTaskButtonAction	Type of action
AutoNum Int64	Auto number for route step task
AutoStep RouteStepTaskWorkflowAction	Auto step for route step task
Caption String	Caption for route step task
Checklist FBCollection	Checklist for route step task
ChildRouteId Int64	Id of the child route
CustomSort String	Sorts items in collection based on the property defined as a custom sort
ExtendedProperties FBCollection	Extended properties of route step task
IconNumber Int64	Number of icon
Id Int64	Id of route step task
Name String	Name of route step task
ObjectType Int32 (ReadOnly)	Type of object
Parent Object	Parent of route step task
Prompt String	Prompt for route step task
RouteStepId Int64	Id of route step
RouteStepTaskId Int64	Id of route step task
SyncFlag ObjectSyncFlag	Sync flag of route step task
Tag Object	Tag property for route step task
TaskOrder Int64	Order of the task
UserPickerFilter String	Fileter for user list
ViewerContext ViewerContextType	Context of viewer
TotalCount Int64 (ReadOnly)	Total count of route step task
PromptForNotes Boolean	Prompt for notes on route step connection

Separator

AliasName String	Alias name of this separator
CustomSort String	Sorts items in collection based on the property defined as a custom sort
ExtendedProperties FBCollection	Extended properties for separator
GroupId Int64	Id of the group to filter separator search result
Id Int64	Id of the separator
IsDefault Boolean	Isdefault property for a separator
Name String	Name of the separator
NormalizedName String	Normalizes name of the separator for emailing and exporting
ObjectType Int32 (ReadOnly)	Type of object
OriginalName String (ReadOnly)	Original name
ProjectId Int64	Id of the project which contains this separator
Required Boolean	Whether this separtor is required or not
SeparatorId Int64	Id of the separator
SepRelation String	The value to match up with in the file field value in order to show this separator as a choice
SortOrder Int64	Sort order for separator
SyncFlag ObjectSyncFlag	Sync flag for this separator
ViewerContext ViewerContextType	Context of the viewer
Access AccessRights	Access rights for this separator
TotalCount Int64 (ReadOnly)	Total count for separator

User

AccessAdmin Boolean	Whether or not this user has access admin rights
Active Boolean	Whether or not a user is active
Address1 String	Address line 1 for this user
Address2 String	Address line 2 for this user
Admin Boolean	Whether or not this user is a system administrator
City String	City of the user
ClipboardOnly Boolean	Whether or not this user has access to only clipboard
CustomSort String	Sorts items in collection based on the property defined as a custom sort
CustomURL String	The custom startup URL for this user
DefaultViewer String	Default viewer for the user.
DisplayName String	Full name of this user
Email String	Email of the user
ExtendedProperties FBCollection	Extended properties of the user
Fax String	Fax number of the user
FBGUID String	The session guid for this login
ForcePassword Boolean	Force to change the password
FormsOnly Boolean	Whether or not this user has access to only Forms menu
GroupId Int64	Id of the group to filter user collection
Groups FBCollection	Groups to which user is belogs to
Hidden Boolean	The visibility of the users being searched
Id Int64	Id of the user
IncludeGroupsAndProjects Boolean	Populate the groups and projects in the user's groups collection
Location Int32	Whether or not a user is on location for its business
Name String	Name of the user
ObjectType Int32 (ReadOnly)	Type of the object
OutOfOffice Boolean	Whether or not a User is out of office
Password String (ReadOnly)	Password of the user
PasswordDate DateTime	The date this user last changed their password
PasswordExpires DateTime	Date/time this user's password expires
PasswordModified String (ReadOnly)	Reflects whether the password has been modified for this user
Phone String	Phone number of the user
ProjectId Int64	The id of the project to find users belonging to
Projects FBCollection	Projects assigned to this user
ResetPasswordExpires Boolean	Property set to true to skip secure password validations
RoutedItems FBCollection	Items routed to this user
StartScreen StartScreen	Whether or not this user is allowed to login
State String	State for the user
Status Int64	The status of this user (1=active, 0=deleted)
SyncFlag ObjectSyncFlag	Sync flag for the user
TimeZone Int64	The time zone this user is in
UserId Int64	Id of the user
ViewerContext ViewerContextType	Context of the viewer
Website String	Website URL for this user
Zip String	Zip code of the user
TotalCount Int64 (ReadOnly)	Total count for the user
Tag Object	Tag property for the user
Custom1 String	Custom Field 1 property for the user
Custom2 String	Custom Field 2 property for the user
Custom3 String	Custom Field 3 property for the user
Custom4 String	Custom Field 4 property for the user
Custom5 String	Custom Field 5 property for the user
Custom6 String	Custom Field 6 property for the user
DelegateUserID Int64	Delegate User Id

DividerFilter

ProjectID Int64	Project id to filter on
GroupID Int64	Group id to filter on
DividerID Int64	Divider id to filter on
Separator String	Separator name to filter name
Name String	Divider name to filter on
AliasName String	Divider alias name to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get dividers Example

jQuery sample:


$.ajax({
    url: 'dividers?filter=projectid_1,name_Education',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

DocumentFilter

DocumentID Int64	Document id to filter on
SubDividerID Int64	Id of the sub divider to filter on
Status DocumentStatus	Status of document to filter on
MultiStatusIDs ArrayList	The collection of key values to filter on
ProjectID Int64	Project id to filter on
ArchiveID Int64	Archive id with which to limit resultant records
BatchDate DateTime	Batch date to filter on
FileID Int64	File id to filter on
RelProjectID Int64	Id of the related project in which this document is queued up for indexing. This is only used for un-indexed documents.
Divider String	Divider to filter on
Separator String	Separator to filter on
RoutedUserID Int64	User id of the person to filter on
LockedByUserID Int64	Id of the user who has locked the document to filter on
DocumentRevID Int64	Document revision id to filter on
DocPtr Int64	Document as a pointer to filter on
UserFiled Int64	Id of user who last saved this document to filter on
MultiUserFiledIDs ArrayList	Multi user filed ids to filter on
UserCreated Int64	User created id to filter on
MultiUserCreatedIDs ArrayList	List of ids of user who created this document to filter on
LoggedInUserProjectIDs ArrayList	Logged in user project ids to filter on
DocSetRole Int64	Document set role to filter on
DocSetGUID String	Document set guid to filter on
ReportText String	Report text to filter on
ReportNumericFrom Single	Report numeric from to filter on
ReportNumericTo Single	The numeric to value to filter on
ReportDateFrom DateTime	The report date from to filter on
ReportDateTo DateTime	Report date to value to filter on
ReportColumnFrom Int32	The report column from to filter on
ReportColumnTo Int32	The report column to to filter on
ReportFieldType FieldType	The report field type(text, number or date) to filter on
PopulateBinary Boolean	Whether or not to populate the binary data to filter on
IsMasterSheet TriState	Whether or not to include master sheets to filter on
LastViewFrom DateTime	Document last viewed from date to filter on
LastViewTo DateTime	Document last view to date to filter on
DateFiledFrom DateTime	Document filed from date to filter on
DateFiledTo DateTime	Document filed to date to filter on
DateCreatedFrom DateTime	Document created from date to filter on
DateCreatedTo DateTime	Document created to date to filter on
ChangedSinceLastArchive TriState	Document Changed since last archived to filter on
NotRoutedBy Int64	Not routed by id to filter on.
WithoutEFormID Int64	EForm id by which the document(s) have not been generated to filter on
PrefetchFullText Boolean	Boolean value to indicate whether to prefetch full text or not to filter on
MultiFileIDs ArrayList	List of File ID(s) to filtered on
DocumentName String	Semicolon separated list of document names to filter the document list on
DocumentGroupID Int64	Document Group id to filter on
FullText String	Full text content of the document(s) to filter on
DocNotes String	Notes on document(s) contained in the file to filter on
AnnotationText String	Annotation text content of documents to filter on
ProjectSearchFormat ProjectSearchFormat	Project Search Format
DocumentDateFrom DateTime	Document date to filter on
DocumentDateTo DateTime	Document date to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get Documents example

jQuery sample:


$.ajax({
    url: 'documents?filter=fileid_3,divider_Invoices',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get Documents BY MultiIDs

jQuery sample:


$.ajax({
    url: 'documents?filter=MultiIDs_4|5',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

EformDataFilter

DocumentID Int64	Document id to filter on
EformDataID Int64	FormData id to filter on
FieldName String	Variable (field) name to filter on
FieldValue String	Variable (field) value to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get eform data example

jQuery sample:

       
$.ajax({
    url: 'eformdata?filter=separator_HR,fieldname_Name',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

EformDetailFilter

DocumentID Int64	Document id to filter on
EformDetailID Int64	Formdetail id to filter on
FieldName String	Variable (field) name to filter on
FieldValue String	Variable (field) value to filter on
Row Int64	Row number to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get eform detail example

jQuery sample:

        
$.ajax({
    url: 'eformdetail?filter=documentid_2,fieldname_DOB',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

EformFilter

ProjectID Int64	Project ID of the EForm
EformID Int64	Form ID of the EForm
Extension String	File Extension of the EForm (HTML, DOCX, PDF, ...)
Hidden TriState	A hidden EForm does not show in any lists. TriState Values: True, 1, False, 0, DontCare, -999
PopulateBinary Boolean	Whether or not to populate the Binary Data
UsageType EformUsageType	Accepted Values: ViewEdit, 0, Submission, 1, SuccessPage, 2, All, -1
WebLayout EformWebLayout	Accepted Values: NotChosenYet, 0, Responsive, 1, Regular, 2, All, -1
Type EformType	Accepted Values: Structured, 0, Web, 1, All, -1
Portal TriState	EForm is for display on the Portal. TriState Values: True, 1, False, 0, DontCare, -999
SecurityMode PortalSecurityMode	Accepted Values: Public, 0, AccessCode, 1, FBLogin, 2, Anonymous, 3, AnonymousWithPassword, 4, All, -1
RelSubmissionFormID Int32	Related submission form id to filter on
FormCategoryID Int64	Form category id to filter on
EformName String	Form name to filter on
RevisionParentID Int32	ID of the Parent this Form was Published from. 0 means this is a Parent Form
Status EformStatus	Accepted Values: Deleted, 0, Active, 1, Inactive, 2, Revision, -2
Published TriState	Eform is Published. TriState Values: True, 1, False, 0, DontCare, -999
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get eforms Example

jQuery sample:

       
$.ajax({
    url: 'eforms?filter=ProjectId_1,Name_test',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

FieldFilter

ProjectID Int64	Project id to filter on
FieldID Int64	Field id to filter on
UserID Int64	User id to filter on
Name String	User name to filter on
Status String	Status to filter on
FieldNumber Int64	Field number to filter on
RegularFields Boolean	Fetch only Regular Fields and ignore additional fields
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get fields example

jQuery sample:

$.ajax({
    url: 'fields?filter=projectid_1,Name_Last Name',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

FieldSecurityFilter

FieldSecurityID Int64	Field security id to filter on
ProjectID Int64	Project id to filter on
GroupID Int64	Group id to filter on
FieldNumber Int64	Field number to filter on
AccessRights Int64	Access rights to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get field security example

jQuery sample:

$.ajax({
    url: 'fieldsecurity?filter=projectid_1,groupid_2',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

FileFilter

ProjectID Int64	Project id to filter on
FileID Int64	File id to filter on
AuditID Int64	Audit id to filter on
BoxID Int64	Box id to filter on
UserID Int64	User id to filter on
Admin Boolean	Flag for admin to filter on
Clipboard Boolean	Flag for clipboard to filter on
Status FileStatus	Status to filter on
KeyValue String	Key field value to filter on
KeyVisualValue String	Key visual field value to filter on
Field FBHashTable	Field to filter on
FieldTo FBHashTable	Field to value to filter on
LIField FBHashTable	Line item field value to filter on
LIFieldTo FBHashTable	Line item field to value to filter on
SecurityField FBHashTable	Security Field to filter on
SecurityFieldTo FBHashTable	Field to value to filter on
FieldType Int64[]	Type of the field to filter on
FieldMask String[]	Field mask to filter on
Separator String	Separator in which document(s) for this file resides to filter on
Divider String	Divider in which document(s) for this file resides to filter on
SubDivider String	Filter files based on sub divider in which document(s) for this file resides
ArchiveID Int64	Archive id to filter on
Archive String	Archive to filter on
FullText String	Full text content of the document(s) to filter on
FileNotes String	Notes on file to filter on
DocNotes String	Notes on document(s) contained in the file to filter on
DocNames String	Name of document(s) contained in the file to filter on
DestructionDateFrom DateTime	Destruction from date to filter on
DestructionDateTo DateTime	Destruction to date to filter on
DateChangedFrom DateTime	File changed from date to filter on
DateChangedTo DateTime	File changed to date to filter on
DocDateCreatedFrom DateTime	Document created from date to filter on
DocDateCreatedTo DateTime	Document created to date to filter on
DocDateChangedFrom DateTime	Document changed from date to filter on
DocDateChangedTo DateTime	Document changed to date to filter on
DateCreatedFrom DateTime	Created from date to filter on
DateCreatedTo DateTime	Created to date to filter on
DocDateFrom DateTime	Document from date to filter on
DocDateTo DateTime	Document to date to filter on
LabelPrintedFrom DateTime	Label printed from to filter on
LabelPrintedTo DateTime	Label printed to to filter on
BatchFrom DateTime	Batch from to filter on
BatchTo DateTime	Batch to to filter on
FilePtr Int64	File pointer to filter on
RemoteID Int64	Remote id to filter on
MultiKeys ArrayList	Multiple key values to filter on
MultiKeyField Int64	Multi key field to filter on
DocsChangedSinceLastArchive TriState	Documents changed since last archive to filter on
NotRoutedBy Int64	Not routed by filter for documentsto filter on
WithoutEFormID Int64	Without eform id to filter on
MultiStatusID ArrayList	Multiple status id to filter on
LockedByUserID Int64	Locked by user id to filter on
SearchMode SearchMode	Search mode to filter on
SubDividerID Int64	Sub divider id to filter on
AnnotationText String	Annotation text content of documents to filter on
IncludeEmptyFiles Boolean	Include empty files flag to filter on
SkipDateConversion Boolean	Skips date conversion for current locale
ProjectLinkSearch Boolean	Flag to indicate this is a ProjectLink Search
MultiUserID ArrayList	Prefer MultiUserID when searching recycle bin to filter by multiple users
ProjectSearchFormat ProjectSearchFormat	Project Search Format
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get Files example

jQuery sample:

$.ajax({
    url: 'files?filter=projectid_1,status_1',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

Get Files by MultiIDs

jQuery sample:

$.ajax({
    url: 'files?filter=MultiIDs_12|13',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

FileRelationFilter

ProjectID Int64	[no description available]
RelatedProjectIDs List`1	[no description available]
FileRelationID Int64	[no description available]
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get file relationship example

jQuery sample:

$.ajax({
    url: 'projects/{id}/filerelationships',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

FileSecurityFilter

FileSecurityID Int64	File security id to filter on
ProjectID Int64	Project id to filter on
GroupID Int64	Group id to filter on
FieldNumber Int64	Field number to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get file security example

jQuery sample:

$.ajax({
    url: 'filesecurity?filter=projectid_1,groupid_2',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

GroupFilter

GroupID Int64	Group id to filter on
UserID Int64	User id to filter on
ProjectID Int64	Project id to filter one
PluginID Int64	Plugin id to filter on
WidgetID Int64	Widget id to filter on
EFormID Int64	Form id to filter on
ReportID Int64	Report id to filter on
FileRelationID Int64	File relation id to filter on
Name String	Name to filter on
Separator Int64	Separator to filter on
Divider Int64	Divider to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get groups example

jQuery sample:

$.ajax({
    url: 'groups?filter=groupid_2,userid_2',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

ProcessRouteRevisionFilter

ProcessRouteRevisionID Int64	Process route revision id to filter on
RouteID Int64	The route id of the process route this revision applies to
PublishedRouteID Int64	Published route id to filter on
LoadDiagram Boolean	Include loading of the revision's diagram xml from the database to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get process route revisions example

jQuery sample:

$.ajax({
    url: 'processrouterevisions?filter=routeid_2,processrouterevisionid_12',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

ProjectFilter

ProjectID Int64	Project id to filter on
GroupID Int64	Group id to filter on
UserID Int64	User id to filter on
Name String	Name to filter on
ProjectType String	Project type to filter on
AdminOnly Boolean	Flag for admin only to filter on
VisibleOnly Boolean	Project is visible or not to filter on
SearchPortal Nullable`1	Projects enabled for search portal to filter on
SearchPortalSecurityMode PortalSecurityMode	Search portal security mode to filter on
DocuSignEnabled Nullable`1	Docu sign enabled flag to filter on
HelloSignEnabled Nullable`1	Hello Sign enabled flag to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get projects Example

jQuery sample:

$.ajax({
    url: 'projects?filter=groupid_2,userid_3',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

ReportFilter

ReportID Int64	Report id to filter on
Name String	Report name to filter on
Type CommandType	Report type(stored procedure, inline sql or table direct) to filter on
GroupID Int64	Group id to filter on
StandardReportType ReportStandard	Standard report type to filter on
Level ReportLevel	Report level(global, project, custom, etc) to filter on
ReportCategoryID Int32	Report category id to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get reports Example

jQuery sample:

$.ajax({
    url: 'reports?filter=reportcategoryid_1,level_2',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

ReportParmFilter

ReportID Int64	Id of the report to filter parameters by
ReportParmID Int64	Report parameter id to filter on
Name String	Report name to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get report parameters example

jQuery sample:

$.ajax({
    url: 'reportparms?filter=reportid_548',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RouteFilter

ProjectID Int64	Project id to filter on
RouteID Int64	Route id to filter on
Name String	Route name to filter on
Hidden RouteHidden	Hidden flag for route to filter on
Type RouteType	Route type to filter on
DisplayName String	Display name to filter on
InitiatingWorkflow Boolean	True if initiating workflow
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get routes example

jQuery sample:

$.ajax({
    url: 'routes?filter=projectid_1,hidden_visible',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RoutedItemFilter

RoutedItemID Int64	Routed item id to filter on
ProjectID Int64	Project id to filter on
RouteID Int64	Route id to filter on
ParentRouteId Int64	Parent route id to filter on
RoutePathID Int64	Route path id to filter on
RouteName String	Route name to filter on
RouteStepName String	Route step name to filter on
RouteStepID Int64	The id of the route step in which to find the routed items
Direction Int64	The direction of routed items to to filter on
RoutedObjectID Int64	Routed object id to filter on
RoutedObjectType ObjectType	Routed object type to filter on
UserID Int64	User id to filter on
ParentRoutedItemID Int64	The id of the parent route
CallingRoutedItemID Int64	The id of the calling route
SiblingRoutedItemID Int64	The id of any sibling route that was called
Status Int64	The status of the routed items to find
Overdue TriState	Whether or not to look for overdue or active items
LocalTreeOnly Boolean	Find items in local tree starting with route item id
QueuedItems Boolean	Find routed items waiting in a queue step
Field FBHashTable	Find all files that match these field values.For range searches (numeric and date) this holds the from value.
FieldTo FBHashTable	Find all files that have values in these fields are less than these field values. This is only for range search (numeric and date).
AssignmentManagement Boolean	Flag if user has Assignment Management Access
AllowZeroFileDocument Boolean	Flag be able to get File or Document Zero
IgnoreUserIdCritForAdminUser Boolean	Flag be able to ignore UserId criteria for Admin Users
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get routed items example

jQuery sample:

$.ajax({
    url: 'routeditems?filter=reportid_1,userid_1',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RouteStepFilter

RouteID Int64	Route id to filter on
RouteStepID Int64	Route step id to filter on
ShowHiddenSteps Boolean	Whether or not to show hidden steps to filter on
IDCode String	A special id on the route step to filter on
ActiveStepsOnly Boolean	Whether or not to show only steps with active routed items
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get route step example

jQuery sample:

$.ajax({
    url: 'routesteps?filter=routeid_1,showhiddensteps_false',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RouteStepChecklistFilter

RouteStepChecklistID Int64	Route step checklist id to filter on
RouteStepID Int64	Route step id to filter on
RouteStepTaskID Int64	Route step task id to filter on
RoutedItemID Int64	Routed item id to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get route step checklist example

jQuery sample:

$.ajax({
    url: 'routestepchecklist?filter=routestepid_108,routesteptaskid_0',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

RouteStepTaskFilter

RouteStepTaskID Int64	Route step task id to filter on
RouteStepID Int64	Route step id to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get route step tasks example

jQuery sample:

$.ajax({
    url: 'routesteptasks?filter=routestepid_108',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

SeparatorFilter

ProjectID Int64	Project id to filter on
GroupID Int64	Group id to filter on
SeparatorID Int64	Separator id to filter on
Name String	Separator name to filter on
AliasName String	Alias name to filter on
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get separator Example

jQuery sample:

$.ajax({
    url: 'separators?filter=projectid_1,name_Education',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

UserFilter

UserID Int64	User id to filter on
GroupID Int64	Group id to filter on
MultiGroupID ArrayList	Multiple Group id to filter on
ProjectID Int64	Project id to filter on
Name String	User name to filter on
DisplayName String	Display name to filter on
Email String	User's email address to filter on
Hidden UserVisibility	Flag for hidden to filter on
Active UserActiveType	User active type to filter on
IncludeGroupsAndProjects Boolean	Populate the groups and projects to filter on
Address1 String	Populate by applying Address1 filter
Address2 String	Populate by applying Address2 filter
City String	Populate by applying City filter
State String	Populate by applying State filter
Zip String	Populate by applying Zip filter
Phone String	Populate by applying Phone filter
Fax String	Populate by applying Fax filter
Website String	Populate by applying Website filter
Custom1 String	Populate by applying Custom1 filter
Custom2 String	Populate by applying Custom2 filter
Custom3 String	Populate by applying Custom3 filter
Custom4 String	Populate by applying Custom4 filter
Custom5 String	Populate by applying Custom5 filter
Custom6 String	Populate by applying Custom6 filter
FBGUID String	Populate by applying FBGUID filter
ByPassSecurityCriteria Boolean	Populate by applying ByPassSecurityCriteria filter
PropertyList ArrayList	List of property
MultiIDs ArrayList	The collection of key values to search the files by
RangeBegin Int64	The starting record position, when retrieving a specific page of results
RangeLength Int64	The number of records to return, for a specific page of results
Sort String	The default sort for the returning collection
ClearOnFill Boolean	Indicates if this filter should be cleared after a collection fill operation
Cache Boolean	Defaults to true, cached data.If false data is fetched directly from database and not cached for future queries.
LoggedInUserID Int64	[no description available]
Tag Object	Custom storage property
ViewerContext ViewerContextType	Flag set by interface to indicate the filter has originated in a viewer

Get users Example

jQuery sample:

$.ajax({
    url: 'users?filter=projectid_1,groupid_2',
    type: 'GET',
    success: function (data) {
        return data;
    },
    error: function () {
        alert('request failed');
    }
});

AssignmentActionType

Unknown	0 - Unknown
ActionLink	1 - Action Link
DueDate	-9999 - Set Due Date (for internal use only)
Cancel	-9998 - Cancel (for internal use only)
Reassign	-9997 - Reassign (for internal use only)
Reject	-9996 - Reject (for internal use only)
Approve	-9995 - Approve (for internal use only)
Checklist	-9994 - Checklist (for internal use only)
VerifyPassword	-9993 - Verify Password (for internal use only)

DocSetRole

None	0 - None
FirstDoc_Excluded	1 - First Document Excluded from set
FirstDoc_Included	2 - First Document Included in set
Sibling	3 - Sibling
FirstDoc_All	-1 - First document all (for internal use only)

DocumentRouteAction

Every_Document	0 - Every Document
First_Document_In_File	1 - First Document in File
Every_Page	3 - Every Page

DocumentSaveStyle

CreateRevision	0 - Create Revision
SkipRevision	1 - Skip Revision
ProjectLevelRouting	2 - Project-Level Routing
BypassProjectLevelRouting	3 - Bypass Project-Level Routing
OverrideUser	4 - Override Logged In User
OverrideLock	5 - Override Lock
DocumentBeingRestored	6 - Document Being Restored
FullTextOnly	7 - Full Text Only
Unknown	-999 - Unknown (for internal use only)

DocumentStatus

Deleted	0 - Deleted
Active	1 - Active
Archived	2 - Archived
Scanned	3 - Scanned
EformGenerated	4 - Form Generated
Unindexed	5 - Unindexed
Recycled	7 - Recycled
Indexing_Queued	500 - In queue of indexing
Indexing_QueuedError	509 - Indexing queued error
Indexing_OCR	510 - Indexing OCR
Indexing_OCRError	519 - Indexing OCR error
Indexing_TemplateMatch	520 - Indexing template match
Indexing_TemplateMatchError	529 - Indexing template match error
Indexing_Manual	590 - Indexing manual
Indexing_Error	599 - Indexing error
Recycle_Processing	700 - Recycle processing
QualityControl	800 - Quality Control
Unknown	-999 - Unknown (for internal use only)
ActiveOrArchived	-998 - Active or Archived (for internal use only)
Indexing_AllIndexable	-555 - Indexing all indexable (for internal use only)
Indexing_AllProcessing	-554 - Indexing all processing (for internal use only)
RecordsDestruction_Processing	-300 - Record desctruction processing (for internal use only)
Indexing_All	-5 - Indexing all (for internal use only)
Revision	-2 - Revision

FieldType

Unknown	0 - Unknown
Text	1 - Text
Number	2 - Number
DateField	3 - Date Field
TerminalDigit	4 - Terminal Digit
AutoCounter	5 - Auto-Counter
OptionList	6 - Option List
AutoText	7 - Auto-Text
Special1	8 - Special 1
ProjectLink	9 - Project Link
Cascade	10 - Cascade

FileSaveStyle

MergeFirst	0 - Merge Files Based on All Indexes
NewFile	1 - Do Not Merge, Create New Files
KeyFieldMerge	2 - Merge Files Based on Key Field Only
OverrideLock	3 - Override Lock
ResolvedDataError	4 - Resolved Data Error
Unknown	-999 - Unknown (for internal use only)

FileStatus

Deleted	0 - Deleted
Active	1 - Active
Scanned	3 - Scanned
Recycled	7 - Recycled
Recycle_Processing	700 - Recycle processing
QualityControl	800 - Quality Control
Unknown	-999 - Unknown (for internal use only)
RecordsDestruction_Processing	-300 - Record destruction processing (for internal use only)
UnIndexed	-1 - Unindexed (for internal use only)

IndexingQueueDocs

AllUsers	0 - All users
GlobalIndexingUserOnly	1 - Global indexing user only

ObjectSyncFlag

NoChange	0 - No Change
Add	1 - Add
Edit	2 - Edit
Delete	3 - Delete
Restore	4 - Restore

ObjectType

Unknown	0 - Unknown
Business	1 - Business
Project	2 - Project
Group	3 - Group
User	4 - User
File	5 - File
Document	6 - Document
Archive	7 - Archive
Audit	8 - Audit
Batch	9 - Batch
Box	10 - Box
CAR	11 - CAR
ChecklistItem	12 - Checklist Item
Checkout	13 - Checkout
Divider	14 - Divider
DocLocation	15 - Document Location
DocumentRel	16 - Document Relation
DocumentSec	17 - Document Security
DocumentSig	18 - Document Signature
Eform	20 - Eform
EformData	21 - Form Data
EformDetail	22 - Form Detail
ExtraData	23 - Extra Data
Field	24 - Field
CheckListDef	25 - Checklist Definition
FileLabel	26 - File Label
Label	27 - Label
Monitor	28 - Monitor
Overlay	29 - Overlay
Password	30 - Password
Reason	31 - Reason
Request	32 - Request
Route	33 - Route
RouteStep	34 - Route Step
RouteStepTask	35 - Route Step Task
Separator	36 - Separator
Stamp	37 - Stamp
RoutedItem	38 - Routed Item
Annotation	39 - Annotation
ExtendedProperty	40 - Extended Property
Server	41 - Server
Setting	42 - Setting
AnnotationCollection	43 - Annotation Collection
ProjectCollection	44 - Project Collection
GroupCollection	45 - Group Collection
UserCollection	46 - User Collection
FileCollection	47 - File Collection
DocumentCollection	48 - Document Collection
ArchiveCollection	49 - Archive Collection
AuditCollection	50 - Audit Collection
BatchCollection	51 - Batch Collection
BoxCollection	52 - Box Collection
CARCollection	53 - CAR Collection
ChecklistItemCollection	54 - Checklist Item Collection
CheckoutCollection	55 - Checkout Collection
DividerCollection	56 - Divider Collection
DocLocationCollection	57 - Document Location Collection
DocumentRelCollection	58 - Document Relation Collection
DocumentSecCollection	59 - Document Security Collection
DocumentSigCollection	60 - Document Signature Collection
EformCollection	62 - Form Collection
EformDataCollection	63 - Form Data Collection
EformDetailCollection	64 - Form Detail Collection
ExtraDataCollection	65 - Extra Data Collection
FieldCollection	66 - Field Collection
ChecklistDefCollection	67 - Checklist Definition Collection
FileLabelCollection	68 - File Label Collection
LabelCollection	69 - Label Collection
MonitorCollection	70 - Monitor Collection
OverlayCollection	71 - Overlay Collection
PasswordCollection	72 - Password Collection
ReasonCollection	73 - Reason Collection
RequestCollection	74 - Request Collection
RouteCollection	75 - Route Collection
RouteStepCollection	76 - Route Step Collection
RouteStepTaskCollection	77 - Route Step Task Collection
SeparatorCollection	78 - Separator Collection
StampCollection	79 - Stamp Collection
RoutedItemCollection	80 - Routed Item Collection
ExtendedPropertyCollection	81 - Extended Property Collection
ServerCollection	82 - Server Collection
SettingCollection	83 - Setting Collection
Plugin	84 - Plug-in
PluginCollection	85 - Plug-in Collection
Report	86 - Report
ReportCollection	87 - Report Collection
ReportParm	88 - Report Parameter
ReportParmCollection	89 - Report Parameter Collection
Vendor	90 - Vendor
VendorCollection	91 - Vendor Collection
EformProcess	92 - Form Process
EformProcessCollection	93 - Form Process Collection
EformProcessStep	94 - Form Process Step
EformProcessStepCollection	95 - Form Process Step Collection
EformGroup	96 - Form Group
EformGroupCollection	97 - Form Group Collection
FileSecurity	98 - File Security
FileSecurityCollection	99 - File Security Collection
FieldSecurity	100 - Field Security
FieldSecurityCollection	101 - Field Security Collection
ReportSort	102 - Report Sort
ReportSortCollection	103 - Report Sort Collection
Chain	104 - Chain
ChainCollection	105 - Chain Collection
ChainModule	106 - Chain Module
ChainModuleCollection	107 - Chain Module Collection
RouteStepFieldUpdate	108 - Route Step Field Update
RouteStepFieldUpdateCollection	109 - Route Step Field Update
Word	110 - Word
WordCollection	111 - Word Collection
Clipboard	112 - Clipboard
Login	113 - Login
Search	114 - Search
DocumentNote	115 - Document Note
Page	116 - Page
PageCollection	117 - Page Collection
RouteStepChecklist	118 - Route Step Checklist
RouteStepChecklistCollection	119 - Route Step Checklist Collection
Scope	120 - Scope
ScopeCollection	121 - Scope Collection
Widget	122 - Widget
WidgetCollection	123 - Widget Collection
ProcessRouteRevision	124 - Process Route Revision
ProcessRouteRevisionCollection	125 - Process Route Revision Collection
ScheduledJob	126 - Scheduled Job
ScheduledJobCollection	127 - Scheduled Job Collection
ScheduledJobExec	128 - Scheduled Job Execution
ScheduledJobExecCollection	129 - Scheduled Job Execution Collection
RecycleBin	130 - Recycle Bin
ServerGroup	131 - Server Group
ServerGroupCollection	132 - Server Group Collection
AutomationEvent	133 - Automation Event
AutomationEventCollection	134 - Automation Event Collection
RoutePath	135 - Route Path
RoutePathCollection	136 - Route Path Collection
Template	137 - Template
TemplateCollection	138 - Template Collection
FBRegexPattern	139 - Regex Pattern
FBRegexPatternCollection	140 - Regex Pattern Collection
UserGridSetting	141 - User Grid Settings
UserGridSettingsCollection	142 - User Grid Settings Collection
FormToken	143 - Form Token
FormTokenCollection	144 - Form Token Collection
Dashboard	145 - Dashboard
DashboardCollection	146 - Dashboard Collection
SearchPortalField	147 - Search Portal Field
SearchPortalFieldCollection	148 - Search Portal Field Collection
SearchPortalAccessCode	149 - Search Portal Access Code
SearchPortalAccessCodeCollection	150 - Search Portal Access Code Collection
UserSetting	151 - User Settings
UserSettingsCollection	152 - User Settings Collection
Integration	153 - Integration
IntegrationCollection	154 - Integration Collection
IntegrationResource	155 - Integration Resource
IntegrationResourceCollection	156 - Integration Resource Collection
IntegrationParam	157 - Integration Parameter
IntegrationParamCollection	158 - Integration Param Collection
Policy	165 - Retention Policy
PolicyCollection	166 - Retention Policy Collection
PolicyRule	167 - Retention Policy Rule
PolicyRuleCollection	168 - Retention Policy Rule Collection
Record	169 - Retention Record
RecordCollection	170 - Retention Record Collection
RecordNotification	171 - Retention Record Notification
RecordNotificationCollection	172 - Retention Record Notification Collection
FormsReportingField	173 - Forms Reporting Field
FormsReportingFieldCollection	174 - Forms Reporting Field Collection
FileRelation	175 - File Relation
FileRelationCollection	176 - File Relation Collection
VisualReport	177 - Visual Report
VisualReportCollection	178 - Visual Report Collection
FormsReportStructureCollection	179 - FormsReportStructure Collection
FormsReportStructure	180 - FormsReportStructure
FormsReportStructureItemCollection	181 - FormsReportStructureItem Collection
FormsReportStructureItem	182 - FormsReportStructureItem
FormsReportStructureConfigCollection	183 - FormsReportStructureConfig Collection
FormsReportStructureConfig	184 - FormsReportStructureConfig
EncryptionStatus	185 - Encryption Status
FileIndexes	186 - File Indexes
SubDivider	188 - Sub-divider
SubDividerCollection	189 - Sub Divider Collection
DevKey	190 - Dev Key
DevKeyCollection	191 - Dev Key Collection
DevKeyMonitoring	192 - DevKeyMonitoring
DevKeyMonitoringCollection	193 - DevKeyMonitoring Collection
ErrorLogEntry	194 - Error Log Entry
FBSamlConfiguration	195 - SAML Configuration
FBSamlConfigurationCollection	196 - SAML Configuration Collection
SecurityHeader	197 - Security Header
SecurityHeaderCollection	198 - Security Header Collection
FileTransfer	199 - File Transfer
DocumentComment	200 - Document Comment
DocumentCommentCollection	201 - Document Comment Collection
FileComment	202 - File Comment
FileCommentCollection	203 - File Comment Collection
AnonVisit	204 - Anonymous Visit
AnonVisitCollection	205 - Anonymous Visit Collection
AnonVisitStatus	206 - Anonymous Visit Status
AnonVisitStatusCollection	207 - Anonymous Visit Status Collection
AnonFormHist	208 - Anonymous Form History
AnonFormHistCollection	209 - Anonymous Form History Collection
AnonFormHistStatus	210 - Anonymous Form History Status
AnonFormHistStatusCollection	211 - Anonymous Form History Status Collection
AnonResetPasswordToken	212 - Anonymous Reset Password Token
AnonResetPasswordTokenCollection	213 - Anonymous Reset Password Token Collection
IPAddressRange	214 - IPAddress Range
IPAddressRangeCollection	215 - IPAddress Range Collection
ExternalDocument	216 - External Document
ExternalDocumentCollection	217 - External Document Collection
ADSyncAdmins	218 - AD Sync - Admins
ADSyncGroups	219 - AD Sync - Groups
FileCopyRelationship	220 - File Copy Relationship
FileCopyRelationshipCollection	221 - File Copy Relationship Collection
FileCopyRelationshipMatch	222 - File Copy Relationship Match
FileCopyRelationshipMatchCollection	223 - File Copy Relationship Match Collection
FileCopyRelationshipMapping	224 - File Copy Relationship Mapping
FileCopyRelationshipMappingCollection	225 - File Copy Relationship Mapping Collection
AnonFormData	226 - Anonymous Form Data
AnonFormDataCollection	227 - Anonymous Form Data Collection
DataType	256 - DataType
DataTypeCollection	257 - DataTypeCollection
DocumentGroup	258 - Document Group
DocumentGroupCollection	259 - Document Group Collection
FormCategory	268 - Form Category
FormCategoryCollection	269 - Form Category Collection
DocumentText	270 - Document Text
DocumentTextCollection	271 - Document Text Collection
TOS	272 - Terms Of Service
TOSCollection	273 - Terms Of Service Collection
Branding	274 - Branding
BrandingCollection	275 - Branding Collection
BIDataSource	276 - Business Intelligence Data Source
BIDataSourceCollection	277 - Business Intelligence Data Source Collection
FeatureFlag	278 - Feature Flag
FeatureFlagCollection	279 - FeatureFlag Collection
LeftNavIcon	280 - Left Nav Icon
LeftNavIconCollection	281 - Left Nav Icon Collection
Device	282 - Device
DeviceCollection	283 - Device Collection
FileFieldValueBase	284 - FileFieldValueBase
FileFieldValueCollection	285 - FileFieldValue Collection
FileFieldString	286 - FileFieldString
FileFieldDate	287 - FileFieldString
FileFieldDecimal	288 - FileFieldString
FileFieldInteger	289 - FileFieldString
AnyFileBoundObject	-6 - Any FileBound Object (for internal use only)
AnyBaseCollection_Or_Business	-5 - Any Base Collection or Business (for internal use only)
AnyBase_Or_Business	-4 - Any Base or Business (for internal use only)
AnyBaseCollection	-3 - Any Base Collection (for internal use only)
AnyBase	-2 - Any Base (for internal use only)
Any	-1 - Any (for internal use only)

ProjectSelection

None	0 - None
All	1 - All Projects
Selected	2 - Selected Projects

RenditionAction

AllPages	0 - All Pages
FirstPageOnly	1 - First Page Only
Custom	2 - Custom

RenditionPerformed

NoRenditions	0 - No Renditions
OnUpload	1 - On Upload
DataAccessed	2 - When Data Accessed
ScheduledJob	3 - During Scheduled Job
MainSettings	4 - Take Server Settings

ReportLevel

LevelAll	0 - All
LevelGlobal	1 - Global
LevelProject	2 - Project
LevelCustom	3 - Custom

ReportParmType

Unknown	0 - Unknown
Text	1 - Text
Number	2 - Number
DateField	3 - Date Field
OptionList	6 - Option List
CheckBox	10 - Checkbox (Boolean)
UserList	101 - User List
ProjectList	102 - Project List
FieldList	103 - Field List
RouteList	104 - Route List
ReasonList	105 - Reason List
ProjectListFieldSelection	106 - Project List For Field Selection
ObjectCheckBoxList	107 - Projects Checkbox List
GroupListUserSelection	108 - Groups List for User Selection
EntityTypeList	109 - Entity Type List
ActivityTypeList	110 - Activity Type List
ProjectListRouteSelection	111 - Route List
RouteStepList	112 - Route Step List
PolicyList	113 - Policy List
Attributes	114 - Policy Attributes
RadioOption	115 - Radio Option
SeparatorList	116 - Separator List
DividerList	117 - Divider List

ReportStandard

Miscellaneous	0 - Miscellaneous or Custom Report
System_UserLoginReport	1 - User Login Report
System_UserRightsReport	2 - User Rights Report
System_FailedLoginReport	3 - Failed Login Report
System_SystemUsageReport	4 - System Usage Report
System_SystemChangeLogReport	5 - System Change Log Report
System_OutdatedArchivesReport	6 - Outdated Archives Report
Project_ActivityReport	100 - Activity Report
Project_FileInventoryReport	101 - File Inventory Report
Project_FileCheckoutReport	102 - File Checkout Report
Project_FileActivityReport	103 - File Activity Report
Project_FileInactivityReport	104 - File Inactivity Report
Project_FileDestructionReport	105 - File Destruction Report
Project_FileDeficiencyReport	106 - File Deficiency Report
Project_FileAuditManagerReport	107 - File Audit Manager Report
Project_FilePendingRequestsReport	108 - File Pending Requests Report
Project_FileEntryReport	109 - File Entry Report
Project_DocumentCountReport	110 - Document Count Report
Project_DocumentActivityReport	111 - Document Activity Report
Project_DocumentInactivityReport	112 - Document Inactivity Report
Project_WorkflowStatusReport	113 - Workflow Status Report
Project_FileDocumentDeletionReport	114 - File/Document Deletion Report
Project_DocumentLockReport	115 - Document Lock Report
Static_CustomReport	116 - Custom Static Report
Project_RecordHistoryReport	117 - Record History Report

RouteDirection

EitherDirection	0 - Either Direction
ForwardOnly	1 - Forward Only (Completion)
BackwardOnly	2 - Backward Only (Rejection)

RoutedItemDirection

Backward	0 - Backward
Forward	1 - Forward
Reassign	2 - Reassign
SelfAssign	3 - SelfAssign
ReturnToAll	4 - ReturnToAll
Unknown	-999 - Unknown (for internal use only)

RoutedItemStatus

Inactive	0 - Inactive
Active	1 - Active
Unknown	-999 - Unknown (for internal use only)
WaitingOnChildRoute	-1 - Waiting on Child Route (for internal use only)

RouteStepStatusFlag

None	0 - None
Red	1 - Red
Blue	2 - Blue
Green	3 - Green
Yellow	4 - Yellow
LightBlue	5 - Light Blue
Purple	6 - Purple
Brown	7 - Brown
Magenta	8 - Magenta
Black	9 - Black
PulseRed	10 - Pulse Red
PulseBlue	11 - Pulse Blue
PulseGreen	12 - Pulse Green
PulseYellow	13 - Pulse Yellow
PulseLightBlue	14 - Pulse Light Blue
PulsePurple	15 - Pulse Purple
PulseBrown	16 - Pulse Brown
PulseMagenta	17 - Pulse Magenta
Orange	18 - Orange
PulseOrange	19 - Pulse Orange

RouteStepTaskButtonAction

None	0 - None
Print	1 - Print
NewRoute	3 - New Route
PlugIn	4 - Plug-In
ShowChecklist	5 - Show Checklist
ReassignToUser	6 - Reassign To Different User
AssignToMe	7 - Assign to Me
ReturnToAll	8 - Return to All

RouteStepTaskWorkflowAction

None	0 - None
Complete	1 - Complete
Reject	2 - Reject
Cancel	3 - Cancel
Move	4 - Move
MoveWithList	5 - Move With List
MoveWithListMulti	6 - Move With Multiple List

RouteStepType

Standard	0 - Standard
MultiAll	1 - Multiple (All)
MultiLoad	2 - Multiple (Load)
MultiQueue	3 - Multiple (Queue)
MultiVote	4 - Multiple (Vote)
EndStep	5 - End Step
Anonymous	6 - Anonymous

RouteType

Regular	0 - Regular
AdHoc	1 - Ad-hoc
Unknown	2 - Unknown
Process	3 - Process
PublishedProcess	4 - Published Process
GlobalSearch	5 - Global Search
Renditions	6 - Renditions
AutoIndex	7 - Auto-Index
ExchangeImport	8 - Exchange Import
FolderImport	9 - Folder Import
SocialMedia	10 - Social Media
ActiveDirectory	11 - Active Directory
AutoOCR	12 - Auto-OCR
SiteOCR	13 - Site-OCR
RecycleBinCleaner	14 - Recycle Bin Cleaner
AutoReport	15 - Auto Report
ScheduledWorkflow	16 - Scheduled Workflow
RecordsDeclaration	17 - Records Declaration
RecordsDestruction	18 - Records Destruction
WorkflowSummaryEmails	19 - Workflow Summary Emails
AllRoutable	-999 - All Routable (for internal use only)
AllAutomation	-998 - All Automation (for internal use only)

RouteWaitState

DontWait	0 - Don't Wait
Wait	1 - Wait
Pending	2 - Pending

SearchPortalFieldStatus

Deleted	0 - Deleted
Active	1 - Active
Unknown	-999 - Unknown (for internal use only)

ServerOCRType

NoServerOCR	0 - No Server OCR
ServerOCR	1 - Server OCR
ServerOCRWords	2 - Server OCR with Word Highlighting on Page
MainSettings	3 - Take Server Settings

SortDirection

Ascending	0 - Ascending
Descending	1 - Descending

SortOrder

Ascending	0 - Ascending
Descending	1 - Descending

TriState

False	0 - False
True	1 - True
DontCare	-999 - Don't care (for internal use only)

ViewerContextType

None	0 - None
Viewer	1 - Viewer
AdminViewer	2 - Admin Viewer
ScanViewer	3 - Scan Viewer
ReportViewer	4 - Report Viewer
Portal	5 - Portal
CustomViewer	999 - Custom Viewer
Unknown	-999 - Unknown (for internal use only)

Help

FAQ / Troubleshooting Guide

404 - when searching by a value that contains a space

When searching by a value that contains a space, for example searching for a project named 'Project ABC', you may receive a 404 if you manually URL-encode the spaces to send Project%20ABC. To resolve this, remove the manual URL-encoding and send the request with spaces.

404 - '[Project/File/Document/etc] viewing is not permitted due to user security. Contact your administrator to permit viewing this document.

If you receive this error, double check that the user you're authenticating with (the user you logged in with for the authentication GUID) has access to the particular project/file/document. For documents and files, the user will need access to the parent project as well.

Filtering Values that contain a comma.

If the value you are attempting to filter on contains a comma, you must include an escape character or the filter will be truncated after the comma. To prevent this, use a "\" character in the filter. For example, if you are filtering for "Red, White, and Blue"; use "Red\, White\, and Blue".