Capture API
Home Capture API
Capture related API functions
LicenseAllocations
There are 3 license types: Administration, Designer and Validation. Licenses of each type may be allocated to “S9Indivduals”, AD groups and “ADIndividuals” who are AD users not belonging to any AD group with an available license. The total allocation for each license type cannot exceed the licensed quantity.
GetLicenseAllocations: Get array of license allocations
GetLicenseAllocation: Get a single license allocation
PostLicenseAllocation: Create a new license allocation
PutLicenseAllocation: Update the name, count and/or priority of a license allocation
DeleteLicenseAllocation: Delete a license allocation
Licenses
A set of licenses each allocated from a single group. Expired licenses will be purged according to the value of the “RetentionTime” setting.
GetLicenses: Get array of licenses
GetLicense: Get a single license
PostLicense: Create a new license
PutLicense: Update the expiration date and time of a license
DeleteLicense: Delete a license
Fields
Calls for the management of the capture field catalog. Use the API’s in this section to automate the creation and / or management of fields between applications.
Get Fields: Retrieve the field catalog
Get Field: Retrieve a field from the catalog
Create Field: Create a new field
Update Field: Update the properties of a field
Get Table Fields: Get a list of table fields
Create Table Field: Create a new table field
Get Table Field: Get specific table field
Update Table Field: Update specific table field
Delete Table Field: Delete a table field
Get Lists: Get a list of lists
Create List: Create a new list
Update List: Update the properties of a list
Workflows
Calls for the management of workflows.
Get Engines: Get capture engines
Get Workflows: Get all workflows
Get Portal Workflows: Get list of workflows by portal
Get Workflow: Get specific workflow
Delete Workflow: Delete a workflow
Get Workflow Node: Get a workflow node
Processes
Calls for the management of Batch Manager processes
Get Batch Portals: Get all batch portals
Get Validation Count: Get processes awaiting validation
Create New Process: Creates a new process.
Update Process: Update a process
Delete Process: Delete a process
Upload
Uploading files to Capture API
API Call:
GET /Square9CaptureAPI/admin/allocations
Description
GroupNames "ADIndividuals" and "S9Individuals" have special meaning
Returns
[ { "$type": "System.Data.Entity.DynamicProxies.LicenseAllocation_60742559A8FDAB761073C6AEAAF175DA5C9000B0D3B62EE681CA0C31CDCD8948, EntityFrameworkDynamicProxies-Square9.CaptureAPI", "Licenses": [], "AllocationID": "5c611719-2e19-4eaa-96e8-10eee6b2595a", "LicenseType": "LAN", "GroupName": "S9Individuals", "IsSquare9": 1, "Count": 3, "Priority": 1 }, { "$type": "System.Data.Entity.DynamicProxies.LicenseAllocation_60742559A8FDAB761073C6AEAAF175DA5C9000B0D3B62EE681CA0C31CDCD8948, EntityFrameworkDynamicProxies-Square9.CaptureAPI", "Licenses": [ { "$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI", "LicenseID": "ae8db455-9629-4f75-8541-2cbb71690419", "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "UserName": "ADUser4", "IsSquare9": 0, "Expiration": "2015-10-29T10:12:45.547", "LicenseType": "LAN", "IPAddress": "::1" } ], "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "LicenseType": "LAN", "GroupName": "SSAdmin", "IsSquare9": 0, "Count": 2, "Priority": 1 }, { "$type": "System.Data.Entity.DynamicProxies.LicenseAllocation_60742559A8FDAB761073C6AEAAF175DA5C9000B0D3B62EE681CA0C31CDCD8948, EntityFrameworkDynamicProxies-Square9.CaptureAPI", "Licenses": [], "AllocationID": "30f022d4-e91d-405f-9a6b-71b98a02179b", "LicenseType": "LAN", "GroupName": "Administrators", "IsSquare9": 0, "Count": 10, "Priority": 2 }, { "$type": "System.Data.Entity.DynamicProxies.LicenseAllocation_60742559A8FDAB761073C6AEAAF175DA5C9000B0D3B62EE681CA0C31CDCD8948, EntityFrameworkDynamicProxies-Square9.CaptureAPI", "Licenses": [], "AllocationID": "df86addd-4c70-4614-a280-b45bdc56c1c4", "LicenseType": "LAN", "GroupName": "ADIndividuals", "IsSquare9": 0, "Count": 10, "Priority": 3 } ]
API Call:
GET /Square9CaptureAPI/allocation/{id}
Description
GroupNames "ADIndividuals" and "S9Individuals" have special meaning
Parameters:
id:
Id of allocation to be fetched
Returns
{ "$type": "System.Data.Entity.DynamicProxies.LicenseAllocation_60742559A8FDAB761073C6AEAAF175DA5C9000B0D3B62EE681CA0C31CDCD8948, EntityFrameworkDynamicProxies-Square9.CaptureAPI", "Licenses": [ { "$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI", "LicenseID": "ae8db455-9629-4f75-8541-2cbb71690419", "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "UserName": "ADUser4", "IsSquare9": 0, "Expiration": "2015-10-29T10:12:45.547", "LicenseType": "LAN", "IPAddress": "::1" } ], "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "LicenseType": "LAN", "GroupName": "SSAdmin", "IsSquare9": 0, "Count": 2, "Priority": 1 }
API Call:
POST /Square9CaptureAPI/allocation
Description
License type, group name, Square9ness, count and priority for allocation should be specified in the request body
Parameters:
[RAW]:
POST Request body should look like this:{
"$type": "Square9.CaptureAPI.Models.LicenseAllocation, Square9.CaptureAPI",
"LicenseType": "LAN",
"GroupName": "ADGroup4",
"IsSquare9": 0,
"Count": 1,
"Priority": 5
}
Returns
{ "$type": "Square9.CaptureAPI.Models.LicenseAllocation, Square9.CaptureAPI", "AllocationID": "bab5ac3f-40bc-429f-96f3-90e4dd8d982e", "LicenseType": "LAN", "GroupName": "ADGroup4", "IsSquare9": 0, "Count": 1, "Priority": 5, "Licenses": [] }
API Call:
PUT /Square9CaptureAPI/allocation/{id}
Description
Allocation id, license type, group name, Square9ness, count and priority should be specified in the request body
Parameters:
[RAW]:
PUT Request body should look like this:{
"$type": "Square9.CaptureAPI.Models.LicenseAllocation, Square9.CaptureAPI",
"AllocationID": "5c611719-2e19-4eaa-96e8-10eee6b2595a",
"LicenseType": "LAN",
"GroupName": "S9Individuals",
"IsSquare9": 1,
"Count": 10,
"Priority": 1
}
id:
Id of allocation to be updated
Returns
{ "$type": "Square9.CaptureAPI.Models.LicenseAllocation, Square9.CaptureAPI", "AllocationID": "5c611719-2e19-4eaa-96e8-10eee6b2595a", "LicenseType": "LAN", "GroupName": "S9Individuals", "IsSquare9": 1, "Count": 10, "Priority": 1 }
API Call:
DELETE /Square9CaptureAPI/allocation/{id}
Description
SQL Server will cascade the delete to any current licenses allocated from this group
Parameters:
id:
Id of allocation to be deleted
Returns
{ "$type": "System.Data.Entity.DynamicProxies.LicenseAllocation_60742559A8FDAB761073C6AEAAF175DA5C9000B0D3B62EE681CA0C31CDCD8948, EntityFrameworkDynamicProxies-Square9.CaptureAPI", "Licenses": [], "AllocationID": "bab5ac3f-40bc-429f-96f3-90e4dd8d982e", "LicenseType": "LAN", "GroupName": "ADGroup4", "IsSquare9": 0, "Count": 1, "Priority": 5 }
API Call:
GET /Square9CaptureAPI/admin/licenses
Description
Each license will contain id of allocation from which it was drawn
Returns
[ { "$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI", "LicenseID": "ae8db455-9629-4f75-8541-2cbb71690419", "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "UserName": "ADUser4", "IsSquare9": 0, "Expiration": "2015-10-29T10:12:45.547", "LicenseType": "LAN", "IPAddress": "::1" } ]
API Call:
GET /Square9CaptureAPI/license/{id}
Description
License will contain id of allocation from which it was drawn
Parameters:
id:
Id of license to be fetched
Returns
{ "$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI", "LicenseID": "ae8db455-9629-4f75-8541-2cbb71690419", "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "UserName": "ADUser4", "IsSquare9": 0, "Expiration": "2015-10-29T10:12:45.547", "LicenseType": "LAN", "IPAddress": "::1" }
API Call:
POST /Square9CaptureAPI/license
Description
User name, Square9ness and license type should be specified in the request body
Parameters:
[RAW]:
POST Request body should look like this:{
"$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI",
"UserName": "ADUser5",
"IsSquare9": 0,
"LicenseType": "LAN"
}
Returns
{ "$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI", "LicenseID": "a9c0e64e-2fa5-474f-98df-ee832d6db7b0", "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "UserName": "ADUser5", "IsSquare9": 0, "Expiration": "2015-10-29T12:09:14.5787836-04:00", "LicenseType": "LAN", "IPAddress": "::1" }
API Call:
PUT /Square9CaptureAPI/license/{id}
Description
License id, allocation id, user name, Square9ness and license type should be specified in the request body
Parameters:
[RAW]:
PUT Request body should look like this:{
"$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI",
"LicenseID": "ae8db455-9629-4f75-8541-2cbb71690419",
"AllocationID": "56F1C9B3-B0CF-4342-A241-663CBB7C7EA3",
"UserName": "ADUser4",
"IsSquare9": 0,
"LicenseType": "LAN"
}
id:
Id of license whose expiration date and time are to be updated
Returns
Nothing.
API Call:
DELETE /Square9CaptureAPI/license/{id}
Description
Will reduce count of licenses drawn from its group
Parameters:
id:
Id of license to be deleted
Returns
{ "$type": "Square9.CaptureAPI.Models.License, Square9.CaptureAPI", "LicenseID": "ae8db455-9629-4f75-8541-2cbb71690419", "AllocationID": "56f1c9b3-b0cf-4342-a241-663cbb7c7ea3", "UserName": "ADUser4", "IsSquare9": 0, "Expiration": "2015-10-29T12:27:44.203", "LicenseType": "LAN", "IPAddress": "::1" }
API Call:
DELETE /Square9CaptureApi/list/{id}
Description
Delete a list from within the GlobalCapture field catalog.
Parameters:
id:
List ID
Returns
Nothing.
API Call:
GET /Square9CaptureApi/fields/
Description
Retrieves a list of fields and their properties.
Returns
[ { "ID": 1, "Name": "Title", "Type": "Character", "Format": "", "Regex": "", "Length": 50, "Required": false, "MultiValue": false, "SystemField": "", "List": { "Type": null, "ListId": 0, "Primary": 0, "Secondary": 0, "Mapping": [] } }, { "ID": 2, "Name": "Number", "Type": "Numeric", "Format": "", "Regex": "", "Length": 50, "Required": false, "MultiValue": false, "SystemField": "", "List": { "Type": null, "ListId": 0, "Primary": 0, "Secondary": 0, "Mapping": [] } } ]
API Call:
GET /Square9CaptureApi/field/{id}
Description
Retrieve a specific field by {id} from the catalog and all of the field properties.
Parameters:
id:
Field ID
Returns
[ { "ID": 1, "Name": "Title", "Type": "Character", "Format": "", "Regex": "", "Length": 50, "Required": false, "MultiValue": false, "SystemField": "", "List": { "Type": null, "ListId": 0, "Primary": 0, "Secondary": 0, "Mapping": [] } } ]
API Call:
POST /Square9CaptureApi/field
Description
Creates a new field in the field catalog.
Parameters:
[RAW]:
POST Request body expects a field creation object matching the following schema:{ "name": "Customer Name", "type": "Character", "format": "", "regex": "", "length": 50, "required": false, "multiValue": false, "systemField": "", "list": { "type": "dropdown", "listId": 4, "primary": 12, "secondary": null, "mapping": [ { "primaryValue": "New York", "secondaryValue": "", "listId": 5 }, { "primaryValue": "Connecticut", "secondaryValue": "", "listId": 6 } ] } }The following values are used as strings for various types. You may use any of these types as appropriate.Field Types (field.type): Character Numeric Date Decimal
Returns
Nothing.
API Call:
PUT /Square9CaptureApi/field/{id}
Description
Update the properties of a field specified by {id}.
Parameters:
[RAW]:
PUT Request body expects a field object matching the following schema: {
"id": 2,
"name": "Vendor ID",
"type": "Numeric",
"format": "#####_#####",
"regex": "",
"length": 10,
"required": false,
"multiValue": false,
"systemField": "readOnly",
"list": {
"type": "",
"listId": null,
"primary": null,
"secondary": null,
"mapping": []
}
}
id:
Field ID
Returns
Nothing.
API Call:
DELETE /Square9CaptureApi/field/{id}
Description
Delete a specific field by {id} from the field catalog.
Parameters:
id:
Field ID
Returns
Nothing.
API Call:
GET /Square9CaptureApi/tablefields/
Description
Retrieve a full list of table fields from GlobalCapture field catalog.
Returns
[ { "id": 1, "name": "Invoiced Items", "fields": [ 62, 5, 23 ] }, { "id": 2, "name": "Purchase Order Items", "fields": [ 2, 51, 23 ] } ]
API Call:
POST /Square9CaptureApi/tablefields/
Description
Create a new table field in the GlobalCapture field catalog.
Parameters:
[RAW]:
{
"name": "Invoiced Items",
"fields": [
62,
5,
23
]
}Returns
Nothing.
API Call:
GET /Square9CaptureApi/tablefield/{id}
Description
Retrieve a specific table field by {id} from GlobalCapture field catalog.
Returns
{ "name": "Invoiced Items", "fields": [ 62, 5, 23 ] }
API Call:
PUT /Square9CaptureApi/field/{id}
Description
Updates a specific table field by {id} in the GlobalCapture field catalog.
Parameters:
[RAW]:
{
"name": "Invoiced Items",
"fields": [
62,
5,
23,
56
]
}
Returns
Nothing.
API Call:
DELETE /Square9CaptureApi/field/{id}
Description
Delete a table field by {id} from the GlobalCapture field catalog.
Parameters:
id:
Table Field ID
Returns
Nothing.
API Call:
GET /Square9CaptureApi/lists
Description
Gets a list of lists and their values from the GlobalCapture field catalog.
Returns
[ { "ID": 1, "Name": "Invoice Approval Status", "AssemblyPath": "", "AssemblyParameters": "", "Values": [ "Approved", "Declined", "New", "On Hold", "Pending", "Escalate" ] }, { "ID": 2, "Name": "Invoice Match Status", "AssemblyPath": "", "AssemblyParameters": "", "Values": [ "Unmatched", "Matched" ] } ]
API Call:
POST /Square9CaptureApi/lists
Description
Create a new list in the GlobalCapture field catalog.
Parameters:
[RAW]:
{
"Name": "Invoice Approval Status",
"AssemblyPath": "",
"AssemblyParameters": "",
"Values": [
"Approved",
"Declined",
"Escalate",
"New",
"On Hold",
"Pending"
]
}Returns
Nothing.
API Call:
PUT /Square9CaptureApi/list/{id}
Description
Update the properties of a list within the GlobalCapture field catalog.
Parameters:
[RAW]:
{
"Name": "Invoice Approval Status",
"AssemblyPath": "",
"AssemblyParameters": "",
"Values": [
"Approved",
"Declined",
"Escalate",
"New",
"On Hold",
"Pending"
]
}Returns
Nothing.
API Call:
GET /Square9CaptureApi/engines
Description
Returns a list of GlobalCapture engines.
Returns
[ { "ID": "5772280c83d87307b0fd39c2", "Path": "c:\\getsmart\\captureservices\\globalcapture_1\\square9.globalcapture.exe", "ServiceName": "GlobalCapture", "UID": "278826159", "HashedUID": "99E3BA48B9D6E6D", "PortalID": 11 } ]
API Call:
GET /Square9CaptureAPI/portals/workflows
Description
Returns a list of all saved workflows from all portals.
Returns
[ { "Name": "Import 1", "Description": "", "SVG": "svg", "SaveDate": "2016-06-28T11:56:03.497Z", "Published": true, "Type": 0, "Engines": [ "5772280c83d87307b0fd39c2" ], "ID": "5772379a83d87306dcc9f464" }, { "Name": "Import 2", "Description": "", "SVG": "svg", "SaveDate": "2016-07-05T14:52:41.006Z", "Published": true, "Type": 0, "Engines": [ "5772280c83d87307b0fd39c2" ], "ID": "577bc9b98416623c34ffb3a2" } ]
API Call:
GET /Square9CaptureAPI/portal/{portalID}/workflows
Description
Returns a list of workflows by {portalID}.
Parameters:
portalID:
Portal ID
Returns
[ { "Name": "Import 2", "Description": "", "SVG": "svg", "SaveDate": "2016-06-27T19:41:27.366Z", "Published": true, "Type": 0, "Engines": [ "573a1e9a8416622cac0e7e8b" ], "ID": "5771812584166233408ca5f4" } ]
API Call:
GET /Square9CaptureAPI/portal/{portalID}/workflow/{workflowID}
Description
Return a specific workflow by {portalID} and {workflowID}.
Parameters:
portalID:
Portal ID
workflowID:
Workflow ID
Returns
{ "Name": "Import 2", "Description": "", "SVG": "svg", "SaveDate": "2016-06-27T19:41:27.366Z", "Published": true, "Type": 0, "Engines": [ "573a1e9a8416622cac0e7e8b" ], "ID": "5771812584166233408ca5f4" }
API Call:
POST /Square9CaptureAPI/portal/{portalID}/workflow
Description
Create workflow for specific {portalID}
Parameters:
[RAW]:
Workflow
{
"Name": "Import 2",
"Description": "",
"SVG": "svg",
"SaveDate": "2016-06-27T19:41:27.366Z",
"Published": true,
"Type": 0,
"Engines": [
"573a1e9a8416622cac0e7e8b"
],
"ID": "5771812584166233408ca5f4"
}
Returns
Nothing.
API Call:
DELETE http://localhost/Square9CaptureAPI/portal/11/workflows?portalID={}&workflowID={}
Description
Delete a specific workflow by {portalID} and {workflowID}
Parameters:
portalID:
Portal ID
workflowID Optional:
Workflow ID
Returns
Nothing.
API Call:
GET /Square9CaptureAPI/portal/{portalID}/workflow/{workflowID}/node/{nodeId}?portalId={}&workflowId={}
Description
Get a specific node within a workflow by {nodeId}
Parameters:
nodeId:
Node ID
portalId:
Portal ID
workflowId:
Workflow ID
Returns
{ "_t": "FileInputInitiator", "Key": "-8", "Edges": [ { "TargetNode": "-1", "TargetNodeType": "10", "Points": "[-248.58860767902857,318.8382120200607,-214.86286922634287,320.9460706733536,-181.13713077365713,323.0539293266464,-147.41139232097143,325.1617879799393]" } ], "Title": "import", "Description": "", "Category": "18", "Group": null, "Loc": "-294 316", "Text": "Import", "Frequency": 1, "ThumbnailGeneration": true, "ConvertWordToPDF": true, "ConvertExcelToPDF": true, "ConvertPowerPointToPDF": true, "ConvertEmailToPDF": true, "SourcePath": "C:\\Users\\user\\Desktop\\Import3", "DelimiterString": "", "DelimitedProperties": [], "SingleBatch": false, "IdleWait": false }
API Call:
GET http://localhost/Square9CaptureAPI/batchportals
Description
Retrieves a list of all batch portals.
Returns
[ { "BatchUsers": [], "Id": 11, "Name": "Batch Station Zero", "User": null, "Pass": null, "Type": 0, "Status": null, "URL": "https://localhost:44377/" }, { "BatchUsers": [], "Id": 14, "Name": "HR Data", "User": null, "Pass": null, "Type": 1, "Status": null, "URL": "https://localhost:44377/" }, { "BatchUsers": [], "Id": 17, "Name": "SmartSearch", "User": null, "Pass": null, "Type": 2, "Status": null, "URL": "http://localhost/gsportal" } ]
API Call:
GET /Square9CaptureAPI/batches/validationcount
Description
Retrieves the number of processes awaiting validation.
Returns
Nothing.
API Call:
GET /Square9CaptureAPI/batches?portalid={}&page={}&count={}&types={1|2|3|4|5|6|7}&workflow={}&batchid={}&from={}&until={}&batchType={1|2|3|4|5|6|7}&isProp={true}&PID={n/a}&DBID={}&FieldID={}&ConditionalType={}&FieldType={}&Value={}
Description
Returns a list of all batches in batch manager.
Parameters:
batchType:
Batch Type Capture Workflow = 1 Global Action = 2 Global Capture = 4
count:
Results per page
page:
Active Page
portalid:
Portal ID
types:
Batch Status
batchid Optional:
Process ID
ConditionalType Optional:
Property search parameter indicating the type of conditional operator that the search will be based on. Equals = 1 Contains = 2 Not Equals = 3 Exists = 6
DBID Optional:
Property search parameter indicating the Database ID for the field the property search is based on. If the field is a GlobalCapture field, this parameter must be set to 0.
FieldID Optional:
Property search parameter indicating the field ID for the field the property search is based on.
FieldType Optional:
Property search parameter indicating the type of field the property search is based on. Character = 1 Numeric = 2 Date = 3 Decimal = 4
from Optional:
From Date
isProp Optional:
Indicates that the batch query should be based on a property search. In order for the property search query to complete successfully, this parameter must be set to true, and the URL must include the following supplemental parameters: PID DBID FieldID ConditionalType FieldType Value
PID Optional:
Property search parameter indicating the portal ID for the field the property search is based on. If the field is a GlobalCapture field, this parameter must be set to 0.
until Optional:
Until Date
Value Optional:
Property search parameter holding the value of the property that the search will be based on.
workflow Optional:
Workflow Name
Returns
Nothing.
API Call:
POST /Square9CaptureAPI/portal/{portalID}/process
Description
Create a new process in the specified Portal by {id}
Parameters:
[RAW]:
{
"ID":1,
"WorkflowID":"5a020fa4233e2260d013bfa0",
"WorkflowName":"Workflow",
"EngineID":null,
"FilePages":[
],
"PortalID":1,
"Permissions":0,
"ProcessActions":null,
"SSDocument":null,
"LastAccessed":"2018-03-26T10:19:00.8717506-04:00",
"FirstAccessed":"2018-03-26T10:19:00.066646-04:00",
"Status":5,
"CurrentNode":"-8",
"Wait":0,
"WaitStart":"0001-01-01T00:00:00",
"Queue":null,
"Properties":[
{
"ID":0,
"Name":"BatchID",
"Type":1,
"SystemProperty":false,
"Value":"13765180-cbc5-4a66-8fc1-59d4dfdeb0a5",
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":0,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-1,
"Name":"FilePath",
"Type":1,
"SystemProperty":false,
"Value":"C:\\file.pdf",
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-1,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-2,
"Name":"ActiveTemplate",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-2,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-3,
"Name":"ValidationUser",
"Type":1,
"SystemProperty":false,
"Value":"MachineName\\User",
"MValue":null,
"Confidence":100,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-3,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-4,
"Name":"OriginalFileName",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-4,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-5,
"Name":"ScanUser",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-5,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-6,
"Name":"ReleasedFilePath",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-6,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-7,
"Name":"SubmissionID",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-7,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-8,
"Name":"Modified",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-8,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":-9,
"Name":"FormID",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":2,
"PortalID":0,
"DBID":0,
"FieldID":-9,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
},
{
"ID":1,
"Name":"Character",
"Type":1,
"SystemProperty":false,
"Value":null,
"MValue":null,
"Confidence":0,
"SourceType":0,
"PortalID":0,
"DBID":0,
"FieldID":1017,
"TableFields":null,
"Left":0,
"Top":0,
"Right":0,
"Bottom":0,
"Page":0,
"TemplateProperty":false
}
],
"TargetFile":null,
"PageCount":0,
"FeatureToken":null,
"ParentID":0,
"ThreadToken":null,
"PendingAction":null,
"ProcessType":2,
"LastActionUser":"MachineName\\User",
"History":[
],
"SecuredNotationUsers":null,
"EncyptedFields":null
}
Returns
{ "ID": 1, "WorkflowID": "5a020fa4233e2260d013bfa0", "WorkflowName": "Workflow", "EngineID": null, "FilePages": [], "PortalID": 1, "Permissions": 0, "ProcessActions": null, "SSDocument": null, "LastAccessed": "2018-03-26T10:19:00.8717506-04:00", "FirstAccessed": "2018-03-26T10:19:00.066646-04:00", "Status": 5, "CurrentNode": "-8", "Wait": 0, "WaitStart": "0001-01-01T00:00:00", "Queue": null, "Properties": [ { "ID": 0, "Name": "BatchID", "Type": 1, "SystemProperty": false, "Value": "13765180-cbc5-4a66-8fc1-59d4dfdeb0a5", "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": 0, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -1, "Name": "FilePath", "Type": 1, "SystemProperty": false, "Value": "C:\\file.pdf", "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -1, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -2, "Name": "ActiveTemplate", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -2, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -3, "Name": "ValidationUser", "Type": 1, "SystemProperty": false, "Value": "MachineName\\User", "MValue": null, "Confidence": 100, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -3, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -4, "Name": "OriginalFileName", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -4, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -5, "Name": "ScanUser", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -5, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -6, "Name": "ReleasedFilePath", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -6, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -7, "Name": "SubmissionID", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -7, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -8, "Name": "Modified", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -8, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": -9, "Name": "FormID", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": -9, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false }, { "ID": 1, "Name": "Character", "Type": 1, "SystemProperty": false, "Value": null, "MValue": null, "Confidence": 0, "SourceType": 0, "PortalID": 0, "DBID": 0, "FieldID": 1017, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0, "TemplateProperty": false } ], "TargetFile": null, "PageCount": 0, "FeatureToken": null, "ParentID": 0, "ThreadToken": null, "PendingAction": null, "ProcessType": 2, "LastActionUser": "MachineName\\User", "History": [], "SecuredNotationUsers": null, "EncyptedFields": null }
API Call:
PUT /Square9CaptureAPI/portal/{portalID}/process/{processID}
Description
Update a specific process in the Batch Manager
Parameters:
[RAW]:
{
"ID": 10,
"WorkflowID": "5771812e84166233408ca5f5",
"WorkflowName": "Import 3",
"FilePages": [
{
"Index": 1,
"Path": "C:\\GetSmart\\CaptureProcessing\\13d62bf8-757b-4bfd-b8ca-7e98f6b2deea\\test.pdf",
"Thumbnail": null,
"OCRData": null
}
],
"SSDocument": {
"SSDBID": 0,
"SSArchiveID": 0,
"SSDocumentID": 0
},
"LastAccessed": "2016-06-27T19:41:39.341Z",
"FirstAccessed": "2016-06-27T19:41:39.341Z",
"Status": 3,
"CurrentNode": "-8",
"Wait": 0,
"WaitStart": "0001-01-01T00:00:00Z",
"Queue": null,
"Properties": [
{
"ID": 0,
"Name": "BatchID",
"Type": 1,
"SystemProperty": false,
"Value": "6b8b1699-4dcd-47c7-b228-3ab8b668eb24",
"MValue": null,
"Confidence": 0,
"SourceType": 2,
"PortalID": 0,
"DBID": 0,
"FieldID": 0,
"TableFields": null,
"Left": 0,
"Top": 0,
"Right": 0,
"Bottom": 0,
"Page": 0
}
],
"TargetFile": null,
"PageCount": 1,
"FeatureToken": null,
"ParentID": 0,
"ThreadToken": null,
"PendingAction": null,
"ProcessType": 2,
"LastActionUser": "",
"History": [
{
"Node": "import",
"NodeCategory": "18",
"Message": "Document Picked Up by Import File: C:\\Users\\user\\Desktop\\Import3",
"ProcessID": 0,
"Timestamp": "2016-06-27T19:41:39.341Z",
"CurrentQueue": null,
"CurrentStatus": 5,
"LastActionUser": null,
"TimeSpent": 0
}
]
}Returns
Nothing.
API Call:
GET /Square9CaptureAPI/portal/{portalID}/process/{processId}?portalId={}
Description
Get a specific process by {processId} from the Batch Manager
Parameters:
portalId:
Portal ID
processId:
Process ID
Returns
{ "ID": 10, "WorkflowID": "5771812e84166233408ca5f5", "WorkflowName": "Import 3", "FilePages": [ { "Index": 1, "Path": "C:\\GetSmart\\CaptureProcessing\\13d62bf8-757b-4bfd-b8ca-7e98f6b2deea\\test.pdf", "Thumbnail": null, "OCRData": null } ], "SSDocument": { "SSDBID": 0, "SSArchiveID": 0, "SSDocumentID": 0 }, "LastAccessed": "2016-06-27T19:41:39.341Z", "FirstAccessed": "2016-06-27T19:41:39.341Z", "Status": 3, "CurrentNode": "-8", "Wait": 0, "WaitStart": "0001-01-01T00:00:00Z", "Queue": null, "Properties": [ { "ID": 0, "Name": "BatchID", "Type": 1, "SystemProperty": false, "Value": "6b8b1699-4dcd-47c7-b228-3ab8b668eb24", "MValue": null, "Confidence": 0, "SourceType": 2, "PortalID": 0, "DBID": 0, "FieldID": 0, "TableFields": null, "Left": 0, "Top": 0, "Right": 0, "Bottom": 0, "Page": 0 } ], "TargetFile": null, "PageCount": 1, "FeatureToken": null, "ParentID": 0, "ThreadToken": null, "PendingAction": null, "ProcessType": 2, "LastActionUser": "", "History": [ { "Node": "import", "NodeCategory": "18", "Message": "Document Picked Up by Import File: C:\\Users\\user\\Desktop\\Import3", "ProcessID": 0, "Timestamp": "2016-06-27T19:41:39.341Z", "CurrentQueue": null, "CurrentStatus": 5, "LastActionUser": null, "TimeSpent": 0 } ] }
API Call:
DELETE /Square9CaptureAPI/portal/{portalID}/process/{processId}?portalId={}
Description
Delete a specific process by {processId}
Parameters:
portalId:
Portal ID
processId:
Process ID
Returns
Nothing.
API Call:
POST /Square9CaptureApi/files
Description
Post multiple files to the Capture API cache directory using multipart form-data. Filenames will be generated using GUIDs.
Returns
[ "C:\\SmartSearch\\ViewerCache\\bf61ae87-436e-41ab-919f-8aaaf758ca74.pdf", "C:\\SmartSearch\\ViewerCache\\c315b91f-2afa-4851-b800-9ada78b7ca16.pdf" ]
API Call:
POST /Square9CaptureApi/file
Description
Post a file to the Capture API cache using multipart form-data. A new filename will be generated using a GUID.
Returns
[ "C:\\SmartSearch\\ViewerCache\\0310923b-e7cd-4e59-a551-3b792b98979e.pdf" ]
Subscribe to get the most recent news, best practices, product updates, and our take on emerging tech
Subscribe for the latest from Square 9
Related Reads
The Next Generation of IIM: Working Efficiently Your Way with GlobalSearch Go
3 min • By Samuel Young • Posted Nov 21
Safeguarding OCR Information: How Providers Can Protect Extracted Data for Maximum Security
3 min • By Samuel Young • Posted Nov 14
